interface/sysopt.h

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