mac paths updated

[wxWidgets.git] / interface / menuitem.h

diff --git a/interface/menuitem.h b/interface/menuitem.h
index d57a6df0543d30fb750de9ccf5adba608955996d..ba0905efd2b01b62ed73ae12b67f875b295cc6c1 100644 (file)
--- a/interface/menuitem.h
+++ b/interface/menuitem.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        menuitem.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        menuitem.h

-// Purpose:     documentation for wxMenuItem class
+// Purpose:     interface of wxMenuItem

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,70 +9,60 @@
 /**
     @class wxMenuItem
     @wxheader{menuitem.h}
 /**
     @class wxMenuItem
     @wxheader{menuitem.h}

-    
+

     A menu item represents an item in a menu. Note that you usually don't have to
     deal with it directly as wxMenu methods usually construct an
     object of this class for you.
     A menu item represents an item in a menu. Note that you usually don't have to
     deal with it directly as wxMenu methods usually construct an
     object of this class for you.

-    
+

     Also please note that the methods related to fonts and bitmaps are currently
     only implemented for Windows and GTK+.
     Also please note that the methods related to fonts and bitmaps are currently
     only implemented for Windows and GTK+.

-    
+

     @library{wxcore}
     @category{menus}
     @library{wxcore}
     @category{menus}

-    
-    @seealso
-    wxMenuBar, wxMenu
+
+    @see wxMenuBar, wxMenu

 */
 class wxMenuItem : public wxObject
 {
 public:
     /**
         Constructs a wxMenuItem object.
 */
 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
         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
-        specify just the stock ID and leave @e text and @e helpString empty. In
-        fact, leaving at least @e text empty for the stock menu items is strongly
+        on, see @ref page_stockitems "Stock Items" for the full list) it is enough
+        to specify just the stock ID and leave @a text and @a helpString empty. In
+        fact, leaving at least @a text empty for the stock menu items is 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.

-        
-        For the custom (non-stock) menu items, @e text must be specified and while 
-        @e helpString may be left empty, it's recommended to pass the item
+        For the custom (non-stock) menu items, @a text must be specified and while
+        @a helpString may be left empty, it's recommended to pass the item

         description (which is automatically shown by the library in the status bar when
         the menu item is selected) in this parameter.
         description (which is automatically shown by the library in the status bar when
         the menu item is selected) in this parameter.

-        

         Finally note that you can e.g. use a stock menu label without using its stock
         Finally note that you can e.g. use a stock menu label without using its stock

-        help string:
-        that is, stock properties are set independently one from the other.
-        
-        @param parentMenu 
-        Menu that the menu item belongs to.
-        
-        @param id 
-        Identifier for this menu item, or wxID_SEPARATOR to indicate a separator.
-        
-        @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
-        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.
-        
-        @param kind 
-        May be wxITEM_SEPARATOR, wxITEM_NORMAL, 
-        wxITEM_CHECK or wxITEM_RADIO
-        
-        @param subMenu 
-        If non-@NULL, indicates that the menu item is a submenu.
-    */
-    wxMenuItem(wxMenu* parentMenu = @NULL, int id = wxID_SEPARATOR,
+        help string; that is, stock properties are set independently one from the other.
+
+        @param parentMenu
+            Menu that the menu item belongs to.
+        @param id
+            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
+            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.
+        @param kind
+            May be wxITEM_SEPARATOR, wxITEM_NORMAL,
+            wxITEM_CHECK or wxITEM_RADIO
+        @param subMenu
+            If non-@NULL, indicates that the menu item is a submenu.
+    */
+    wxMenuItem(wxMenu* parentMenu = NULL, int id = wxID_SEPARATOR,

                const wxString& text = "",
                const wxString& helpString = "",
                wxItemKind kind = wxITEM_NORMAL,
                const wxString& text = "",
                const wxString& helpString = "",
                wxItemKind kind = wxITEM_NORMAL,

-               wxMenu* subMenu = @NULL);
+               wxMenu* subMenu = NULL);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -81,162 +71,155 @@ public:
 
     /**
         Checks or unchecks the menu item.
 
     /**
         Checks or unchecks the menu item.

-        

         Note that this only works when the item is already appended to a menu.
     */
         Note that this only works when the item is already appended to a menu.
     */

