]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/menuitem.h
change longs used for bitmap types to wxBitmapType (#9126)
[wxWidgets.git] / interface / menuitem.h
index e8604c2a537ea4391dc1c1685f35635d8393cb89..dacdc8094dfbc9404c7f14a7f7c3485dc252b139 100644 (file)
@@ -27,7 +27,7 @@ class wxMenuItem : public wxObject
 public:
     /**
         Constructs a wxMenuItem object.
-        Menu items can be standard, or "stock menu items'', or custom. For the
+        Menu items can be standard, or "stock menu items", or custom. For the
         standard menu items (such as commands to open a file, exit the program and so
         on, see @ref overview_stockitems "stock items" for the full list) it is enough
         to
@@ -47,10 +47,11 @@ public:
         @param parentMenu
             Menu that the menu item belongs to.
         @param id
-            Identifier for this menu item, or wxID_SEPARATOR to indicate a separator.
+            Identifier for this menu item. May be wxID_SEPARATOR, in which case the
+            given kind is ignored and taken to be wxITEM_SEPARATOR instead.
         @param text
             Text for the menu item, as shown on the menu. An accelerator
-            key can be specified using the ampersand '' character. In order to embed an
+            key can be specified using the ampersand " character. In order to embed an
             ampersand character in the menu item text, the ampersand must be doubled.
         @param helpString
             Optional help string that will be shown on the status bar.
@@ -139,10 +140,6 @@ public:
     wxString GetLabel() const;
 
     /**
-        Strips all accelerator characters and mnemonics from the given @e text.
-        For example,
-
-        will return just @c "Hello".
         This function is deprecated; please use GetLabelText() instead.
 
         @see GetText(), GetLabel()
@@ -151,7 +148,11 @@ public:
 
     /**
         Strips all accelerator characters and mnemonics from the given @e text.
-        For example,
+        For example:
+
+        @code
+          wxMenuItem::GetLabelfromText( "&Hello\tCtrl-h");
+        @endcode
 
         will return just @c "Hello".