wxConfigBase

Implements methods from the following classes

• wxObject

Methods

• DeleteAll
  Delete the whole underlying object (disk file, registry key, ...).
• DeleteEntry
  Deletes the specified entry and the group it belongs to if it was the last key in it and the second parameter is true.
• DeleteGroup
  Delete the group (with all subgroups).
• Exists
• Flush
  Permanently writes all changes (otherwise, they're only written from object's destructor).
• GetAppName
  Returns the application name.
• GetEntryType
  Returns the type of the given entry or Unknown if the entry doesn't exist.
• GetFirstEntry
  Gets the first entry.
• GetFirstGroup
  Gets the first group.
• GetNextEntry
  Gets the next entry.
• GetNextGroup
  Gets the next group.
• GetNumberOfEntries
  Get number of entries in the current group.
• GetNumberOfGroups
  Get number of entries/subgroups in the current group, with or without its subgroups.
• GetPath
  Retrieve the current path (always as absolute path).
• GetVendorName
  Returns the vendor name.
• HasEntry
• HasGroup
• IsExpandingEnvVars
  Returns true if we are expanding environment variables in key values.
• IsRecordingDefaults
  Returns true if we are writing defaults back to the config file.
• Read
  Read a string from the key, returning true if the value was read.
• ReadBool
  Reads a bool value from the key and returns it.
• ReadDouble
  Reads a double value from the key and returns it.
• ReadLong
  Reads a long value from the key and returns it.
• RenameEntry
  Renames an entry in the current group.
• RenameGroup
  Renames a subgroup of the current group.
• SetExpandEnvVars
  Determine whether we wish to expand environment variables in key values.
• SetPath
  Set current path: if the first character is '/', it is the absolute path, otherwise it is a relative path.
• SetRecordDefaults
  Sets whether defaults are recorded to the config file whenever an attempt to read the value which is not present in it is done.
• Write
  Writes the wxString value to the config file and returns true on success.

Static Methods

• Create
  Create a new config object and sets it as the current one.
• DontCreateOnDemand
  Calling this function will prevent Get() from automatically creating a new config object if the current one is NULL.
• Get
  Get the current config object.
• Set
  Sets the config object as the current one, returns the pointer to the previous current object (both the parameter and returned value may be NULL).

Create

static wxConfigBase& Create ( )

Create a new config object and sets it as the current one.

DeleteAll

bool DeleteAll ( )

Delete the whole underlying object (disk file, registry key, ...).

DeleteEntry

bool DeleteEntry ( string $key, bool $bDeleteGroupIfEmpty=true )

Deletes the specified entry and the group it belongs to if it was the last key in it and the second parameter is true.

DeleteGroup

bool DeleteGroup ( string $key )

Delete the group (with all subgroups).

DontCreateOnDemand

static DontCreateOnDemand ( )

Calling this function will prevent Get() from automatically creating a new config object if the current one is NULL.

Exists

bool Exists ( string $strName )

Flush

bool Flush ( bool $bCurrentOnly=false )

Permanently writes all changes (otherwise, they're only written from object's destructor).

Get

static wxConfigBase& Get ( bool $CreateOnDemand=true )

Get the current config object.

GetAppName

string GetAppName ( )

Returns the application name.

GetEntryType

wxConfigBase::EntryType GetEntryType ( string $name )

Returns the type of the given entry or Unknown if the entry doesn't exist.

GetFirstEntry

bool GetFirstEntry ( string &$str, integer &$index )

Gets the first entry.

GetFirstGroup

bool GetFirstGroup ( string &$str, integer &$index )

Gets the first group.

GetNextEntry

bool GetNextEntry ( string &$str, integer &$index )

Gets the next entry.

GetNextGroup

bool GetNextGroup ( string &$str, integer &$index )

Gets the next group.

GetNumberOfEntries

integer GetNumberOfEntries ( bool $bRecursive=false )

Get number of entries in the current group.

GetNumberOfGroups

integer GetNumberOfGroups ( bool $bRecursive=false )

Get number of entries/subgroups in the current group, with or without its subgroups.

GetPath

string GetPath ( )

Retrieve the current path (always as absolute path).

GetVendorName

string GetVendorName ( )

Returns the vendor name.

HasEntry

bool HasEntry ( string $strName )

HasGroup

bool HasGroup ( string $strName )

IsExpandingEnvVars

bool IsExpandingEnvVars ( )

Returns true if we are expanding environment variables in key values.

IsRecordingDefaults

bool IsRecordingDefaults ( )

Returns true if we are writing defaults back to the config file.

Read

bool Read ( string $key, string &$str )

Read a string from the key, returning true if the value was read.
bool Read ( string $key, string &$str, string $defaultVal )

Read a string from the key.
string Read ( string $key, string $defaultVal )

Another version of Read(), returning the string value directly.
bool Read ( string $key, integer &$l )

Reads a long value, returning true if the value was found.
bool Read ( string $key, integer &$l, integer $defaultVal )

Reads a long value, returning true if the value was found.
bool Read ( string $key, float &$d )

Reads a double value, returning true if the value was found.
bool Read ( string $key, float &$d, float $defaultVal )

Reads a double value, returning true if the value was found.
bool Read ( string $key, float &$f )

Reads a float value, returning true if the value was found.
bool Read ( string $key, float &$f, float $defaultVal )

Reads a float value, returning true if the value was found.
bool Read ( string $key, bool &$b )

Reads a boolean value, returning true if the value was found.
bool Read ( string $key, bool &$d, bool $defaultVal )

Reads a boolean value, returning true if the value was found.

ReadBool

bool ReadBool ( string $key, bool $defaultVal )

Reads a bool value from the key and returns it.

ReadDouble

float ReadDouble ( string $key, float $defaultVal )

Reads a double value from the key and returns it.

ReadLong

integer ReadLong ( string $key, integer $defaultVal )

Reads a long value from the key and returns it.

RenameEntry

bool RenameEntry ( string $oldName, string $newName )

Renames an entry in the current group.

RenameGroup

bool RenameGroup ( string $oldName, string $newName )

Renames a subgroup of the current group.

Set

static wxConfigBase& Set ( wxConfigBase &$pConfig )

Sets the config object as the current one, returns the pointer to the previous current object (both the parameter and returned value may be NULL).

SetExpandEnvVars

SetExpandEnvVars ( bool $bDoIt=true )

Determine whether we wish to expand environment variables in key values.

SetPath

SetPath ( string $strPath )

Set current path: if the first character is '/', it is the absolute path, otherwise it is a relative path.

SetRecordDefaults

SetRecordDefaults ( bool $bDoIt=true )

Sets whether defaults are recorded to the config file whenever an attempt to read the value which is not present in it is done.

Write

bool Write ( string $key, string $value )

Writes the wxString value to the config file and returns true on success.
bool Write ( string $key, integer $value )

Writes the long value to the config file and returns true on success.
bool Write ( string $key, float $value )

Writes the double value to the config file and returns true on success.
bool Write ( string $key, bool $value )

Writes the bool value to the config file and returns true on success.