]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/settings.h
added native GTK implementation of wxCalendarCtrl (modified patch 1925439)
[wxWidgets.git] / interface / settings.h
index 2ccb88d62da3b76c10019008f333cbc688c49df0..83fff83f18319ea64a682cad64b84f459b38d464 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        settings.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        settings.h
-// Purpose:     documentation for wxSystemSettings class
+// Purpose:     interface of wxSystemSettings
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -17,8 +17,7 @@
     @library{wxcore}
     @category{misc}
 
     @library{wxcore}
     @category{misc}
 
-    @seealso
-    wxFont, wxColour
+    @see wxFont, wxColour
 */
 class wxSystemSettings : public wxObject
 {
 */
 class wxSystemSettings : public wxObject
 {
@@ -32,129 +31,129 @@ public:
     /**
         Returns a system colour.
         @a index can be one of:
     /**
         Returns a system colour.
         @a index can be one of:
-        
+
         @b wxSYS_COLOUR_SCROLLBAR
         @b wxSYS_COLOUR_SCROLLBAR
-        
+
         The scrollbar grey area.
         The scrollbar grey area.
-        
+
         @b wxSYS_COLOUR_BACKGROUND
         @b wxSYS_COLOUR_BACKGROUND
-        
+
         The desktop colour.
         The desktop colour.
-        
+
         @b wxSYS_COLOUR_ACTIVECAPTION
         @b wxSYS_COLOUR_ACTIVECAPTION
-        
+
         Active window caption.
         Active window caption.
-        
+
         @b wxSYS_COLOUR_INACTIVECAPTION
         @b wxSYS_COLOUR_INACTIVECAPTION
-        
+
         Inactive window caption.
         Inactive window caption.
-        
+
         @b wxSYS_COLOUR_MENU
         @b wxSYS_COLOUR_MENU
-        
+
         Menu background.
         Menu background.
-        
+
         @b wxSYS_COLOUR_WINDOW
         @b wxSYS_COLOUR_WINDOW
-        
+
         Window background.
         Window background.
-        
+
         @b wxSYS_COLOUR_WINDOWFRAME
         @b wxSYS_COLOUR_WINDOWFRAME
-        
+
         Window frame.
         Window frame.
-        
+
         @b wxSYS_COLOUR_MENUTEXT
         @b wxSYS_COLOUR_MENUTEXT
-        
+
         Menu text.
         Menu text.
-        
+
         @b wxSYS_COLOUR_WINDOWTEXT
         @b wxSYS_COLOUR_WINDOWTEXT
-        
+
         Text in windows.
         Text in windows.
-        
+
         @b wxSYS_COLOUR_CAPTIONTEXT
         @b wxSYS_COLOUR_CAPTIONTEXT
-        
+
         Text in caption, size box and scrollbar arrow box.
         Text in caption, size box and scrollbar arrow box.
-        
+
         @b wxSYS_COLOUR_ACTIVEBORDER
         @b wxSYS_COLOUR_ACTIVEBORDER
-        
+
         Active window border.
         Active window border.
-        
+
         @b wxSYS_COLOUR_INACTIVEBORDER
         @b wxSYS_COLOUR_INACTIVEBORDER
-        
+
         Inactive window border.
         Inactive window border.
-        
+
         @b wxSYS_COLOUR_APPWORKSPACE
         @b wxSYS_COLOUR_APPWORKSPACE
-        
+
         Background colour MDI applications.
         Background colour MDI applications.
-        
+
         @b wxSYS_COLOUR_HIGHLIGHT
         @b wxSYS_COLOUR_HIGHLIGHT
-        
+
         Item(s) selected in a control.
         Item(s) selected in a control.
-        
+
         @b wxSYS_COLOUR_HIGHLIGHTTEXT
         @b wxSYS_COLOUR_HIGHLIGHTTEXT
-        
+
         Text of item(s) selected in a control.
         Text of item(s) selected in a control.
-        
+
         @b wxSYS_COLOUR_BTNFACE
         @b wxSYS_COLOUR_BTNFACE
-        
+
         Face shading on push buttons.
         Face shading on push buttons.
-        
+
         @b wxSYS_COLOUR_BTNSHADOW
         @b wxSYS_COLOUR_BTNSHADOW
-        
+
         Edge shading on push buttons.
         Edge shading on push buttons.
-        
+
         @b wxSYS_COLOUR_GRAYTEXT
         @b wxSYS_COLOUR_GRAYTEXT
-        
+
         Greyed (disabled) text.
         Greyed (disabled) text.
-        
+
         @b wxSYS_COLOUR_BTNTEXT
         @b wxSYS_COLOUR_BTNTEXT
-        
+
         Text on push buttons.
         Text on push buttons.
-        
+
         @b wxSYS_COLOUR_INACTIVECAPTIONTEXT
         @b wxSYS_COLOUR_INACTIVECAPTIONTEXT
-        
+
         Colour of text in active captions.
         Colour of text in active captions.
-        
+
         @b wxSYS_COLOUR_BTNHIGHLIGHT
         @b wxSYS_COLOUR_BTNHIGHLIGHT
-        
+
         Highlight colour for buttons (same as wxSYS_COLOUR_3DHILIGHT).
         Highlight colour for buttons (same as wxSYS_COLOUR_3DHILIGHT).
-        
+
         @b wxSYS_COLOUR_3DDKSHADOW
         @b wxSYS_COLOUR_3DDKSHADOW
-        
+
         Dark shadow for three-dimensional display elements.
         Dark shadow for three-dimensional display elements.
-        
+
         @b wxSYS_COLOUR_3DLIGHT
         @b wxSYS_COLOUR_3DLIGHT
-        
+
         Light colour for three-dimensional display elements.
         Light colour for three-dimensional display elements.
-        
+
         @b wxSYS_COLOUR_INFOTEXT
         @b wxSYS_COLOUR_INFOTEXT
-        
+
         Text colour for tooltip controls.
         Text colour for tooltip controls.
-        
+
         @b wxSYS_COLOUR_INFOBK
         @b wxSYS_COLOUR_INFOBK
-        
+
         Background colour for tooltip controls.
         Background colour for tooltip controls.
-        
+
         @b wxSYS_COLOUR_DESKTOP
         @b wxSYS_COLOUR_DESKTOP
-        
+
         Same as wxSYS_COLOUR_BACKGROUND.
         Same as wxSYS_COLOUR_BACKGROUND.
-        
+
         @b wxSYS_COLOUR_3DFACE
         @b wxSYS_COLOUR_3DFACE
-        
+
         Same as wxSYS_COLOUR_BTNFACE.
         Same as wxSYS_COLOUR_BTNFACE.
-        
+
         @b wxSYS_COLOUR_3DSHADOW
         @b wxSYS_COLOUR_3DSHADOW
-        
+
         Same as wxSYS_COLOUR_BTNSHADOW.
         Same as wxSYS_COLOUR_BTNSHADOW.
-        
+
         @b wxSYS_COLOUR_3DHIGHLIGHT
         @b wxSYS_COLOUR_3DHIGHLIGHT
-        
+
         Same as wxSYS_COLOUR_BTNHIGHLIGHT.
         Same as wxSYS_COLOUR_BTNHIGHLIGHT.
-        
+
         @b wxSYS_COLOUR_3DHILIGHT
         @b wxSYS_COLOUR_3DHILIGHT
-        
+
         Same as wxSYS_COLOUR_BTNHIGHLIGHT.
         Same as wxSYS_COLOUR_BTNHIGHLIGHT.
-        
+
         @b wxSYS_COLOUR_BTNHILIGHT
         @b wxSYS_COLOUR_BTNHILIGHT
-        
+
         Same as wxSYS_COLOUR_BTNHIGHLIGHT.
     */
     static wxColour GetColour(wxSystemColour index);
         Same as wxSYS_COLOUR_BTNHIGHLIGHT.
     */
     static wxColour GetColour(wxSystemColour index);
@@ -162,29 +161,29 @@ public:
     /**
         Returns a system font.
         @a index can be one of:
     /**
         Returns a system font.
         @a index can be one of:
-        
+
         @b wxSYS_OEM_FIXED_FONT
         @b wxSYS_OEM_FIXED_FONT
-        
+
         Original equipment manufacturer dependent fixed-pitch font.
         Original equipment manufacturer dependent fixed-pitch font.
-        
+
         @b wxSYS_ANSI_FIXED_FONT
         @b wxSYS_ANSI_FIXED_FONT
-        
+
         Windows fixed-pitch font.
         Windows fixed-pitch font.
-        
+
         @b wxSYS_ANSI_VAR_FONT
         @b wxSYS_ANSI_VAR_FONT
-        
+
         Windows variable-pitch (proportional) font.
         Windows variable-pitch (proportional) font.
-        
+
         @b wxSYS_SYSTEM_FONT
         @b wxSYS_SYSTEM_FONT
-        
+
         System font.
         System font.
-        
+
         @b wxSYS_DEVICE_DEFAULT_FONT
         @b wxSYS_DEVICE_DEFAULT_FONT
-        
+
         Device-dependent font (Windows NT only).
         Device-dependent font (Windows NT only).
-        
+
         @b wxSYS_DEFAULT_GUI_FONT
         @b wxSYS_DEFAULT_GUI_FONT
-        
+
         Default font for user interface
         objects such as menus and dialog boxes. Note that with modern GUIs nothing
         guarantees that the same font is used for all GUI elements, so some controls
         Default font for user interface
         objects such as menus and dialog boxes. Note that with modern GUIs nothing
         guarantees that the same font is used for all GUI elements, so some controls
@@ -202,172 +201,172 @@ public:
         metric as possible (e.g a wxTopLevelWindow in case of the wxSYS_CAPTION_Y
         metric).
         @a index can be one of:
         metric as possible (e.g a wxTopLevelWindow in case of the wxSYS_CAPTION_Y
         metric).
         @a index can be one of:
-        
+
         @b wxSYS_MOUSE_BUTTONS
         @b wxSYS_MOUSE_BUTTONS
-        
+
         Number of buttons on mouse, or zero if no mouse was installed.
         Number of buttons on mouse, or zero if no mouse was installed.
-        
+
         @b wxSYS_BORDER_X
         @b wxSYS_BORDER_X
-        
+
         Width of single border.
         Width of single border.
-        
+
         @b wxSYS_BORDER_Y
         @b wxSYS_BORDER_Y
-        
+
         Height of single border.
         Height of single border.
-        
+
         @b wxSYS_CURSOR_X
         @b wxSYS_CURSOR_X
-        
+
         Width of cursor.
         Width of cursor.
-        
+
         @b wxSYS_CURSOR_Y
         @b wxSYS_CURSOR_Y
-        
+
         Height of cursor.
         Height of cursor.
-        
+
         @b wxSYS_DCLICK_X
         @b wxSYS_DCLICK_X
-        
+
         Width in pixels of rectangle within which two successive mouse
         clicks must fall to generate a double-click.
         Width in pixels of rectangle within which two successive mouse
         clicks must fall to generate a double-click.
-        
+
         @b wxSYS_DCLICK_Y
         @b wxSYS_DCLICK_Y
-        
+
         Height in pixels of rectangle within which two successive mouse
         clicks must fall to generate a double-click.
         Height in pixels of rectangle within which two successive mouse
         clicks must fall to generate a double-click.
-        
+
         @b wxSYS_DCLICK_MSEC
         @b wxSYS_DCLICK_MSEC
-        
+
         Maximal time, in milliseconds, which may
         pass between subsequent clicks for a double click to be generated.
         Maximal time, in milliseconds, which may
         pass between subsequent clicks for a double click to be generated.
-        
+
         @b wxSYS_DRAG_X
         @b 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.
         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.
-        
+
         @b wxSYS_DRAG_Y
         @b 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.
         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.
-        
+
         @b wxSYS_EDGE_X
         @b wxSYS_EDGE_X
-        
+
         Width of a 3D border, in pixels.
         Width of a 3D border, in pixels.
-        
+
         @b wxSYS_EDGE_Y
         @b wxSYS_EDGE_Y
-        
+
         Height of a 3D border, in pixels.
         Height of a 3D border, in pixels.
-        
+
         @b wxSYS_HSCROLL_ARROW_X
         @b wxSYS_HSCROLL_ARROW_X
-        
+
         Width of arrow bitmap on horizontal scrollbar.
         Width of arrow bitmap on horizontal scrollbar.
-        
+
         @b wxSYS_HSCROLL_ARROW_Y
         @b wxSYS_HSCROLL_ARROW_Y
-        
+
         Height of arrow bitmap on horizontal scrollbar.
         Height of arrow bitmap on horizontal scrollbar.
-        
+
         @b wxSYS_HTHUMB_X
         @b wxSYS_HTHUMB_X
-        
+
         Width of horizontal scrollbar thumb.
         Width of horizontal scrollbar thumb.
-        
+
         @b wxSYS_ICON_X
         @b wxSYS_ICON_X
-        
+
         The default width of an icon.
         The default width of an icon.
-        
+
         @b wxSYS_ICON_Y
         @b wxSYS_ICON_Y
-        
+
         The default height of an icon.
         The default height of an icon.
-        
+
         @b wxSYS_ICONSPACING_X
         @b 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.
         Width of a grid cell for items in large icon view,
         in pixels. Each item fits into a rectangle of this size when arranged.
-        
+
         @b wxSYS_ICONSPACING_Y
         @b 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.
         Height of a grid cell for items in large icon view,
         in pixels. Each item fits into a rectangle of this size when arranged.
-        
+
         @b wxSYS_WINDOWMIN_X
         @b wxSYS_WINDOWMIN_X
-        
+
         Minimum width of a window.
         Minimum width of a window.
-        
+
         @b wxSYS_WINDOWMIN_Y
         @b wxSYS_WINDOWMIN_Y
-        
+
         Minimum height of a window.
         Minimum height of a window.
-        
+
         @b wxSYS_SCREEN_X
         @b wxSYS_SCREEN_X
-        
+
         Width of the screen in pixels.
         Width of the screen in pixels.
-        
+
         @b wxSYS_SCREEN_Y
         @b wxSYS_SCREEN_Y
-        
+
         Height of the screen in pixels.
         Height of the screen in pixels.
-        
+
         @b wxSYS_FRAMESIZE_X
         @b wxSYS_FRAMESIZE_X
-        
+
         Width of the window frame for a wxTHICK_FRAME window.
         Width of the window frame for a wxTHICK_FRAME window.
-        
+
         @b wxSYS_FRAMESIZE_Y
         @b wxSYS_FRAMESIZE_Y
-        
+
         Height of the window frame for a wxTHICK_FRAME window.
         Height of the window frame for a wxTHICK_FRAME window.
-        
+
         @b wxSYS_SMALLICON_X
         @b wxSYS_SMALLICON_X
-        
+
         Recommended width of a small icon (in window captions, and small icon view).
         Recommended width of a small icon (in window captions, and small icon view).
-        
+
         @b wxSYS_SMALLICON_Y
         @b wxSYS_SMALLICON_Y
-        
+
         Recommended height of a small icon (in window captions, and small icon view).
         Recommended height of a small icon (in window captions, and small icon view).
-        
+
         @b wxSYS_HSCROLL_Y
         @b wxSYS_HSCROLL_Y
-        
+
         Height of horizontal scrollbar in pixels.
         Height of horizontal scrollbar in pixels.
-        
+
         @b wxSYS_VSCROLL_X
         @b wxSYS_VSCROLL_X
-        
+
         Width of vertical scrollbar in pixels.
         Width of vertical scrollbar in pixels.
-        
+
         @b wxSYS_VSCROLL_ARROW_X
         @b wxSYS_VSCROLL_ARROW_X
-        
+
         Width of arrow bitmap on a vertical scrollbar.
         Width of arrow bitmap on a vertical scrollbar.
-        
+
         @b wxSYS_VSCROLL_ARROW_Y
         @b wxSYS_VSCROLL_ARROW_Y
-        
+
         Height of arrow bitmap on a vertical scrollbar.
         Height of arrow bitmap on a vertical scrollbar.
-        
+
         @b wxSYS_VTHUMB_Y
         @b wxSYS_VTHUMB_Y
-        
+
         Height of vertical scrollbar thumb.
         Height of vertical scrollbar thumb.
-        
+
         @b wxSYS_CAPTION_Y
         @b wxSYS_CAPTION_Y
-        
+
         Height of normal caption area.
         Height of normal caption area.
-        
+
         @b wxSYS_MENU_Y
         @b wxSYS_MENU_Y
-        
+
         Height of single-line menu bar.
         Height of single-line menu bar.
-        
+
         @b wxSYS_NETWORK_PRESENT
         @b wxSYS_NETWORK_PRESENT
-        
+
         1 if there is a network present, 0 otherwise.
         1 if there is a network present, 0 otherwise.
-        
+
         @b wxSYS_PENWINDOWS_PRESENT
         @b wxSYS_PENWINDOWS_PRESENT
-        
+
         1 if PenWindows is installed, 0 otherwise.
         1 if PenWindows is installed, 0 otherwise.
-        
+
         @b wxSYS_SHOW_SOUNDS
         @b wxSYS_SHOW_SOUNDS
-        
+
         Non-zero if the user requires an application to present information visually in
         situations
         where it would otherwise present the information only in audible form; zero
         otherwise.
         Non-zero if the user requires an application to present information visually in
         situations
         where it would otherwise present the information only in audible form; zero
         otherwise.
-        
+
         @b wxSYS_SWAP_BUTTONS
         @b wxSYS_SWAP_BUTTONS
-        
+
         Non-zero if the meanings of the left and right mouse buttons are swapped; zero
         otherwise.
         Non-zero if the meanings of the left and right mouse buttons are swapped; zero
         otherwise.
-        
+
         @a win is a pointer to the window for which the metric is requested.
         Specifying the @a win parameter is encouraged, because some metrics on some
         ports are not supported without one,
         @a win is a pointer to the window for which the metric is requested.
         Specifying the @a win parameter is encouraged, because some metrics on some
         ports are not supported without one,
@@ -381,26 +380,27 @@ public:
 
     /**
         Returns the screen type. The return value is one of:
 
     /**
         Returns the screen type. The return value is one of:
-        
+
         @b wxSYS_SCREEN_NONE
         @b wxSYS_SCREEN_NONE
-        
+
         Undefined screen type
         Undefined screen type
-        
+
         @b wxSYS_SCREEN_TINY
         @b wxSYS_SCREEN_TINY
-        
+
         Tiny screen, less than 320x240
         Tiny screen, less than 320x240
-        
+
         @b wxSYS_SCREEN_PDA
         @b wxSYS_SCREEN_PDA
-        
+
         PDA screen, 320x240 or more but less than 640x480
         PDA screen, 320x240 or more but less than 640x480
-        
+
         @b wxSYS_SCREEN_SMALL
         @b wxSYS_SCREEN_SMALL
-        
+
         Small screen, 640x480 or more but less than 800x600
         Small screen, 640x480 or more but less than 800x600
-        
+
         @b wxSYS_SCREEN_DESKTOP
         @b wxSYS_SCREEN_DESKTOP
-        
+
         Desktop screen, 800x600 or more
     */
     static wxSystemScreenType GetScreenType();
 };
         Desktop screen, 800x600 or more
     */
     static wxSystemScreenType GetScreenType();
 };
+