wxWidgets/interface/wx/msw/regconf.h
Francesco Montorsi df693ed65c Make wxConfig ctor docs more readable.
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
2010-06-02 13:53:12 +00:00

40 lines
1.3 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// 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);
};