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