interface/wx/settings.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        settings.h
   3 // Purpose:     interface of wxSystemSettings
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8
   9 /**
  10     Possible values for wxSystemSettings::GetFont() parameter.
  11
  12     These values map 1:1 the native values supported by the Windows' @c GetStockObject
  13     function. Note that other ports (other than wxMSW) will try to provide meaningful
  14     fonts but they usually map the same font to various @c wxSYS_*_FONT values.
  15 */
  16 enum wxSystemFont
  17 {
  18     /// Original equipment manufacturer dependent fixed-pitch font.
  19     wxSYS_OEM_FIXED_FONT = 10,
  20
  21     /// Windows fixed-pitch (monospaced) font.
  22     wxSYS_ANSI_FIXED_FONT,
  23
  24     /// Windows variable-pitch (proportional) font.
  25     wxSYS_ANSI_VAR_FONT,
  26
  27     /// System font. By default, the system uses the system font to draw menus,
  28     /// dialog box controls, and text.
  29     wxSYS_SYSTEM_FONT,
  30
  31     /// Device-dependent font (Windows NT and later only).
  32     wxSYS_DEVICE_DEFAULT_FONT,
  33
  34     /**
  35         Default font for user interface objects such as menus and dialog boxes.
  36         Note that with modern GUIs nothing guarantees that the same font is used
  37         for all GUI elements, so some controls might use a different font by default.
  38     */
  39     wxSYS_DEFAULT_GUI_FONT
  40 };
  41
  42
  43 /**
  44     Possible values for wxSystemSettings::GetColour() parameter.
  45
  46     These values map 1:1 the native values supported by the Windows' @c GetSysColor
  47     function. Note that other ports (other than wxMSW) will try to provide meaningful
  48     colours but they usually map the same colour to various @c wxSYS_COLOUR_* values.
  49 */
  50 enum wxSystemColour
  51 {
  52     wxSYS_COLOUR_SCROLLBAR,           //!< The scrollbar grey area.
  53     wxSYS_COLOUR_DESKTOP,             //!< The desktop colour.
  54     wxSYS_COLOUR_ACTIVECAPTION,       //!< Active window caption colour.
  55     wxSYS_COLOUR_INACTIVECAPTION,     //!< Inactive window caption colour.
  56     wxSYS_COLOUR_MENU,                //!< Menu background colour.
  57     wxSYS_COLOUR_WINDOW,              //!< Window background colour.
  58     wxSYS_COLOUR_WINDOWFRAME,         //!< Window frame colour.
  59     wxSYS_COLOUR_MENUTEXT,            //!< Colour of the text used in the menus.
  60     wxSYS_COLOUR_WINDOWTEXT,          //!< Colour of the text used in generic windows.
  61     wxSYS_COLOUR_CAPTIONTEXT,         //!< Colour of the text used in captions, size boxes and scrollbar arrow boxes.
  62     wxSYS_COLOUR_ACTIVEBORDER,        //!< Active window border colour.
  63     wxSYS_COLOUR_INACTIVEBORDER,      //!< Inactive window border colour.
  64     wxSYS_COLOUR_APPWORKSPACE,        //!< Background colour for MDI applications.
  65     wxSYS_COLOUR_HIGHLIGHT,           //!< Colour of item(s) selected in a control.
  66     wxSYS_COLOUR_HIGHLIGHTTEXT,       //!< Colour of the text of item(s) selected in a control.
  67     wxSYS_COLOUR_BTNFACE,             //!< Face shading colour on push buttons.
  68     wxSYS_COLOUR_BTNSHADOW,           //!< Edge shading colour on push buttons.
  69     wxSYS_COLOUR_GRAYTEXT,            //!< Colour of greyed (disabled) text.
  70     wxSYS_COLOUR_BTNTEXT,             //!< Colour of the text on push buttons.
  71     wxSYS_COLOUR_INACTIVECAPTIONTEXT, //!< Colour of the text in active captions.
  72     wxSYS_COLOUR_BTNHIGHLIGHT,        //!< Highlight colour for buttons.
  73     wxSYS_COLOUR_3DDKSHADOW,          //!< Dark shadow colour for three-dimensional display elements.
  74     wxSYS_COLOUR_3DLIGHT,             //!< Light colour for three-dimensional display elements.
  75     wxSYS_COLOUR_INFOTEXT,            //!< Text colour for tooltip controls.
  76     wxSYS_COLOUR_INFOBK,              //!< Background colour for tooltip controls.
  77     wxSYS_COLOUR_LISTBOX,             //!< Background colour for list-like controls.
  78     wxSYS_COLOUR_HOTLIGHT,            //!< Colour for a hyperlink or hot-tracked item.
  79
  80     /**
  81         Right side colour in the color gradient of an active window's title bar.
  82         @c wxSYS_COLOUR_ACTIVECAPTION specifies the left side color.
  83     */
  84     wxSYS_COLOUR_GRADIENTACTIVECAPTION,
  85
  86     /**
  87         Right side colour in the color gradient of an inactive window's title bar.
  88         @c wxSYS_COLOUR_INACTIVECAPTION specifies the left side color.
  89     */
  90     wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
  91
  92     /**
  93         The colour used to highlight menu items when the menu appears as a flat menu.
  94         The highlighted menu item is outlined with @c wxSYS_COLOUR_HIGHLIGHT.
  95     */
  96     wxSYS_COLOUR_MENUHILIGHT,
  97
  98     /**
  99         The background colour for the menu bar when menus appear as flat menus.
 100         However, @c wxSYS_COLOUR_MENU continues to specify the background color of the menu popup.
 101     */
 102     wxSYS_COLOUR_MENUBAR,
 103
 104     /**
 105         Text colour for list-like controls.
 106
 107         @since 2.9.0
 108      */
 109     wxSYS_COLOUR_LISTBOXTEXT,
 110
 111     /**
 112         Text colour for the unfocused selection of list-like controls.
 113
 114         @since 2.9.1
 115      */
 116     wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT,
 117
 118     wxSYS_COLOUR_MAX
 119
 120
 121
 122     // synonyms:
 123
 124     wxSYS_COLOUR_BACKGROUND = wxSYS_COLOUR_DESKTOP,
 125         //!< Synonym for @c wxSYS_COLOUR_DESKTOP.
 126     wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
 127         //!< Synonym for @c wxSYS_COLOUR_BTNFACE.
 128     wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
 129         //!< Synonym for @c wxSYS_COLOUR_BTNSHADOW.
 130     wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
 131         //!< Synonym for @c wxSYS_COLOUR_BTNHIGHLIGHT.
 132     wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
 133         //!< Synonym for @c wxSYS_COLOUR_BTNHIGHLIGHT.
 134     wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
 135         //!< Synonym for @c wxSYS_COLOUR_BTNHIGHLIGHT.
 136
 137     /**
 138         Synonym for @c wxSYS_COLOUR_BTNFACE.
 139
 140         On wxMSW this colour should be used as the background colour of
 141         wxFrames which are used as containers of controls; this is in fact the
 142         same colour used for the borders of controls like e.g. wxNotebook or
 143         for the background of e.g. wxPanel.
 144
 145         @since 2.9.0
 146     */
 147     wxSYS_COLOUR_FRAMEBK = wxSYS_COLOUR_BTNFACE
 148 };
 149
 150 /**
 151     Possible values for wxSystemSettings::GetMetric() index parameter.
 152 */
 153 enum wxSystemMetric
 154 {
 155     wxSYS_MOUSE_BUTTONS,      //!< Number of buttons on mouse, or zero if no mouse was installed.
 156     wxSYS_BORDER_X,           //!< Width of single border.
 157     wxSYS_BORDER_Y,           //!< Height of single border.
 158     wxSYS_CURSOR_X,           //!< Width of cursor.
 159     wxSYS_CURSOR_Y,           //!< Height of cursor.
 160     wxSYS_DCLICK_X,           //!< Width in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click.
 161     wxSYS_DCLICK_Y,           //!< Height in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click.
 162     wxSYS_DRAG_X,             //!< Width in pixels of a rectangle centered on a drag point to allow for limited movement of the mouse pointer before a drag operation begins.
 163     wxSYS_DRAG_Y,             //!< Height in pixels of a rectangle centered on a drag point to allow for limited movement of the mouse pointer before a drag operation begins.
 164     wxSYS_EDGE_X,             //!< Width of a 3D border, in pixels.
 165     wxSYS_EDGE_Y,             //!< Height of a 3D border, in pixels.
 166     wxSYS_HSCROLL_ARROW_X,    //!< Width of arrow bitmap on horizontal scrollbar.
 167     wxSYS_HSCROLL_ARROW_Y,    //!< Height of arrow bitmap on horizontal scrollbar.
 168     wxSYS_HTHUMB_X,           //!< Width of horizontal scrollbar thumb.
 169     wxSYS_ICON_X,             //!< The default width of an icon.
 170     wxSYS_ICON_Y,             //!< The default height of an icon.
 171     wxSYS_ICONSPACING_X,      //!< Width of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged.
 172     wxSYS_ICONSPACING_Y,      //!< Height of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged.
 173     wxSYS_WINDOWMIN_X,        //!< Minimum width of a window.
 174     wxSYS_WINDOWMIN_Y,        //!< Minimum height of a window.
 175     wxSYS_SCREEN_X,           //!< Width of the screen in pixels.
 176     wxSYS_SCREEN_Y,           //!< Height of the screen in pixels.
 177     wxSYS_FRAMESIZE_X,        //!< Width of the window frame for a wxTHICK_FRAME window.
 178     wxSYS_FRAMESIZE_Y,        //!< Height of the window frame for a wxTHICK_FRAME window.
 179     wxSYS_SMALLICON_X,        //!< Recommended width of a small icon (in window captions, and small icon view).
 180     wxSYS_SMALLICON_Y,        //!< Recommended height of a small icon (in window captions, and small icon view).
 181     wxSYS_HSCROLL_Y,          //!< Height of horizontal scrollbar in pixels.
 182     wxSYS_VSCROLL_X,          //!< Width of vertical scrollbar in pixels.
 183     wxSYS_VSCROLL_ARROW_X,    //!< Width of arrow bitmap on a vertical scrollbar.
 184     wxSYS_VSCROLL_ARROW_Y,    //!< Height of arrow bitmap on a vertical scrollbar.
 185     wxSYS_VTHUMB_Y,           //!< Height of vertical scrollbar thumb.
 186     wxSYS_CAPTION_Y,          //!< Height of normal caption area.
 187     wxSYS_MENU_Y,             //!< Height of single-line menu bar.
 188     wxSYS_NETWORK_PRESENT,    //!< 1 if there is a network present, 0 otherwise.
 189     wxSYS_PENWINDOWS_PRESENT, //!< 1 if PenWindows is installed, 0 otherwise.
 190     wxSYS_SHOW_SOUNDS,        //!< Non-zero if the user requires an application to present information
 191                               //!< visually in situations where it would otherwise present the information
 192                               //!< only in audible form; zero otherwise.
 193     wxSYS_SWAP_BUTTONS,       //!< Non-zero if the meanings of the left and right mouse buttons are swapped; zero otherwise.
 194     wxSYS_DCLICK_MSEC         //!< Maximal time, in milliseconds, which may pass between subsequent clicks for a double click to be generated.
 195 };
 196
 197 /**
 198     Possible values for wxSystemSettings::HasFeature() parameter.
 199 */
 200 enum wxSystemFeature
 201 {
 202     wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1,
 203     wxSYS_CAN_ICONIZE_FRAME,
 204     wxSYS_TABLET_PRESENT
 205 };
 206
 207 /**
 208     Values for different screen designs. See wxSystemSettings::GetScreenType().
 209 */
 210 enum wxSystemScreenType
 211 {
 212     wxSYS_SCREEN_NONE = 0,  //!< Undefined screen type.
 213
 214     wxSYS_SCREEN_TINY,      //!< Tiny screen, less than 320x240
 215     wxSYS_SCREEN_PDA,       //!< PDA screen, 320x240 or more but less than 640x480
 216     wxSYS_SCREEN_SMALL,     //!< Small screen, 640x480 or more but less than 800x600
 217     wxSYS_SCREEN_DESKTOP    //!< Desktop screen, 800x600 or more
 218 };
 219
 220
 221 /**
 222     @class wxSystemSettings
 223
 224     wxSystemSettings allows the application to ask for details about the system.
 225
 226     This can include settings such as standard colours, fonts, and user interface
 227     element sizes.
 228
 229     @library{wxcore}
 230     @category{cfg}
 231
 232     @see wxFont, wxColour, wxSystemOptions
 233 */
 234 class wxSystemSettings : public wxObject
 235 {
 236 public:
 237     /**
 238         Default constructor.
 239
 240         You don't need to create an instance of wxSystemSettings
 241         since all of its functions are static.
 242     */
 243     wxSystemSettings();
 244
 245     /**
 246         Returns a system colour.
 247
 248         @param index
 249             Can be one of the ::wxSystemColour enum values.
 250
 251         @return
 252             The returned colour is always valid.
 253     */
 254     static wxColour GetColour(wxSystemColour index);
 255
 256     /**
 257         Returns a system font.
 258
 259         @param index
 260             Can be one of the ::wxSystemFont enum values.
 261
 262         @return
 263             The returned font is always valid.
 264     */
 265     static wxFont GetFont(wxSystemFont index);
 266
 267     /**
 268         Returns the value of a system metric, or -1 if the metric is not supported on
 269         the current system.
 270
 271         The value of @a win determines if the metric returned is a global value or
 272         a wxWindow based value, in which case it might determine the widget, the
 273         display the window is on, or something similar. The window given should be as
 274         close to the metric as possible (e.g. a wxTopLevelWindow in case of the
 275         wxSYS_CAPTION_Y metric).
 276
 277         @a index can be one of the ::wxSystemMetric enum values.
 278
 279         @a win is a pointer to the window for which the metric is requested.
 280         Specifying the @a win parameter is encouraged, because some metrics on some
 281         ports are not supported without one,or they might be capable of reporting
 282         better values if given one. If a window does not make sense for a metric,
 283         one should still be given, as for example it might determine which displays
 284         cursor width is requested with wxSYS_CURSOR_X.
 285     */
 286     static int GetMetric(wxSystemMetric index, wxWindow* win = NULL);
 287
 288     /**
 289         Returns the screen type.
 290         The return value is one of the ::wxSystemScreenType enum values.
 291     */
 292     static wxSystemScreenType GetScreenType();
 293
 294     /**
 295         Returns @true if the port has certain feature.
 296         See the ::wxSystemFeature enum values.
 297     */
 298     static bool HasFeature(wxSystemFeature index);
 299 };
 300