Make wxTaskBarIcon's ctor have the same API on all platforms even though setting...

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

diff --git a/interface/wx/menuitem.h b/interface/wx/menuitem.h
index b6c8cfdc32708f69d7b2cd2ca3d3ab60e1d2c43e..c0e16ffbc302eb01ef6e91ac24f350db0eb1667c 100644 (file)
--- a/interface/wx/menuitem.h
+++ b/interface/wx/menuitem.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxMenu, wxMenuItem
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxMenu, wxMenuItem
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -55,8 +55,10 @@ public:
         For the standard menu items (such as commands to open a file, exit the
         program and so on, see @ref page_stockitems for the full list) it is enough
         to specify just the stock ID and leave @a text and @a helpString empty.
         For the standard menu items (such as commands to open a file, exit the
         program and so on, see @ref page_stockitems for the full list) it is enough
         to specify just the stock ID and leave @a text and @a helpString empty.

+        Some platforms (currently wxGTK only, and see the remark in SetBitmap()
+        documentation) will also show standard bitmaps for stock menu items.

 
 

-        In fact, leaving at least @a text empty for the stock menu items is strongly
+        Leaving at least @a text empty for the stock menu items is actually strongly

         recommended as they will have appearance and keyboard interface (including
         standard accelerators) familiar to the user.
 
         recommended as they will have appearance and keyboard interface (including
         standard accelerators) familiar to the user.
 


@@ -73,7 +75,7 @@ public:
         helpMenu->Append(wxID_ABOUT);
 
         // use the stock label and the stock accelerator but not the stock help string:
         helpMenu->Append(wxID_ABOUT);
 
         // use the stock label and the stock accelerator but not the stock help string:

-        helpMenu->Append(wxID_ABOUT, wxEmptyString, "My custom help string");
+        helpMenu->Append(wxID_ABOUT, "", "My custom help string");

 
         // use all stock properties except for the bitmap:
         wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT);
 
         // use all stock properties except for the bitmap:
         wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT);


@@ -155,7 +157,7 @@ public:
         
         @onlyfor{wxmsw}
     */
         
         @onlyfor{wxmsw}
     */

-    wxColour GetBackgroundColour() const;
+    wxColour& GetBackgroundColour() const;

 
     /**
         Returns the checked or unchecked bitmap.
 
     /**
         Returns the checked or unchecked bitmap.


@@ -169,7 +171,7 @@ public:
         
         @onlyfor{wxmsw}
     */
         
         @onlyfor{wxmsw}
     */

-    wxFont GetFont() const;
+    wxFont& GetFont() const;

 
     /**
         Returns the help string associated with the menu item.
 
     /**
         Returns the help string associated with the menu item.


@@ -255,7 +257,7 @@ public:
         
         @onlyfor{wxmsw}
     */
         
         @onlyfor{wxmsw}
     */

-    wxColour GetTextColour() const;
+    wxColour& GetTextColour() const;

     
     //@}
     
     
     //@}
     


@@ -305,7 +307,7 @@ public:
         
         @onlyfor{wxmsw}
     */
         
         @onlyfor{wxmsw}
     */

-    void SetBackgroundColour(const wxColour& colour) const;
+    void SetBackgroundColour(const wxColour& colour);

 
     /**
         Sets the bitmap for the menu item.
 
     /**
         Sets the bitmap for the menu item.


@@ -347,7 +349,7 @@ public:
     /**
         Sets the label associated with the menu item.
         
     /**
         Sets the label associated with the menu item.
         

-        Note that if the ID of this menu item corrisponds to a stock ID, then it is 
+        Note that if the ID of this menu item corresponds to a stock ID, then it is 

         not necessary to specify a label: wxWidgets will automatically use the stock
         item label associated with that ID. See the @ref wxMenuItem::wxMenuItem "constructor"
         for more info.
         not necessary to specify a label: wxWidgets will automatically use the stock
         item label associated with that ID. See the @ref wxMenuItem::wxMenuItem "constructor"
         for more info.


@@ -367,6 +369,7 @@ public:
         (from F1 to F12) or one of the special characters listed in the table
         below (again, case doesn't matter):
         - @c DEL or @c DELETE: Delete key
         (from F1 to F12) or one of the special characters listed in the table
         below (again, case doesn't matter):
         - @c DEL or @c DELETE: Delete key

+        - @c BACK : Backspace key

         - @c INS or @c INSERT: Insert key
         - @c ENTER or @c RETURN: Enter key
         - @c PGUP: PageUp key
         - @c INS or @c INSERT: Insert key
         - @c ENTER or @c RETURN: Enter key
         - @c PGUP: PageUp key


@@ -399,7 +402,7 @@ public:
         
         @onlyfor{wxmsw}
     */
         
         @onlyfor{wxmsw}
     */

-    void SetMarginWidth(int width) const;
+    void SetMarginWidth(int width);

 
     /**
         Sets the parent menu which will contain this menu item.
 
     /**
         Sets the parent menu which will contain this menu item.