Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXRegistry Class Reference

#include <FXRegistry.h>

Inheritance diagram for FX::FXRegistry:
FX::FXSettings FX::FXDict FX::FXObject

Public Member Functions

 FXRegistry (const FXString &akey=FXString::null, const FXString &vkey=FXString::null)
 
bool read ()
 
bool write ()
 
const FXStringgetAppKey () const
 
const FXStringgetVendorKey () const
 
void setAsciiMode (bool asciiMode)
 
bool getAsciiMode () const
 
- Public Member Functions inherited from FX::FXSettings
 FXSettings ()
 
 FXSettings (const FXSettings &orig)
 
FXSettingsoperator= (const FXSettings &orig)
 
bool parseFile (const FXString &filename, bool mark)
 
bool unparseFile (const FXString &filename)
 
FXStringDictdata (FXuint pos) const
 
FXStringDictfind (const FXchar *section) const
 
FXint readFormatEntry (const FXchar *section, const FXchar *key, const FXchar *fmt,...) FX_SCANF(4
 
FXint const FXcharreadStringEntry (const FXchar *section, const FXchar *key, const FXchar *def=NULL)
 
FXint readIntEntry (const FXchar *section, const FXchar *key, FXint def=0)
 
FXuint readUnsignedEntry (const FXchar *section, const FXchar *key, FXuint def=0)
 
FXdouble readRealEntry (const FXchar *section, const FXchar *key, FXdouble def=0.0)
 
FXColor readColorEntry (const FXchar *section, const FXchar *key, FXColor def=0)
 
FXbool readBoolEntry (const FXchar *section, const FXchar *key, FXbool def=FALSE)
 
FXint writeFormatEntry (const FXchar *section, const FXchar *key, const FXchar *fmt,...) FX_PRINTF(4
 
FXint bool writeStringEntry (const FXchar *section, const FXchar *key, const FXchar *val)
 
bool writeIntEntry (const FXchar *section, const FXchar *key, FXint val)
 
bool writeUnsignedEntry (const FXchar *section, const FXchar *key, FXuint val)
 
bool writeRealEntry (const FXchar *section, const FXchar *key, FXdouble val)
 
bool writeColorEntry (const FXchar *section, const FXchar *key, FXColor val)
 
bool writeBoolEntry (const FXchar *section, const FXchar *key, FXbool val)
 
bool deleteEntry (const FXchar *section, const FXchar *key)
 
bool existingEntry (const FXchar *section, const FXchar *key)
 
bool deleteSection (const FXchar *section)
 
bool existingSection (const FXchar *section)
 
bool clear ()
 
void setModified (bool mdfy=true)
 
bool isModified () const
 
virtual ~FXSettings ()
 
- Public Member Functions inherited from FX::FXDict
 FXDict ()
 
 FXDict (const FXDict &orig)
 
FXDictoperator= (const FXDict &orig)
 
void size (FXint m)
 
FXint size () const
 
FXint no () const
 
void * insert (const FXchar *ky, const void *ptr, bool mrk=false)
 
void * replace (const FXchar *ky, const void *ptr, bool mrk=false)
 
void * remove (const FXchar *ky)
 
void * find (const FXchar *ky) const
 
bool empty (FXint pos) const
 
const FXcharkey (FXuint pos) const
 
void * data (FXuint pos) const
 
bool mark (FXuint pos) const
 
FXint first () const
 
FXint last () const
 
FXint next (FXint pos) const
 
FXint prev (FXint pos) const
 
void clear ()
 
virtual ~FXDict ()
 
- Public Member Functions inherited from FX::FXObject
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchargetClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXObject ()
 

Detailed Description

The registry maintains a database of persistent settings for an application.

The settings database is organized in two groups of three layers each. The system-wide settings group contains settings information pertaining to all users on a system. The per-user settings group contains settings affecting that user only. Each settings group contains a desktop layer, which comprises the settings which affect all FOX programs, a vendor layer which holds settings that affect all applications from that vendor (e.g. a application-suite), and an application layer which holds settings only for a single application. The vendor-key and application-key determine which files these layers come from, while the "Desktop" key is used for all FOX applications. Settings in the system-wide group are overwritten by the per-user group, and settings from the "Desktop" layer are overwritten by the vendor-layer; vendor-layer settings are overwritten by the application-layer settings. Only the per-user, per-application settings ever gets written; the layers in the system-group only get written during installation and configuration of the application. The registry is read when FXApp::init() is called, and written back to the system when FXApp::exit() is called.

Constructor & Destructor Documentation

FX::FXRegistry::FXRegistry ( const FXString akey = FXString::null,
const FXString vkey = FXString::null 
)

Construct registry object; akey and vkey must be string constants.

Regular applications SHOULD set a vendor key!

Member Function Documentation

bool FX::FXRegistry::read ( )

Read registry.

bool FX::FXRegistry::write ( )

Write registry.

const FXString& FX::FXRegistry::getAppKey ( ) const
inline

Return application key.

const FXString& FX::FXRegistry::getVendorKey ( ) const
inline

Return vendor key.

void FX::FXRegistry::setAsciiMode ( bool  asciiMode)
inline

Set ASCII mode; under MS-Windows, this will switch the system to a file-based registry system, instead of using the System Registry API.

bool FX::FXRegistry::getAsciiMode ( ) const
inline

Get ASCII mode.

Copyright © 1997-2005 Jeroen van der Zijp