1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: inidef.hxx,v $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
31 #ifndef _SFXINIDEF_HXX
32 #define _SFXINIDEF_HXX
39 class SfxIniDefaulterList
;
40 class SfxIniDefaultManager
;
43 #include <svtools/svarray.hxx>
45 class SfxIniDefaulter
;
46 SV_DECL_PTRARR( SfxIniDefaulterList
, SfxIniDefaulter
*, 0, 2 );
49 //========================================================================
55 Instanzen dieser Klasse k"onnen (f"ur die Laufzeit eines Moduls, z.B.
56 einer DLL-Nutzung oder einer Applikation) angelegt werden, um Defaults
57 f"ur eine Anzahl von ini-Eintr"agen zu liefern. Diese Defaults werden
58 erfragt, wenn ein <SfxIniManager> einen Eintrag nicht in den ini-Files
61 Defaults verschiedener <SfxIniDefaulter>-Instanzen d"urfen sich nicht
62 unterscheiden, da die Reihenfolge der Abarbeitung nicht definiert ist.
64 Die Instanzen brauchen nicht zerst"ort zu werden, au\ser wenn der
65 dazugeh"orige Code entladen wird (load-on-demand DLLs). Sonst geschieht
66 dies automatisch beim Zerst"oren des <SfxIniDefaultManager>.
70 SfxIniDefaultManager
* _pManager
;
73 SfxIniDefaulter( SfxIniDefaultManager
*pManager
);
76 virtual BOOL
QueryDefault( String
&aValue
,
77 const SfxIniEntry
&rEntry
) = 0;
80 //========================================================================
82 class SfxIniDefaultManager
86 Genau eine Instanz dieser Klasse mu\s in jeder Application-Subklasse,
87 die diesen Mechanismus nutzen m"ochte, in deren Ctor angelegt werden
88 und sollte in deren Dtor zerst"ort werden.
92 SfxIniDefaulterList
* _pList
;
95 SfxIniDefaultManager();
96 ~SfxIniDefaultManager();
99 void Insert( SfxIniDefaulter
*pDefaulter
)
100 { _pList
->C40_INSERT( SfxIniDefaulter
, pDefaulter
, _pList
->Count() ); }
101 void Remove( SfxIniDefaulter
*pDefaulter
)
102 { _pList
->Remove( _pList
->C40_GETPOS( SfxIniDefaulter
, pDefaulter
) ); }
103 BOOL
QueryDefault( String
&aValue
,
104 const SfxIniEntry
&rEntry
);
108 //========================================================================
114 Instanzen dieser Klasse beschreiben einen Eintrag eines Ini-Files,
115 um mit der Klasse <SfxIniDefaulter> erfragt werden zu k"onnen, falls
116 der <SfxIniManager> einen Eintrag nicht in den Ini-Files auffindet.
120 friend class SfxIniManager
;
122 const String
& _aGroup
;
129 SfxIniEntry( const String
& aGroup
,
134 SfxIniEntry( const SfxIniEntry
& ); // n.i.
135 SfxIniEntry
& operator=( const SfxIniEntry
& ); // n.i.
138 const String
& GetGroupName() const { return _aGroup
; }
139 SfxIniGroup
GetGroup() const { return _eGroup
; }
140 const String
& GetKeyName() const { return _aKey
; }
141 SfxIniKey
GetKey() const { return _eKey
; }
142 USHORT
GetIndex() const { return _nIndex
; }