Add @onlyfor tag to wxToolBar::SetBitmapResource() documentation.

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

diff --git a/interface/wx/defs.h b/interface/wx/defs.h
index 1e3dbc59db0323137eeea358848fdf2d43ee43c6..33b3e5af06c575ea612ff55de8e0af5ad0a1906f 100644 (file)
--- a/interface/wx/defs.h
+++ b/interface/wx/defs.h
@@ -398,14 +398,12 @@ enum wxBorder
 /*  Old names for compatibility */
 #define wxRA_HORIZONTAL     wxHORIZONTAL
 #define wxRA_VERTICAL       wxVERTICAL
 /*  Old names for compatibility */
 #define wxRA_HORIZONTAL     wxHORIZONTAL
 #define wxRA_VERTICAL       wxVERTICAL

-#define wxRA_USE_CHECKBOX   0x0010 /* alternative native subcontrols (wxPalmOS) */

 
 /*
  * wxRadioButton style flag
  */
 #define wxRB_GROUP          0x0004
 #define wxRB_SINGLE         0x0008
 
 /*
  * wxRadioButton style flag
  */
 #define wxRB_GROUP          0x0004
 #define wxRB_SINGLE         0x0008

-#define wxRB_USE_CHECKBOX   0x0010 /* alternative native control (wxPalmOS) */

 
 /*
  * wxScrollBar flags
 
 /*
  * wxScrollBar flags


@@ -479,12 +477,12 @@ enum wxBorder
 #define wxICON_STOP             wxICON_HAND
 #define wxICON_ASTERISK         wxICON_INFORMATION
 
 #define wxICON_STOP             wxICON_HAND
 #define wxICON_ASTERISK         wxICON_INFORMATION
 

-#define  wxFORWARD              0x00001000
-#define  wxBACKWARD             0x00002000
-#define  wxRESET                0x00004000
-#define  wxHELP                 0x00008000
-#define  wxMORE                 0x00010000
-#define  wxSETUP                0x00020000
+#define wxHELP                  0x00001000
+#define wxFORWARD               0x00002000
+#define wxBACKWARD              0x00004000
+#define wxRESET                 0x00008000
+#define wxMORE                  0x00010000
+#define wxSETUP                 0x00020000

 #define wxICON_NONE             0x00040000
 
 #define wxICON_MASK \
 #define wxICON_NONE             0x00040000
 
 #define wxICON_MASK \


@@ -548,9 +546,14 @@ enum wxBackgroundStyle
     /* this style is deprecated and doesn't do anything, don't use */
     wxBG_STYLE_COLOUR,
 
     /* this style is deprecated and doesn't do anything, don't use */
     wxBG_STYLE_COLOUR,
 

-    /* this is a Mac-only style, don't use in portable code */
-    wxBG_STYLE_TRANSPARENT,
+    /**
+        Indicates that the window background is not erased, letting the parent
+        window show through.

 
 

+        Currently this style is only supported in wxOSX and wxGTK with
+        compositing available, see wxWindow::IsTransparentBackgroundSupported().
+     */
+    wxBG_STYLE_TRANSPARENT,

 };
 
 
 };
 
 


@@ -886,7 +889,19 @@ enum wxKeyCode
     WXK_CLEAR,
     WXK_SHIFT,
     WXK_ALT,
     WXK_CLEAR,
     WXK_SHIFT,
     WXK_ALT,

+    /** Note that under Mac OS X, to improve compatibility with other
+      * systems, 'WXK_CONTROL' represents the 'Command' key. Use this
+      * constant to work with keyboard shortcuts. See 'WXK_RAW_CONTROL'
+      * to get the state of the actual 'Control' key.
+      */

     WXK_CONTROL,
     WXK_CONTROL,

+    /** Under Mac OS X, where the 'Command' key is mapped to 'Control'
+      * to improve compatibility with other systems, WXK_RAW_CONTROL may
+      * be used to obtain the state of the actual 'Control' key
+      * ('WXK_CONTROL' would obtain the status of the 'Command' key).
+      * Under Windows/Linux/Others, this is equivalent to WXK_CONTROL
+      */
+    WXK_RAW_CONTROL,

     WXK_MENU,
     WXK_PAUSE,
     WXK_CAPITAL,
     WXK_MENU,
     WXK_PAUSE,
     WXK_CAPITAL,


@@ -977,6 +992,11 @@ enum wxKeyCode
     WXK_WINDOWS_LEFT,
     WXK_WINDOWS_RIGHT,
     WXK_WINDOWS_MENU ,
     WXK_WINDOWS_LEFT,
     WXK_WINDOWS_RIGHT,
     WXK_WINDOWS_MENU ,

+    
+    /** This special key code was used to represent the key used for keyboard shortcuts. Under Mac OS X,
+      * this key maps to the 'Command' (aka logo or 'Apple') key, whereas on Linux/Windows/others
+      * this is the Control key, with the new semantic of WXK_CONTROL, WXK_COMMAND is not needed anymore
+      */

     WXK_COMMAND,
 
     /** Hardware-specific buttons */
     WXK_COMMAND,
 
     /** Hardware-specific buttons */