interface/wx/sysopt.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        sysopt.h
   3 // Purpose:     interface of wxSystemOptions
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxSystemOptions
  11
  12     wxSystemOptions stores option/value pairs that wxWidgets itself or
  13     applications can use to alter behaviour at run-time. It can be
  14     used to optimize behaviour that doesn't deserve a distinct API,
  15     but is still important to be able to configure.
  16
  17     These options are currently recognised by wxWidgets.
  18
  19     @library{wxbase}
  20     @category{misc}
  21
  22     @see wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt,
  23     wxSystemOptions::HasOption
  24 */
  25 class wxSystemOptions : public wxObject
  26 {
  27 public:
  28     /**
  29         Default constructor. You don't need to create an instance of wxSystemOptions
  30         since all of its functions are static.
  31     */
  32     wxSystemOptions();
  33
  34     /**
  35         Gets an option. The function is case-insensitive to @e name.
  36         Returns empty string if the option hasn't been set.
  37
  38         @see SetOption(), GetOptionInt(),
  39              HasOption()
  40     */
  41     wxString GetOption(const wxString& name) const;
  42
  43     /**
  44         Gets an option as an integer. The function is case-insensitive to @e name.
  45         If the option hasn't been set, this function returns 0.
  46
  47         @see SetOption(), GetOption(),
  48              HasOption()
  49     */
  50     int GetOptionInt(const wxString& name) const;
  51
  52     /**
  53         Returns @true if the given option is present. The function is
  54         case-insensitive to @e name.
  55
  56         @see SetOption(), GetOption(),
  57              GetOptionInt()
  58     */
  59     bool HasOption(const wxString& name) const;
  60
  61     /**
  62         Returns @true if the option with the given @a name had been set to 0
  63         value. This is mostly useful for boolean options for which you can't use
  64         @c GetOptionInt(name) == 0 as this would also be @true if the option
  65         hadn't been set at all.
  66     */
  67     bool IsFalse(const wxString& name) const;
  68
  69     //@{
  70     /**
  71         Sets an option. The function is case-insensitive to @e name.
  72     */
  73     void SetOption(const wxString& name, const wxString& value);
  74     void SetOption(const wxString& name, int value);
  75     //@}
  76 };
  77