interface/wx/msw/regconf.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        regconf.h
   3 // Purpose:     interface of wxRegConfig
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8 /**
   9     @class wxRegConfig
  10
  11     wxRegConfig implements the wxConfigBase interface for
  12     storing and retrieving configuration information using Windows registry.
  13
  14     This class is used by default for wxConfig on Windows platforms; see wxFileConfig
  15     for an alternative you may want to use (also on Windows).
  16
  17     @library{wxbase}
  18     @category{cfg}
  19
  20     @see wxConfigBase
  21 */
  22 class wxRegConfig : public wxConfigBase
  23 {
  24 public:
  25     /**
  26         The wxRegConfig constructor. For more info see the docs for the
  27         wxConfigBase::wxConfigBase() constructor.
  28
  29         Note that wxRegConfig's @a style argument defaults to @c wxCONFIG_USE_GLOBAL_FILE,
  30         i.e. to the use of the @c HKLM key (also known as "HKEY_LOCAL_MACHINE").
  31     */
  32     wxRegConfig(const wxString& appName = wxEmptyString,
  33                 const wxString& vendorName = wxEmptyString,
  34                 const wxString& localFilename = wxEmptyString,
  35                 const wxString& globalFilename = wxEmptyString,
  36                 long style = wxCONFIG_USE_GLOBAL_FILE);
  37 };
  38