include/wx/settings.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/settings.h
   3 // Purpose:     wxSystemSettings class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_SETTINGS_H_BASE_
  13 #define _WX_SETTINGS_H_BASE_
  14
  15 #include "wx/colour.h"
  16 #include "wx/font.h"
  17
  18 // possible values for wxSystemSettings::GetFont() parameter
  19 //
  20 // NB: wxMSW assumes that they have the same values as the parameters of
  21 //     Windows GetStockObject() API, don't change the values!
  22 enum wxSystemFont
  23 {
  24     wxSYS_OEM_FIXED_FONT = 10,
  25     wxSYS_ANSI_FIXED_FONT,
  26     wxSYS_ANSI_VAR_FONT,
  27     wxSYS_SYSTEM_FONT,
  28     wxSYS_DEVICE_DEFAULT_FONT,
  29     wxSYS_DEFAULT_PALETTE,
  30     wxSYS_SYSTEM_FIXED_FONT,
  31     wxSYS_DEFAULT_GUI_FONT
  32 };
  33
  34 // possible values for wxSystemSettings::GetColour() parameter
  35 //
  36 // NB: wxMSW assumes that they have the same values as the parameters of
  37 //     Windows GetSysColor() API, don't change the values!
  38 enum wxSystemColour
  39 {
  40     wxSYS_COLOUR_SCROLLBAR,
  41     wxSYS_COLOUR_BACKGROUND,
  42     wxSYS_COLOUR_DESKTOP = wxSYS_COLOUR_BACKGROUND,
  43     wxSYS_COLOUR_ACTIVECAPTION,
  44     wxSYS_COLOUR_INACTIVECAPTION,
  45     wxSYS_COLOUR_MENU,
  46     wxSYS_COLOUR_WINDOW,
  47     wxSYS_COLOUR_WINDOWFRAME,
  48     wxSYS_COLOUR_MENUTEXT,
  49     wxSYS_COLOUR_WINDOWTEXT,
  50     wxSYS_COLOUR_CAPTIONTEXT,
  51     wxSYS_COLOUR_ACTIVEBORDER,
  52     wxSYS_COLOUR_INACTIVEBORDER,
  53     wxSYS_COLOUR_APPWORKSPACE,
  54     wxSYS_COLOUR_HIGHLIGHT,
  55     wxSYS_COLOUR_HIGHLIGHTTEXT,
  56     wxSYS_COLOUR_BTNFACE,
  57     wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
  58     wxSYS_COLOUR_BTNSHADOW,
  59     wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
  60     wxSYS_COLOUR_GRAYTEXT,
  61     wxSYS_COLOUR_BTNTEXT,
  62     wxSYS_COLOUR_INACTIVECAPTIONTEXT,
  63     wxSYS_COLOUR_BTNHIGHLIGHT,
  64     wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  65     wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  66     wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  67     wxSYS_COLOUR_3DDKSHADOW,
  68     wxSYS_COLOUR_3DLIGHT,
  69     wxSYS_COLOUR_INFOTEXT,
  70     wxSYS_COLOUR_INFOBK,
  71     wxSYS_COLOUR_LISTBOX,
  72     wxSYS_COLOUR_HOTLIGHT,
  73     wxSYS_COLOUR_GRADIENTACTIVECAPTION,
  74     wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
  75     wxSYS_COLOUR_MENUHILIGHT,
  76     wxSYS_COLOUR_MENUBAR,
  77
  78     wxSYS_COLOUR_MAX
  79 };
  80
  81 // possible values for wxSystemSettings::GetMetric() parameter
  82 //
  83 // NB: update the conversion table in msw/settings.cpp if you change the values
  84 //     of the elements of this enum
  85 enum wxSystemMetric
  86 {
  87     wxSYS_MOUSE_BUTTONS = 1,
  88     wxSYS_BORDER_X,
  89     wxSYS_BORDER_Y,
  90     wxSYS_CURSOR_X,
  91     wxSYS_CURSOR_Y,
  92     wxSYS_DCLICK_X,
  93     wxSYS_DCLICK_Y,
  94     wxSYS_DRAG_X,
  95     wxSYS_DRAG_Y,
  96     wxSYS_EDGE_X,
  97     wxSYS_EDGE_Y,
  98     wxSYS_HSCROLL_ARROW_X,
  99     wxSYS_HSCROLL_ARROW_Y,
 100     wxSYS_HTHUMB_X,
 101     wxSYS_ICON_X,
 102     wxSYS_ICON_Y,
 103     wxSYS_ICONSPACING_X,
 104     wxSYS_ICONSPACING_Y,
 105     wxSYS_WINDOWMIN_X,
 106     wxSYS_WINDOWMIN_Y,
 107     wxSYS_SCREEN_X,
 108     wxSYS_SCREEN_Y,
 109     wxSYS_FRAMESIZE_X,
 110     wxSYS_FRAMESIZE_Y,
 111     wxSYS_SMALLICON_X,
 112     wxSYS_SMALLICON_Y,
 113     wxSYS_HSCROLL_Y,
 114     wxSYS_VSCROLL_X,
 115     wxSYS_VSCROLL_ARROW_X,
 116     wxSYS_VSCROLL_ARROW_Y,
 117     wxSYS_VTHUMB_Y,
 118     wxSYS_CAPTION_Y,
 119     wxSYS_MENU_Y,
 120     wxSYS_NETWORK_PRESENT,
 121     wxSYS_PENWINDOWS_PRESENT,
 122     wxSYS_SHOW_SOUNDS,
 123     wxSYS_SWAP_BUTTONS
 124 };
 125
 126 // possible values for wxSystemSettings::HasFeature() parameter
 127 enum wxSystemFeature
 128 {
 129     wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1,
 130     wxSYS_CAN_ICONIZE_FRAME
 131 };
 132
 133 // values for wxSystemSettings::GetString
 134 enum wxSystemString
 135 {
 136     wxSYS_DECIMAL_SEPARATOR = 1,
 137     wxSYS_LIST_SEPARATOR,
 138     wxSYS_LEADING_ZERO
 139 };
 140
 141 // ----------------------------------------------------------------------------
 142 // wxSystemSettingsNative: defines the API for wxSystemSettings class
 143 // ----------------------------------------------------------------------------
 144
 145 // this is a namespace rather than a class: it has only non virtual static
 146 // functions
 147 //
 148 // also note that the methods are implemented in the platform-specific source
 149 // files (i.e. this is not a real base class as we can't override its virtual
 150 // functions because it doesn't have any)
 151
 152 class WXDLLEXPORT wxSystemSettingsNative
 153 {
 154 public:
 155     // get a standard system colour
 156     static wxColour GetColour(wxSystemColour index);
 157
 158     // get a standard system font
 159     static wxFont GetFont(wxSystemFont index);
 160
 161     // get a system-dependent metric
 162     static int GetMetric(wxSystemMetric index);
 163
 164     // return true if the port has certain feature
 165     static bool HasFeature(wxSystemFeature index);
 166
 167     // Windows-only for now
 168 #ifdef __WXMSW__
 169     // Get a system string, e. g. decimal separator
 170     static wxString GetString(int index);
 171 #endif
 172 };
 173
 174 // ----------------------------------------------------------------------------
 175 // include the declaration of the real platform-dependent class
 176 // ----------------------------------------------------------------------------
 177
 178 class wxSystemSettings : public wxSystemSettingsNative
 179 {
 180 public:
 181 #ifdef __WXUNIVERSAL__
 182     // in wxUniversal we want to use the theme standard colours instead of the
 183     // system ones, otherwuse wxSystemSettings is just the same as
 184     // wxSystemSettingsNative
 185     static wxColour GetColour(wxSystemColour index);
 186 #endif // __WXUNIVERSAL__
 187
 188
 189     // the backwards compatible versions of wxSystemSettingsNative functions,
 190     // don't use these methods in the new code!
 191     static wxColour GetSystemColour(int index)
 192         { return GetColour((wxSystemColour)index); }
 193     static wxFont GetSystemFont(int index)
 194         { return GetFont((wxSystemFont)index); }
 195     static int GetSystemMetric(int index)
 196         { return GetMetric((wxSystemMetric)index); }
 197 };
 198
 199 #endif
 200     // _WX_SETTINGS_H_BASE_
 201