Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

181
interface/config.h
View File

@@ -39,75 +39,70 @@ class wxConfigBase : public wxObject
public:
/**
)
This is the default and only constructor of the wxConfigBase class, and
derived classes.
@param appName
The application name. If this is empty, the class will
normally use wxApp::GetAppName to set it. The
application name is used in the registry key on Windows, and can be used to
deduce the local filename parameter if that is missing.
The application name. If this is empty, the class will
normally use wxApp::GetAppName to set it. The
application name is used in the registry key on Windows, and can be used to
deduce the local filename parameter if that is missing.
@param vendorName
The vendor name. If this is empty, it is assumed that
no vendor name is wanted, if this is optional for the current config class.
The vendor name is appended to the application name for wxRegConfig.
The vendor name. If this is empty, it is assumed that
no vendor name is wanted, if this is optional for the current config class.
The vendor name is appended to the application name for wxRegConfig.
@param localFilename
Some config classes require a local filename. If this
is not present, but required, the application name will be used instead.
Some config classes require a local filename. If this
is not present, but required, the application name will be used instead.
@param globalFilename
Some config classes require a global filename. If
this is not present, but required, the application name will be used instead.
Some config classes require a global filename. If
this is not present, but required, the application name will be used
instead.
@param style
Can be one of wxCONFIG_USE_LOCAL_FILE and
wxCONFIG_USE_GLOBAL_FILE. The style interpretation depends on the config
class and is ignored by some implementations. For wxFileConfig, these styles
determine whether a local or global config file is created or used: if
wxCONFIG_USE_GLOBAL_FILE is used, then settings are read from the global
config file and if wxCONFIG_USE_LOCAL_FILE is used, settings are read from
and written to local config file (if they are both set, global file is read
first, then local file, overwriting global settings). If the
flag is present but the parameter is empty, the parameter will be set to a
default. If the parameter is present but the style flag not, the relevant flag
will be added to the style. For wxRegConfig, thie GLOBAL flag refers to HKLM
key while LOCAL one is for the usual HKCU one.
For wxFileConfig you can also add wxCONFIG_USE_RELATIVE_PATH by logically
or'ing it to either of the _FILE options to tell wxFileConfig to use relative
instead of absolute paths.
On non-VMS Unix systems, the default local configuration file is ~/.appname.
However, this path may be also used as user data directory
(see wxStandardPaths::GetUserDataDir) if
the application has several data files. In this case wxCONFIG_USE_SUBDIR
flag, which changes the default local configuration file to ~/.appname/appname
should be used. Notice that this flag is ignored if localFilename is
provided. This function is new since wxWidgets version 2.8.2
For wxFileConfig, you can also add wxCONFIG_USE_NO_ESCAPE_CHARACTERS which
will turn off character escaping for the values of entries stored in the config
file: for example a foo key with some backslash characters will be stored
as foo=C:\mydir instead of the usual storage of
foo=C:\\mydir.
The wxCONFIG_USE_NO_ESCAPE_CHARACTERS style can be helpful if your config
file must be read or written to by a non-wxWidgets program (which might not
understand the escape characters). Note, however, that if
wxCONFIG_USE_NO_ESCAPE_CHARACTERS style is used, it is is now
your application's responsibility to ensure that there is no newline or
other illegal characters in a value, before writing that value to the file.
Can be one of wxCONFIG_USE_LOCAL_FILE and
wxCONFIG_USE_GLOBAL_FILE. The style interpretation depends on the config
class and is ignored by some implementations. For wxFileConfig, these styles
determine whether a local or global config file is created or used: if
wxCONFIG_USE_GLOBAL_FILE is used, then settings are read from the global
config file and if wxCONFIG_USE_LOCAL_FILE is used, settings are read from
and written to local config file (if they are both set, global file is read
first, then local file, overwriting global settings). If the
flag is present but the parameter is empty, the parameter will be set to a
default. If the parameter is present but the style flag not, the relevant
flag
will be added to the style. For wxRegConfig, thie GLOBAL flag refers to HKLM
key while LOCAL one is for the usual HKCU one.
For wxFileConfig you can also add wxCONFIG_USE_RELATIVE_PATH by logically
or'ing it to either of the _FILE options to tell wxFileConfig to use
relative
instead of absolute paths.
On non-VMS Unix systems, the default local configuration file is ~/.appname.
However, this path may be also used as user data directory
(see wxStandardPaths::GetUserDataDir) if
the application has several data files. In this case wxCONFIG_USE_SUBDIR
flag, which changes the default local configuration file to
~/.appname/appname
should be used. Notice that this flag is ignored if localFilename is
provided. This function is new since wxWidgets version 2.8.2
For wxFileConfig, you can also add wxCONFIG_USE_NO_ESCAPE_CHARACTERS which
will turn off character escaping for the values of entries stored in the
config
file: for example a foo key with some backslash characters will be stored
as foo=C:\mydir instead of the usual storage of
foo=C:\\mydir.
The wxCONFIG_USE_NO_ESCAPE_CHARACTERS style can be helpful if your config
file must be read or written to by a non-wxWidgets program (which might not
understand the escape characters). Note, however, that if
wxCONFIG_USE_NO_ESCAPE_CHARACTERS style is used, it is is now
your application's responsibility to ensure that there is no newline or
other illegal characters in a value, before writing that value to the file.
@param conv
This parameter is only used by wxFileConfig when compiled
in Unicode mode. It specifies the encoding in which the configuration file
is written.
This parameter is only used by wxFileConfig when compiled
in Unicode mode. It specifies the encoding in which the configuration file
is written.
@remarks By default, environment variable expansion is on and recording
defaults is off.
defaults is off.
*/
wxConfigBase(const wxString& appName = wxEmptyString,
const wxString& vendorName = wxEmptyString,
@@ -133,13 +128,12 @@ public:
near the definition of wxCONFIG_WIN32_NATIVE for details. It returns the
created object and also sets it as the current one.
*/
static wxConfigBase * Create();
static wxConfigBase* Create();
/**
The functions in this section delete entries and/or groups of entries from the
config file. @e DeleteAll() is especially useful if you want to erase all
traces of your program presence: for example, when you uninstall it.
DeleteEntry()
DeleteGroup()
@@ -159,7 +153,7 @@ public:
in it and the second parameter is @true.
*/
bool DeleteEntry(const wxString& key,
bool bDeleteGroupIfEmpty = @true);
bool bDeleteGroupIfEmpty = true);
/**
Delete the group (with all subgroups). If the current path is under the group
@@ -179,7 +173,6 @@ public:
/**
The functions in this section allow to enumerate all entries and groups in the
config file. All functions here return @false when there are no more items.
You must pass the same index to GetNext and GetFirst (don't modify it).
Please note that it is @b not the index of the current item (you will have
some great surprises with wxRegConfig if you assume this) and you shouldn't
@@ -187,11 +180,10 @@ public:
enumeration. It can't be stored inside the class because it would prevent you
from running several enumerations simultaneously, that's why you must pass it
explicitly.
Having said all this, enumerating the config entries/groups is very simple:
There are also functions to get the number of entries/subgroups without
actually enumerating them, but you will probably never need them.
GetFirstGroup()
GetNextGroup()
@@ -215,14 +207,14 @@ public:
permanently writes all changes (otherwise, they're only written from object's
destructor)
*/
bool Flush(bool bCurrentOnly = @false);
bool Flush(bool bCurrentOnly = false);
/**
Get the current config object. If there is no current object and
@e CreateOnDemand is @true, creates one
@a CreateOnDemand is @true, creates one
(using @e Create) unless DontCreateOnDemand was called previously.
*/
#define static wxConfigBase * Get(bool CreateOnDemand = @true) /* implementation is private */
static wxConfigBase* Get(bool CreateOnDemand = true);
/**
Returns the application name.
@@ -235,7 +227,6 @@ public:
be used because some of wxConfig implementations will complain about type
mismatch otherwise: e.g., an attempt to read a string value from an integer
key with wxRegConfig will fail.
The result is an element of enum EntryType:
*/
enum wxConfigBase::EntryType GetEntryType(const wxString& name);
@@ -263,13 +254,13 @@ public:
/**
*/
uint GetNumberOfEntries(bool bRecursive = @false);
uint GetNumberOfEntries(bool bRecursive = false);
/**
Get number of entries/subgroups in the current group, with or without its
subgroups.
*/
uint GetNumberOfGroups(bool bRecursive = @false);
uint GetNumberOfGroups(bool bRecursive = false);
/**
Retrieve the current path (always as absolute path).
@@ -305,21 +296,17 @@ public:
These function are the core of wxConfigBase class: they allow you to read and
write config file data. All @e Read function take a default value which
will be returned if the specified key is not found in the config file.
Currently, supported types of data are:
wxString, @e long, @e double, @e bool,
wxColour and any other types,
for which functions wxToString
and wxFromString are defined.
Try not to read long values into string variables and vice versa: although it
just might work with wxFileConfig, you will get a system error with
wxRegConfig because in the Windows registry the different types of entries are
indeed used.
Final remark: the @e szKey parameter for all these functions can contain an
arbitrary path (either relative or absolute), not just the key name.
Read()
Write()
@@ -342,18 +329,16 @@ public:
first of them is the expansion of environment variables in the string values
read from the config file: for example, if you have the following in your
config file:
the call to @c config-Read("UserData") will return something like
@c "/home/zeitlin/data" if you're lucky enough to run a Linux system ;-)
Although this feature is very useful, it may be annoying if you read a value
which containts '$' or '%' symbols (% is used for environment variables
expansion under Windows) which are not used for environment variable
expansion. In this situation you may call SetExpandEnvVars(@false) just before
reading this value and SetExpandEnvVars(@true) just after. Another solution
would be to prefix the offending symbols with a backslash.
The following functions control this option:
IsExpandingEnvVars()
SetExpandEnvVars()
@@ -373,14 +358,16 @@ public:
which makes it possible to use the relative paths. To clarify all this, here
is an example (it is only for the sake of demonstration, it doesn't do anything
sensible!):
@e Warning: it is probably a good idea to always restore the path to its
old value on function exit:
because otherwise the assert in the following example will surely fail
(we suppose here that @e foo() function is the same as above except that it
doesn't save and restore the path):
Finally, the path separator in wxConfigBase and derived classes is always '/',
regardless of the platform (i.e. it is @b not '\\' under Windows).
SetPath()
GetPath()
@@ -392,30 +379,24 @@ public:
Reads a value of type T, for which function
wxFromString is defined,
returning @true if the value was found.
If the value was not found, @e defaultVal is used instead.
If the value was not found, @a defaultVal is used instead.
bool Read(const wxStringkey, T* value) const;
@b Read(key, default="")
Returns a string
@b ReadInt(key, default=0)
Returns an integer
@b ReadFloat(key, default=0.0)
Returns a floating point number
@b ReadBool(key, default=0)
Returns a boolean
*/
bool Read(const wxString& key, wxString* str);
@@ -437,19 +418,19 @@ public:
//@}
/**
Reads a bool value from the key and returns it. @e defaultVal is returned
Reads a bool value from the key and returns it. @a defaultVal is returned
if the key is not found.
*/
long ReadBool(const wxString& key, bool defaultVal);
/**
Reads a double value from the key and returns it. @e defaultVal is returned
Reads a double value from the key and returns it. @a defaultVal is returned
if the key is not found.
*/
long ReadDouble(const wxString& key, double defaultVal);
/**
Reads a long value from the key and returns it. @e defaultVal is returned
Reads a long value from the key and returns it. @a defaultVal is returned
if the key is not found.
*/
long ReadLong(const wxString& key, long defaultVal);
@@ -457,7 +438,7 @@ public:
/**
Reads a value of type T, for which function
wxFromString is defined, from the key and returns it.
@e defaultVal is returned if the key is not found.
@a defaultVal is returned if the key is not found.
*/
T ReadObject(const wxString& key, T const& defaultVal);
@@ -467,7 +448,6 @@ public:
entry/group with the original name doesn't exist, because the entry/group with
the new name already exists or because the function is not supported in this
wxConfig implementation.
RenameEntry()
RenameGroup()
@@ -478,8 +458,7 @@ public:
Renames an entry in the current group. The entries names (both the old and
the new one) shouldn't contain backslashes, i.e. only simple names and not
arbitrary paths are accepted by this function.
Returns @false if @e oldName doesn't exist or if @e newName already
Returns @false if @a oldName doesn't exist or if @a newName already
exists.
*/
bool RenameEntry(const wxString& oldName,
@@ -489,8 +468,7 @@ public:
Renames a subgroup of the current group. The subgroup names (both the old and
the new one) shouldn't contain backslashes, i.e. only simple names and not
arbitrary paths are accepted by this function.
Returns @false if @e oldName doesn't exist or if @e newName already
Returns @false if @a oldName doesn't exist or if @a newName already
exists.
*/
bool RenameGroup(const wxString& oldName,
@@ -500,12 +478,12 @@ public:
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)
*/
#define static wxConfigBase * Set(wxConfigBase * pConfig) /* implementation is private */
static wxConfigBase* Set(wxConfigBase* pConfig);
/**
Determine whether we wish to expand environment variables in key values.
*/
void SetExpandEnvVars(bool bDoIt = @true);
void SetExpandEnvVars(bool bDoIt = true);
/**
Set current path: if the first character is '/', it is the absolute path,
@@ -517,12 +495,11 @@ public:
/**
Sets whether defaults are recorded to the config file whenever an attempt to
read the value which is not present in it is done.
If on (default is off) all default values for the settings used by the program
are written back to the config file. This allows the user to see what config
options may be changed and is probably useful only for wxFileConfig.
*/
void SetRecordDefaults(bool bDoIt = @true);
void SetRecordDefaults(bool bDoIt = true);
/**
These functions deal with the "default" config object. Although its usage is
@@ -536,17 +513,14 @@ public:
exists. Note that this implies that if you do delete this object yourself
(usually in wxApp::OnExit) you must use @e Set(@NULL)
to prevent wxWidgets from deleting it the second time.
As it happens, you may even further simplify the procedure described above:
you may forget about calling @e Set(). When @e Get() is called and there
is no current object, it will create one using @e Create() function. To
disable this behaviour @e DontCreateOnDemand() is provided.
@b Note: You should use either @e Set() or @e Get() because wxWidgets
library itself would take advantage of it and could save various information
in it. For example wxFontMapper or Unix version
of wxFileDialog have the ability to use wxConfig class.
Set()
Get()
@@ -575,25 +549,20 @@ public:
defined for type @e T.
@b Write(key, value)
Writes a string
@b WriteInt(key, value)
Writes an integer
@b WriteFloat(key, value)
Writes a floating point number
@b WriteBool(key, value)
Writes a boolean
*/
bool Write(const wxString& key, const wxString& value);