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