-    void Check(bool check = @true);
+    void Check(bool check = true);

 
     /**
         Enables or disables the menu item.
     */
 
     /**
         Enables or disables the menu item.
     */

-    void Enable(bool enable = @true);
+    void Enable(bool enable = true);

 
     /**
         Returns the background colour associated with the menu item (Windows only).
     */
 
     /**
         Returns the background colour associated with the menu item (Windows only).
     */

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

 
     /**
         Returns the checked or unchecked bitmap (Windows only).
     */
 
     /**
         Returns the checked or unchecked bitmap (Windows only).
     */

-    wxBitmap GetBitmap(bool checked = @true);
+    wxBitmap GetBitmap(bool checked = true) const;

 
     /**
         Returns the font associated with the menu item (Windows only).
     */
 
     /**
         Returns the font associated with the menu item (Windows only).
     */

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

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

-    wxString GetHelp();
+    wxString GetHelp() const;

 
     /**
         Returns the menu item identifier.
     */
 
     /**
         Returns the menu item identifier.
     */

-    int GetId();
+    int GetId() const;

 
     /**
         Returns the text associated with the menu item including any accelerator
         characters that were passed to the constructor or SetItemLabel.
 
     /**
         Returns the text associated with the menu item including any accelerator
         characters that were passed to the constructor or SetItemLabel.

-        
-        @sa GetItemLabelText(), GetLabelText()
+
+        @see GetItemLabelText(), GetLabelText()

     */
     */

-    wxString GetItemLabel();
+    wxString GetItemLabel() const;

 
     /**
         Returns the text associated with the menu item, without any accelerator
         characters.
 
     /**
         Returns the text associated with the menu item, without any accelerator
         characters.

-        
-        @sa GetItemLabel(), GetLabelText()
+
+        @see GetItemLabel(), GetLabelText()

     */
     */

-    wxString GetItemLabelText();
+    wxString GetItemLabelText() const;

 
     /**
 
     /**

-        Returns the item kind, one of @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, 
+        Returns the item kind, one of @c wxITEM_SEPARATOR, @c wxITEM_NORMAL,

         @c wxITEM_CHECK or @c wxITEM_RADIO.
     */
         @c wxITEM_CHECK or @c wxITEM_RADIO.
     */

-    wxItemKind GetKind();
+    wxItemKind GetKind() const;

 
     /**
         Returns the text associated with the menu item without any accelerator
         characters it might contain.
 
     /**
         Returns the text associated with the menu item without any accelerator
         characters it might contain.

-        
-        This function is deprecated in favour of GetItemLabelText().
-        
-        @sa GetText(), GetLabelFromText()
+        @deprecated This function is deprecated in favour of GetItemLabelText().
+        @see GetText(), GetLabelFromText()

     */
     */

-    wxString GetLabel();
+    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.
-        
-        @sa GetText(), GetLabel()
+        @deprecated This function is deprecated; please use GetLabelText() instead.
+        @see GetText(), GetLabel()

     */
     static wxString GetLabelFromText(const wxString& text);
 
     /**
         Strips all accelerator characters and mnemonics from the given @e text.
     */
     static wxString GetLabelFromText(const wxString& text);
 
     /**
         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".
         will return just @c "Hello".

-        
-        @sa GetItemLabelText(), GetItemLabel()
+
+        @see GetItemLabelText(), GetItemLabel()

     */
     static wxString GetLabelText(const wxString& text);
 
     /**
         Gets the width of the menu item checkmark bitmap (Windows only).
     */
     */
     static wxString GetLabelText(const wxString& text);
 
     /**
         Gets the width of the menu item checkmark bitmap (Windows only).
     */

