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
   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 class WXDLLEXPORT wxWindow;
  19
  20 // possible values for wxSystemSettings::GetFont() parameter
  21 //
  22 // NB: wxMSW assumes that they have the same values as the parameters of
  23 //     Windows GetStockObject() API, don't change the values!
  24 enum wxSystemFont
  25 {
  26     wxSYS_OEM_FIXED_FONT = 10,
  27     wxSYS_ANSI_FIXED_FONT,
  28     wxSYS_ANSI_VAR_FONT,
  29     wxSYS_SYSTEM_FONT,
  30     wxSYS_DEVICE_DEFAULT_FONT,
  31     wxSYS_DEFAULT_PALETTE,
  32     wxSYS_SYSTEM_FIXED_FONT,
  33     wxSYS_DEFAULT_GUI_FONT,
  34
  35     // this was just a temporary aberration, do not use it any more
  36     wxSYS_ICONTITLE_FONT = wxSYS_DEFAULT_GUI_FONT
  37 };
  38
  39 // possible values for wxSystemSettings::GetColour() parameter
  40 //
  41 // NB: wxMSW assumes that they have the same values as the parameters of
  42 //     Windows GetSysColor() API, don't change the values!
  43 enum wxSystemColour
  44 {
  45     wxSYS_COLOUR_SCROLLBAR,
  46     wxSYS_COLOUR_BACKGROUND,
  47     wxSYS_COLOUR_DESKTOP = wxSYS_COLOUR_BACKGROUND,
  48     wxSYS_COLOUR_ACTIVECAPTION,
  49     wxSYS_COLOUR_INACTIVECAPTION,
  50     wxSYS_COLOUR_MENU,
  51     wxSYS_COLOUR_WINDOW,
  52     wxSYS_COLOUR_WINDOWFRAME,
  53     wxSYS_COLOUR_MENUTEXT,
  54     wxSYS_COLOUR_WINDOWTEXT,
  55     wxSYS_COLOUR_CAPTIONTEXT,
  56     wxSYS_COLOUR_ACTIVEBORDER,
  57     wxSYS_COLOUR_INACTIVEBORDER,
  58     wxSYS_COLOUR_APPWORKSPACE,
  59     wxSYS_COLOUR_HIGHLIGHT,
  60     wxSYS_COLOUR_HIGHLIGHTTEXT,
  61     wxSYS_COLOUR_BTNFACE,
  62     wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
  63     wxSYS_COLOUR_BTNSHADOW,
  64     wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
  65     wxSYS_COLOUR_GRAYTEXT,
  66     wxSYS_COLOUR_BTNTEXT,
  67     wxSYS_COLOUR_INACTIVECAPTIONTEXT,
  68     wxSYS_COLOUR_BTNHIGHLIGHT,
  69     wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  70     wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  71     wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
  72     wxSYS_COLOUR_3DDKSHADOW,
  73     wxSYS_COLOUR_3DLIGHT,
  74     wxSYS_COLOUR_INFOTEXT,
  75     wxSYS_COLOUR_INFOBK,
  76     wxSYS_COLOUR_LISTBOX,
  77     wxSYS_COLOUR_HOTLIGHT,
  78     wxSYS_COLOUR_GRADIENTACTIVECAPTION,
  79     wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
  80     wxSYS_COLOUR_MENUHILIGHT,
  81     wxSYS_COLOUR_MENUBAR,
  82
  83     wxSYS_COLOUR_MAX
  84 };
  85
  86 // possible values for wxSystemSettings::GetMetric() index parameter
  87 //
  88 // NB: update the conversion table in msw/settings.cpp if you change the values
  89 //     of the elements of this enum
  90 enum wxSystemMetric
  91 {
  92     wxSYS_MOUSE_BUTTONS = 1,
  93     wxSYS_BORDER_X,
  94     wxSYS_BORDER_Y,
  95     wxSYS_CURSOR_X,
  96     wxSYS_CURSOR_Y,
  97     wxSYS_DCLICK_X,
  98     wxSYS_DCLICK_Y,
  99     wxSYS_DRAG_X,
 100     wxSYS_DRAG_Y,
 101     wxSYS_EDGE_X,
 102     wxSYS_EDGE_Y,
 103     wxSYS_HSCROLL_ARROW_X,
 104     wxSYS_HSCROLL_ARROW_Y,
 105     wxSYS_HTHUMB_X,
 106     wxSYS_ICON_X,
 107     wxSYS_ICON_Y,
 108     wxSYS_ICONSPACING_X,
 109     wxSYS_ICONSPACING_Y,
 110     wxSYS_WINDOWMIN_X,
 111     wxSYS_WINDOWMIN_Y,
 112     wxSYS_SCREEN_X,
 113     wxSYS_SCREEN_Y,
 114     wxSYS_FRAMESIZE_X,
 115     wxSYS_FRAMESIZE_Y,
 116     wxSYS_SMALLICON_X,
 117     wxSYS_SMALLICON_Y,
 118     wxSYS_HSCROLL_Y,
 119     wxSYS_VSCROLL_X,
 120     wxSYS_VSCROLL_ARROW_X,
 121     wxSYS_VSCROLL_ARROW_Y,
 122     wxSYS_VTHUMB_Y,
 123     wxSYS_CAPTION_Y,
 124     wxSYS_MENU_Y,
 125     wxSYS_NETWORK_PRESENT,
 126     wxSYS_PENWINDOWS_PRESENT,
 127     wxSYS_SHOW_SOUNDS,
 128     wxSYS_SWAP_BUTTONS
 129 };
 130
 131 // possible values for wxSystemSettings::HasFeature() parameter
 132 enum wxSystemFeature
 133 {
 134     wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1,
 135     wxSYS_CAN_ICONIZE_FRAME,
 136     wxSYS_TABLET_PRESENT
 137 };
 138
 139 // values for different screen designs
 140 enum wxSystemScreenType
 141 {
 142     wxSYS_SCREEN_NONE = 0,  //   not yet defined
 143
 144     wxSYS_SCREEN_TINY,      //   <
 145     wxSYS_SCREEN_PDA,       //   >= 320x240
 146     wxSYS_SCREEN_SMALL,     //   >= 640x480
 147     wxSYS_SCREEN_DESKTOP    //   >= 800x600
 148 };
 149
 150 // ----------------------------------------------------------------------------
 151 // wxSystemSettingsNative: defines the API for wxSystemSettings class
 152 // ----------------------------------------------------------------------------
 153
 154 // this is a namespace rather than a class: it has only non virtual static
 155 // functions
 156 //
 157 // also note that the methods are implemented in the platform-specific source
 158 // files (i.e. this is not a real base class as we can't override its virtual
 159 // functions because it doesn't have any)
 160
 161 class WXDLLEXPORT wxSystemSettingsNative
 162 {
 163 public:
 164     // get a standard system colour
 165     static wxColour GetColour(wxSystemColour index);
 166
 167     // get a standard system font
 168     static wxFont GetFont(wxSystemFont index);
 169
 170     // get a system-dependent metric
 171     static int GetMetric(wxSystemMetric index, wxWindow * win = NULL);
 172
 173     // return true if the port has certain feature
 174     static bool HasFeature(wxSystemFeature index);
 175 };
 176
 177 // ----------------------------------------------------------------------------
 178 // include the declaration of the real platform-dependent class
 179 // ----------------------------------------------------------------------------
 180
 181 class WXDLLEXPORT wxSystemSettings : public wxSystemSettingsNative
 182 {
 183 public:
 184 #ifdef __WXUNIVERSAL__
 185     // in wxUniversal we want to use the theme standard colours instead of the
 186     // system ones, otherwise wxSystemSettings is just the same as
 187     // wxSystemSettingsNative
 188     static wxColour GetColour(wxSystemColour index);
 189 #endif // __WXUNIVERSAL__
 190
 191     // Get system screen design (desktop, pda, ..) used for
 192     // laying out various dialogs.
 193     static wxSystemScreenType GetScreenType();
 194
 195     // Override default.
 196     static void SetScreenType( wxSystemScreenType screen );
 197
 198     // Value
 199     static wxSystemScreenType ms_screen;
 200
 201 #if WXWIN_COMPATIBILITY_2_4
 202     // the backwards compatible versions of wxSystemSettingsNative functions,
 203     // don't use these methods in the new code!
 204     wxDEPRECATED(static wxColour GetSystemColour(int index));
 205     wxDEPRECATED(static wxFont GetSystemFont(int index));
 206     wxDEPRECATED(static int GetSystemMetric(int index));
 207 #endif
 208 };
 209
 210 #endif
 211     // _WX_SETTINGS_H_BASE_
 212