Make storing non-trivial data in wxThreadSpecificInfo possible.

[wxWidgets.git] / interface / wx / settings.h

diff --git a/interface/wx/settings.h b/interface/wx/settings.h
index 7b2ebc087a80947098f6a062c1b334f8724b5063..b6959a9553ab000ae85979959dbed2fbf900c8f6 100644 (file)
--- a/interface/wx/settings.h
+++ b/interface/wx/settings.h
@@ -2,8 +2,7 @@
 // Name:        settings.h
 // Purpose:     interface of wxSystemSettings
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -75,7 +74,7 @@ enum wxSystemColour
     wxSYS_COLOUR_3DLIGHT,             //!< Light colour for three-dimensional display elements.
     wxSYS_COLOUR_INFOTEXT,            //!< Text colour for tooltip controls.
     wxSYS_COLOUR_INFOBK,              //!< Background colour for tooltip controls.
-    wxSYS_COLOUR_LISTBOX,             //!< Background colour for list-like contols.
+    wxSYS_COLOUR_LISTBOX,             //!< Background colour for list-like controls.
     wxSYS_COLOUR_HOTLIGHT,            //!< Colour for a hyperlink or hot-tracked item.
 
     /**
@@ -109,6 +108,13 @@ enum wxSystemColour
      */
     wxSYS_COLOUR_LISTBOXTEXT,
 
+    /**
+        Text colour for the unfocused selection of list-like controls.
+
+        @since 2.9.1
+     */
+    wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT,
+
     wxSYS_COLOUR_MAX
 
 
@@ -129,7 +135,7 @@ enum wxSystemColour
         //!< Synonym for @c wxSYS_COLOUR_BTNHIGHLIGHT.
 
     /**
-        Synonim for @c wxSYS_COLOUR_BTNFACE.
+        Synonym for @c wxSYS_COLOUR_BTNFACE.
 
         On wxMSW this colour should be used as the background colour of
         wxFrames which are used as containers of controls; this is in fact the
@@ -153,7 +159,6 @@ enum wxSystemMetric
     wxSYS_CURSOR_Y,           //!< Height of cursor.
     wxSYS_DCLICK_X,           //!< Width in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click.
     wxSYS_DCLICK_Y,           //!< Height in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click.
-    wxSYS_DCLICK_MSEC,        //!< Maximal time, in milliseconds, which may pass between subsequent clicks for a double click to be generated.
     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.
     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.
     wxSYS_EDGE_X,             //!< Width of a 3D border, in pixels.
@@ -186,7 +191,7 @@ enum wxSystemMetric
                               //!< visually in situations where it would otherwise present the information
                               //!< only in audible form; zero otherwise.
     wxSYS_SWAP_BUTTONS,       //!< Non-zero if the meanings of the left and right mouse buttons are swapped; zero otherwise.
-    wxSYS_DCLICK_MSEC
+    wxSYS_DCLICK_MSEC         //!< Maximal time, in milliseconds, which may pass between subsequent clicks for a double click to be generated.
 };
 
 /**
@@ -217,8 +222,9 @@ enum wxSystemScreenType
     @class wxSystemSettings
 
     wxSystemSettings allows the application to ask for details about the system.
-    This can include settings such as standard colours, fonts,
-    and user interface element sizes.
+
+    This can include settings such as standard colours, fonts, and user interface 
+    element sizes.
 
     @library{wxcore}
     @category{cfg}
@@ -238,13 +244,23 @@ public:
 
     /**
         Returns a system colour.
-        @a index can be one of the ::wxSystemColour enum values.
+
+        @param index 
+            Can be one of the ::wxSystemColour enum values.
+            
+        @return
+            The returned colour is always valid.
     */
     static wxColour GetColour(wxSystemColour index);
 
     /**
         Returns a system font.
-        @a index can be one of the ::wxSystemFont enum values.
+
+        @param index 
+            Can be one of the ::wxSystemFont enum values.
+            
+        @return
+            The returned font is always valid.
     */
     static wxFont GetFont(wxSystemFont index);
 
@@ -255,7 +271,7 @@ public:
         The value of @a win determines if the metric returned is a global value or
         a wxWindow based value, in which case it might determine the widget, the
         display the window is on, or something similar. The window given should be as
-        close to the metric as possible (e.g a wxTopLevelWindow in case of the
+        close to the metric as possible (e.g. a wxTopLevelWindow in case of the
         wxSYS_CAPTION_Y metric).
 
         @a index can be one of the ::wxSystemMetric enum values.