Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/settings.h b/include/wx/settings.h
index 4ec32c1b0300c87187c33dd4c98b52f16bff0a0b..d9c2dd40490d35aa7d9675c16a3eb79b1380226f 100644 (file)
--- a/include/wx/settings.h
+++ b/include/wx/settings.h
@@ -28,8 +28,15 @@ enum wxSystemFont
     wxSYS_ANSI_VAR_FONT,
     wxSYS_SYSTEM_FONT,
     wxSYS_DEVICE_DEFAULT_FONT,
+
+    // don't use: this is here just to make the values of enum elements
+    // coincide with the corresponding MSW constants
     wxSYS_DEFAULT_PALETTE,
+
+    // don't use: MSDN says that this is a stock object provided only
+    // for compatibility with 16-bit Windows versions earlier than 3.0!
     wxSYS_SYSTEM_FIXED_FONT,
+
     wxSYS_DEFAULT_GUI_FONT,
 
     // this was just a temporary aberration, do not use it any more
@@ -43,8 +50,7 @@ enum wxSystemFont
 enum wxSystemColour
 {
     wxSYS_COLOUR_SCROLLBAR,
-    wxSYS_COLOUR_BACKGROUND,
-    wxSYS_COLOUR_DESKTOP = wxSYS_COLOUR_BACKGROUND,
+    wxSYS_COLOUR_DESKTOP,
     wxSYS_COLOUR_ACTIVECAPTION,
     wxSYS_COLOUR_INACTIVECAPTION,
     wxSYS_COLOUR_MENU,
@@ -59,16 +65,11 @@ enum wxSystemColour
     wxSYS_COLOUR_HIGHLIGHT,
     wxSYS_COLOUR_HIGHLIGHTTEXT,
     wxSYS_COLOUR_BTNFACE,
-    wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
     wxSYS_COLOUR_BTNSHADOW,
-    wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
     wxSYS_COLOUR_GRAYTEXT,
     wxSYS_COLOUR_BTNTEXT,
     wxSYS_COLOUR_INACTIVECAPTIONTEXT,
     wxSYS_COLOUR_BTNHIGHLIGHT,
-    wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
-    wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
-    wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
     wxSYS_COLOUR_3DDKSHADOW,
     wxSYS_COLOUR_3DLIGHT,
     wxSYS_COLOUR_INFOTEXT,
@@ -79,8 +80,19 @@ enum wxSystemColour
     wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
     wxSYS_COLOUR_MENUHILIGHT,
     wxSYS_COLOUR_MENUBAR,
+    wxSYS_COLOUR_LISTBOXTEXT,
+    wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT,
 
-    wxSYS_COLOUR_MAX
+    wxSYS_COLOUR_MAX,
+
+    // synonyms
+    wxSYS_COLOUR_BACKGROUND = wxSYS_COLOUR_DESKTOP,
+    wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
+    wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
+    wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
+    wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
+    wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
+    wxSYS_COLOUR_FRAMEBK = wxSYS_COLOUR_BTNFACE
 };
 
 // possible values for wxSystemSettings::GetMetric() index parameter
@@ -187,6 +199,10 @@ public:
     // system ones, otherwise wxSystemSettings is just the same as
     // wxSystemSettingsNative
     static wxColour GetColour(wxSystemColour index);
+
+    // some metrics are toolkit-dependent and provided by wxUniv, some are
+    // lowlevel
+    static int GetMetric(wxSystemMetric index, wxWindow *win = NULL);
 #endif // __WXUNIVERSAL__
 
     // Get system screen design (desktop, pda, ..) used for