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

Make wxConfig ctor docs more readable.

Browse Source 
Add a simple stub for wxRegConfig class so that Doxygen highlights it just like it does with wxFileConfig.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64465 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2010-06-02 13:53:12 +00:00
parent bbdee10d5f
commit df693ed65c
2 changed files with 56 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
interface/wx/config.h
View File

@@ -16,11 +16,10 @@
However, usually you don't even need to know the precise nature of the However, usually you don't even need to know the precise nature of the
class you're working with but you would just use the wxConfigBase methods. class you're working with but you would just use the wxConfigBase methods.
This allows you to write the same code regardless of whether you're working This allows you to write the same code regardless of whether you're working
with the registry under Win32 or text-based config files under Unix (or with the registry under Windows or text-based config files under Unix.
even Windows 3.1 .INI files if you're really unlucky). To make writing the To make writing the portable code even easier, wxWidgets provides a typedef
portable code even easier, wxWidgets provides a typedef wxConfig which is wxConfig which is mapped onto the native wxConfigBase implementation on the
mapped onto the native wxConfigBase implementation on the given platform: given platform: i.e. wxRegConfig under Windows and wxFileConfig otherwise.
i.e. wxRegConfig under Win32 and wxFileConfig otherwise.
See @ref overview_config for a description of all features of this class. See @ref overview_config for a description of all features of this class.
@@ -281,39 +280,39 @@ public:
Some config classes require a global filename. If this is not Some config classes require a global filename. If this is not
present, but required, the application name will be used instead. present, but required, the application name will be used instead.
@param style @param style
Can be one of wxCONFIG_USE_LOCAL_FILE and wxCONFIG_USE_GLOBAL_FILE. Can be one of @c wxCONFIG_USE_LOCAL_FILE and @c wxCONFIG_USE_GLOBAL_FILE.
The style interpretation depends on the config class and is ignored @n The style interpretation depends on the config class and is ignored
by some implementations. For wxFileConfig, these styles determine by some implementations. For wxFileConfig, these styles determine
whether a local or global config file is created or used: if whether a local or global config file is created or used: if
wxCONFIG_USE_GLOBAL_FILE is used, then settings are read from the @c wxCONFIG_USE_GLOBAL_FILE is used, then settings are read from the
global config file and if wxCONFIG_USE_LOCAL_FILE is used, settings global config file and if @c wxCONFIG_USE_LOCAL_FILE is used, settings
are read from and written to local config file (if they are both are read from and written to local config file (if they are both
set, global file is read first, then local file, overwriting global set, global file is read first, then local file, overwriting global
settings). If the flag is present but the parameter is empty, the 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 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. the style flag not, the relevant flag will be added to the style.
For wxRegConfig, thie GLOBAL flag refers to HKLM key while LOCAL For wxRegConfig, the GLOBAL flag refers to the @c HKLM key while LOCAL
one is for the usual HKCU one. one is for the usual @c HKCU one.
@n For wxFileConfig you can also add wxCONFIG_USE_RELATIVE_PATH by @n For wxFileConfig you can also add @c wxCONFIG_USE_RELATIVE_PATH by
logically or'ing it to either of the _FILE options to tell logically or'ing it to either of the _FILE options to tell
wxFileConfig to use relative instead of absolute paths. wxFileConfig to use relative instead of absolute paths.
@n On non-VMS Unix systems, the default local configuration file is @n On non-VMS Unix systems, the default local configuration file is
"~/.appname". However, this path may be also used as user data "~/.appname". However, this path may be also used as user data
directory (see wxStandardPaths::GetUserDataDir()) if the directory (see wxStandardPaths::GetUserDataDir()) if the
application has several data files. In this case application has several data files. In this case
wxCONFIG_USE_SUBDIR flag, which changes the default local @c wxCONFIG_USE_SUBDIR flag, which changes the default local
configuration file to "~/.appname/appname" should be used. Notice configuration file to "~/.appname/appname" should be used. Notice
that this flag is ignored if localFilename is provided. that this flag is ignored if @a localFilename is provided.
wxCONFIG_USE_SUBDIR is new since wxWidgets version 2.8.2. @c wxCONFIG_USE_SUBDIR is new since wxWidgets version 2.8.2.
@n For wxFileConfig, you can also add @n For wxFileConfig, you can also add
wxCONFIG_USE_NO_ESCAPE_CHARACTERS which will turn off character @c wxCONFIG_USE_NO_ESCAPE_CHARACTERS which will turn off character
escaping for the values of entries stored in the config file: for escaping for the values of entries stored in the config file: for
example a foo key with some backslash characters will be stored as example a foo key with some backslash characters will be stored as
"foo=C:\mydir" instead of the usual storage of "foo=C:\\mydir". "foo=C:\mydir" instead of the usual storage of "foo=C:\\mydir".
@n The wxCONFIG_USE_NO_ESCAPE_CHARACTERS style can be helpful if your @n The @c wxCONFIG_USE_NO_ESCAPE_CHARACTERS style can be helpful if your
config file must be read or written to by a non-wxWidgets program config file must be read or written to by a non-wxWidgets program
(which might not understand the escape characters). Note, however, (which might not understand the escape characters). Note, however,
that if wxCONFIG_USE_NO_ESCAPE_CHARACTERS style is used, it is is that if @c wxCONFIG_USE_NO_ESCAPE_CHARACTERS style is used, it is is
now your application's responsibility to ensure that there is no now your application's responsibility to ensure that there is no
newline or other illegal characters in a value, before writing that newline or other illegal characters in a value, before writing that
value to the file. value to the file.

39
interface/wx/msw/regconf.h Normal file
View File

@@ -0,0 +1,39 @@
/////////////////////////////////////////////////////////////////////////////
// Name: regconf.h
// Purpose: interface of wxRegConfig
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxRegConfig
wxRegConfig implements the wxConfigBase interface for
storing and retrieving configuration information using Windows registry.
This class is used by default for wxConfig on Windows platforms; see wxFileConfig
for an alternative you may want to use (also on Windows).
@library{wxbase}
@category{cfg}
@see wxConfigBase
*/
class wxRegConfig : public wxConfigBase
{
public:
/**
The wxRegConfig constructor. For more info see the docs for the
wxConfigBase::wxConfigBase() constructor.
Note that wxRegConfig's @a style argument defaults to @c wxCONFIG_USE_GLOBAL_FILE,
i.e. to the use of the @c HKLM key (also known as "HKEY_LOCAL_MACHINE").
*/
wxRegConfig(const wxString& appName = wxEmptyString,
const wxString& vendorName = wxEmptyString,
const wxString& localFilename = wxEmptyString,
const wxString& globalFilename = wxEmptyString,
long style = wxCONFIG_USE_GLOBAL_FILE);
};