binfilter/inc/bf_svtools/inidef.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: inidef.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SFXINIDEF_HXX
  32 #define _SFXINIDEF_HXX
  33
  34 #ifndef _INIMGR_HXX
  35 #include <iniman.hxx>
  36 #endif
  37
  38 namespace binfilter
  39 {
  40
  41 class SfxIniEntry;
  42 class SfxIniDefaulterList;
  43 class SfxIniDefaultManager;
  44 }
  45
  46 #if _SOLAR__PRIVATE
  47 #include <bf_svtools/svarray.hxx>
  48
  49 namespace binfilter
  50 {
  51 class SfxIniDefaulter;
  52 SV_DECL_PTRARR( SfxIniDefaulterList, SfxIniDefaulter*, 0, 2 );
  53 }
  54 #endif
  55
  56 namespace binfilter
  57 {
  58
  59 //========================================================================
  60
  61 class SfxIniDefaulter
  62
  63 /*      [Beschreibung]
  64
  65     Instanzen dieser Klasse k"onnen (f"ur die Laufzeit eines Moduls, z.B.
  66     einer DLL-Nutzung oder einer Applikation) angelegt werden, um Defaults
  67     f"ur eine Anzahl von ini-Eintr"agen zu liefern. Diese Defaults werden
  68     erfragt, wenn ein <SfxIniManager> einen Eintrag nicht in den ini-Files
  69     finden kann.
  70
  71     Defaults verschiedener <SfxIniDefaulter>-Instanzen d"urfen sich nicht
  72     unterscheiden, da die Reihenfolge der Abarbeitung nicht definiert ist.
  73
  74     Die Instanzen brauchen nicht zerst"ort zu werden, au\ser wenn der
  75     dazugeh"orige Code entladen wird (load-on-demand DLLs). Sonst geschieht
  76     dies automatisch beim Zerst"oren des <SfxIniDefaultManager>.
  77 */
  78
  79 {
  80     SfxIniDefaultManager*       _pManager;
  81
  82 public:
  83                             SfxIniDefaulter( SfxIniDefaultManager *pManager );
  84                             ~SfxIniDefaulter();
  85
  86     virtual BOOL                        QueryDefault( String &aValue,
  87                                           const SfxIniEntry &rEntry ) = 0;
  88 };
  89
  90 //========================================================================
  91
  92 class SfxIniDefaultManager
  93
  94 /*      [Beschreibung]
  95
  96     Genau eine Instanz dieser Klasse mu\s in jeder Application-Subklasse,
  97     die diesen Mechanismus nutzen m"ochte, in deren Ctor angelegt werden
  98     und sollte in deren Dtor zerst"ort werden.
  99 */
 100
 101 {
 102     SfxIniDefaulterList*        _pList;
 103
 104 public:
 105                             SfxIniDefaultManager();
 106                             ~SfxIniDefaultManager();
 107
 108 #if _SOLAR__PRIVATE
 109     void                                        Insert( SfxIniDefaulter *pDefaulter )
 110                             { _pList->C40_INSERT( SfxIniDefaulter, pDefaulter, _pList->Count() ); }
 111     void                                        Remove( SfxIniDefaulter *pDefaulter )
 112                             { _pList->Remove( _pList->C40_GETPOS( SfxIniDefaulter, pDefaulter ) ); }
 113     BOOL                                        QueryDefault( String &aValue,
 114                                           const SfxIniEntry &rEntry );
 115 #endif
 116 };
 117
 118 //========================================================================
 119
 120 class SfxIniEntry
 121
 122 /*      [Beschreibung]
 123
 124     Instanzen dieser Klasse beschreiben einen Eintrag eines Ini-Files,
 125     um mit der Klasse <SfxIniDefaulter> erfragt werden zu k"onnen, falls
 126     der <SfxIniManager> einen Eintrag nicht in den Ini-Files auffindet.
 127 */
 128
 129 {
 130 friend class SfxIniManager;
 131
 132     const String&               _aGroup;
 133     const String&                       _aKey;
 134     SfxIniGroup                         _eGroup;
 135     SfxIniKey                           _eKey;
 136     USHORT                                      _nIndex;
 137
 138 private:
 139                             SfxIniEntry( const String&  aGroup,
 140                                          const String&  aKey,
 141                                          SfxIniGroup    eGroup,
 142                                          SfxIniKey              eKey,
 143                                          USHORT                 nIndex );
 144                             SfxIniEntry( const SfxIniEntry & ); // n.i.
 145     SfxIniEntry&                        operator=( const SfxIniEntry & ); // n.i.
 146
 147 public:
 148     const String&                       GetGroupName() const { return _aGroup; }
 149     SfxIniGroup                         GetGroup() const { return _eGroup; }
 150     const String&                       GetKeyName() const { return _aKey; }
 151     SfxIniKey                           GetKey() const { return _eKey; }
 152     USHORT                                      GetIndex() const { return _nIndex; }
 153 };
 154
 155 }
 156
 157 #endif
 158