interface/wx/msw/regconf.h

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