-    int GetMarginWidth();
+    int GetMarginWidth() const;

 
     /**
         Returns the menu this menu item is in, or @NULL if this menu item is not
         attached.
     */
 
     /**
         Returns the menu this menu item is in, or @NULL if this menu item is not
         attached.
     */

-    wxMenu* GetMenu();
+    wxMenu* GetMenu() const;

 
     /**
         Returns the text associated with the menu item.
 
     /**
         Returns the text associated with the menu item.

-        
-        @b NB: this function is deprecated, please use 
-        GetItemLabel() or GetItemLabelText() 
-        instead.
+        @deprecated This function is deprecated. Please use
+        GetItemLabel() or GetItemLabelText() instead.

     */
     */

-    wxString GetName();
+    wxString GetName() const;

 
     /**
         Returns the submenu associated with the menu item, or @NULL if there isn't one.
     */
 
     /**
         Returns the submenu associated with the menu item, or @NULL if there isn't one.
     */

-    wxMenu* GetSubMenu();
+    wxMenu* GetSubMenu() const;

 
     /**
         Returns the text associated with the menu item, such as it was passed to the
         wxMenuItem constructor, i.e. with any accelerator characters it may contain.
 
     /**
         Returns the text associated with the menu item, such as it was passed to the
         wxMenuItem constructor, i.e. with any accelerator characters it may contain.

-        
-        This function is deprecated in favour of GetItemLabel().
-        
-        @sa GetLabel(), GetLabelFromText()
+        @deprecated This function is deprecated in favour of GetItemLabel().
+        @see GetLabel(), GetLabelFromText()

     */
     */

-    wxString GetText();
+    wxString GetText() const;

 
     /**
         Returns the text colour associated with the menu item (Windows only).
     */
 
     /**
         Returns the text colour associated with the menu item (Windows only).
     */

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

 
     /**
         Returns @true if the item is checkable.
     */
 
     /**
         Returns @true if the item is checkable.
     */

-    bool IsCheckable();
+    bool IsCheckable() const;

 
     /**
         Returns @true if the item is checked.
     */
 
     /**
         Returns @true if the item is checked.
     */

-    bool IsChecked();
+    bool IsChecked() const;

 
     /**
         Returns @true if the item is enabled.
     */
 
     /**
         Returns @true if the item is enabled.
     */

-    bool IsEnabled();
+    bool IsEnabled() const;

 
     /**
         Returns @true if the item is a separator.
     */
 
     /**
         Returns @true if the item is a separator.
     */

-    bool IsSeparator();
+    bool IsSeparator() const;

 
     /**
         Returns @true if the item is a submenu.
     */
 
     /**
         Returns @true if the item is a submenu.
     */

-    bool IsSubMenu();
+    bool IsSubMenu() const;

 
     /**
         Sets the background colour associated with the menu item (Windows only).
     */
 
     /**
         Sets the background colour associated with the menu item (Windows only).
     */

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

 
     /**
         Sets the bitmap for the menu item (Windows and GTK+ only). It is
 
     /**
         Sets the bitmap for the menu item (Windows and GTK+ only). It is


@@ -270,7 +253,7 @@ public:
     /**
         Sets the width of the menu item checkmark bitmap (Windows only).
     */
     /**
         Sets the width of the menu item checkmark bitmap (Windows only).
     */

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

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


@@ -284,8 +267,7 @@ public:
 
     /**
         Sets the text associated with the menu item.
 
     /**
         Sets the text associated with the menu item.

-        
-        This function is deprecated in favour of SetItemLabel().
+        @deprecated This function is deprecated in favour of SetItemLabel().

     */
     void SetText(const wxString& text);
 
     */
     void SetText(const wxString& text);
 


@@ -294,3 +276,4 @@ public:
     */
     void SetTextColour(const wxColour& colour);
 };
     */
     void SetTextColour(const wxColour& colour);
 };

+