/*************************************************************************
 *
 *  $RCSfile: inidef.hxx,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: hr $ $Date: 2000-12-07 14:00:05 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef _SFXINIDEF_HXX
#define _SFXINIDEF_HXX

#ifndef _INIMGR_HXX
#include <iniman.hxx>
#endif

class SfxIniEntry;
class SfxIniDefaulterList;
class SfxIniDefaultManager;

#if _SOLAR__PRIVATE
#include "svarray.hxx"

class SfxIniDefaulter;
SV_DECL_PTRARR( SfxIniDefaulterList, SfxIniDefaulter*, 0, 2 );
#endif

//========================================================================

class SfxIniDefaulter

/*  [Beschreibung]

    Instanzen dieser Klasse k"onnen (f"ur die Laufzeit eines Moduls, z.B.
    einer DLL-Nutzung oder einer Applikation) angelegt werden, um Defaults
    f"ur eine Anzahl von ini-Eintr"agen zu liefern. Diese Defaults werden
    erfragt, wenn ein <SfxIniManager> einen Eintrag nicht in den ini-Files
    finden kann.

    Defaults verschiedener <SfxIniDefaulter>-Instanzen d"urfen sich nicht
    unterscheiden, da die Reihenfolge der Abarbeitung nicht definiert ist.

    Die Instanzen brauchen nicht zerst"ort zu werden, au\ser wenn der
    dazugeh"orige Code entladen wird (load-on-demand DLLs). Sonst geschieht
    dies automatisch beim Zerst"oren des <SfxIniDefaultManager>.
*/

{
    SfxIniDefaultManager*   _pManager;

public:
                            SfxIniDefaulter( SfxIniDefaultManager *pManager );
                            ~SfxIniDefaulter();

    virtual BOOL            QueryDefault( String &aValue,
                                          const SfxIniEntry &rEntry ) = 0;
};

//========================================================================

class SfxIniDefaultManager

/*  [Beschreibung]

    Genau eine Instanz dieser Klasse mu\s in jeder Application-Subklasse,
    die diesen Mechanismus nutzen m"ochte, in deren Ctor angelegt werden
    und sollte in deren Dtor zerst"ort werden.
*/

{
    SfxIniDefaulterList*    _pList;

public:
                            SfxIniDefaultManager();
                            ~SfxIniDefaultManager();

#if _SOLAR__PRIVATE
    void                    Insert( SfxIniDefaulter *pDefaulter )
                            { _pList->C40_INSERT( SfxIniDefaulter, pDefaulter, _pList->Count() ); }
    void                    Remove( SfxIniDefaulter *pDefaulter )
                            { _pList->Remove( _pList->C40_GETPOS( SfxIniDefaulter, pDefaulter ) ); }
    BOOL                    QueryDefault( String &aValue,
                                          const SfxIniEntry &rEntry );
#endif
};

//========================================================================

class SfxIniEntry

/*  [Beschreibung]

    Instanzen dieser Klasse beschreiben einen Eintrag eines Ini-Files,
    um mit der Klasse <SfxIniDefaulter> erfragt werden zu k"onnen, falls
    der <SfxIniManager> einen Eintrag nicht in den Ini-Files auffindet.
*/

{
friend class SfxIniManager;

    const String&           _aGroup;
    const String&           _aKey;
    SfxIniGroup             _eGroup;
    SfxIniKey               _eKey;
    USHORT                  _nIndex;

private:
                            SfxIniEntry( const String&  aGroup,
                                         const String&  aKey,
                                         SfxIniGroup    eGroup,
                                         SfxIniKey      eKey,
                                         USHORT         nIndex );
                            SfxIniEntry( const SfxIniEntry & ); // n.i.
    SfxIniEntry&            operator=( const SfxIniEntry & ); // n.i.

public:
    const String&           GetGroupName() const { return _aGroup; }
    SfxIniGroup             GetGroup() const { return _eGroup; }
    const String&           GetKeyName() const { return _aKey; }
    SfxIniKey               GetKey() const { return _eKey; }
    USHORT                  GetIndex() const { return _nIndex; }
};

#endif