Correct decoding of 4-byte integers in png2c script.

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

diff --git a/interface/wx/menu.h b/interface/wx/menu.h
index ba8bb6bb55dd557b15d02c275c6e8ce1b9197c61..5cbee4bc0acd2502afb6637550583dd78b46bae0 100644 (file)
--- a/interface/wx/menu.h
+++ b/interface/wx/menu.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxMenuBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxMenuBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

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


@@ -73,7 +73,7 @@ public:
         @param menu
             The menu to add. Do not deallocate this menu after calling Append().
         @param title
         @param menu
             The menu to add. Do not deallocate this menu after calling Append().
         @param title

-            The title of the menu.
+            The title of the menu, must be non-empty.

 
         @return @true on success, @false if an error occurred.
 
 
         @return @true on success, @false if an error occurred.
 


@@ -386,8 +386,9 @@ public:
 
     A menu item has an integer ID associated with it which can be used to
     identify the selection, or to change the menu item in some way. A menu item
 
     A menu item has an integer ID associated with it which can be used to
     identify the selection, or to change the menu item in some way. A menu item

-    with a special identifier -1 is a separator item and doesn't have an
-    associated command but just makes a separator line appear in the menu.
+    with a special identifier @e wxID_SEPARATOR is a separator item and doesn't
+    have an associated command but just makes a separator line appear in the
+    menu.

 
     @note
     Please note that @e wxID_ABOUT and @e wxID_EXIT are predefined by wxWidgets
 
     @note
     Please note that @e wxID_ABOUT and @e wxID_EXIT are predefined by wxWidgets


@@ -416,9 +417,13 @@ public:
 
     @section menu_allocation Allocation strategy
 
 
     @section menu_allocation Allocation strategy
 

-    All menus except the popup ones must be created on the @b heap.
-    All menus attached to a menubar or to another menu will be deleted by their
-    parent when it is deleted.
+    All menus must be created on the @b heap because all menus attached to a
+    menubar or to another menu will be deleted by their parent when it is
+    deleted. The only exception to this rule are the popup menus (i.e. menus
+    used with wxWindow::PopupMenu()) as wxWidgets does not destroy them to
+    allow reusing the same menu more than once. But the exception applies only
+    to the menus themselves and not to any submenus of popup menus which are
+    still destroyed by wxWidgets as usual and so must be heap-allocated.

 
     As the frame menubar is deleted by the frame itself, it means that normally
     all menus used are deleted automatically.
 
     As the frame menubar is deleted by the frame itself, it means that normally
     all menus used are deleted automatically.


@@ -486,45 +491,27 @@ public:
             The menu command identifier.
         @param item
             The string to appear on the menu item.
             The menu command identifier.
         @param item
             The string to appear on the menu item.

+            See wxMenuItem::SetItemLabel() for more details.

         @param helpString
             An optional help string associated with the item.
         @param helpString
             An optional help string associated with the item.

-            By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays
+            By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays

             this string in the status line.
         @param kind
             this string in the status line.
         @param kind

-            May be wxITEM_SEPARATOR, wxITEM_NORMAL, wxITEM_CHECK or wxITEM_RADIO
+            May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or @c wxITEM_RADIO.
+
+        Example:
+        @code
+        m_pFileMenu->Append(ID_NEW_FILE, "&New file\tCTRL+N", "Creates a new XYZ document");
+        @endcode
+        or even better for stock menu items (see wxMenuItem::wxMenuItem):
+        @code
+        m_pFileMenu->Append(wxID_NEW, "", "Creates a new XYZ document");
+        @endcode

 
         @remarks
         This command can be used after the menu has been shown, as well as on
         initial creation of a menu or menubar.
 
 
         @remarks
         This command can be used after the menu has been shown, as well as on
         initial creation of a menu or menubar.
 

-        The item string for the normal menu items (not submenus or separators)
-        may include the accelerator which can be used to activate the menu item
-        from keyboard.
-        The accelerator string follows the item label and is separated from it
-        by a TAB character ('\\t').
-
-        Its general syntax is any combination of "CTRL", "ALT" and "SHIFT" strings
-        (case doesn't matter) separated by either '-' or '+' characters and followed
-        by the accelerator itself.
-        The accelerator may be any alphanumeric character, any function key
-        (from F1 to F12) or one of the special characters listed in the table
-        below (again, case doesn't matter):
-
-        - DEL or DELETE: Delete key
-        - INS or INSERT: Insert key
-        - ENTER or RETURN: Enter key
-        - PGUP: PageUp key
-        - PGDN: PageDown key
-        - LEFT: Left cursor arrow key
-        - RIGHT: Right cursor arrow key
-        - UP: Up cursor arrow key
-        - DOWN: Down cursor arrow key
-        - HOME: Home key
-        - END: End key
-        - SPACE: Space
-        - TAB: Tab key
-        - ESC: or ESCAPE Escape key (Windows only)
-

         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
              SetHelpString(), wxMenuItem
         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
              SetHelpString(), wxMenuItem


@@ -546,7 +533,7 @@ public:
             Pull-right submenu.
         @param helpString
             An optional help string associated with the item.
             Pull-right submenu.
         @param helpString
             An optional help string associated with the item.

-            By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays
+            By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays

             this string in the status line.
 
         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
             this string in the status line.
 
         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),


@@ -660,7 +647,7 @@ public:
         @param id
             Id of the menu item to be deleted.
 
         @param id
             Id of the menu item to be deleted.
 

-        @see FindItem(), Deletes(), Remove()
+        @see FindItem(), Delete(), Remove()

     */
     bool Destroy(int id);
 
     */
     bool Destroy(int id);
 


@@ -672,7 +659,7 @@ public:
         @param item
             Menu item to be deleted.
 
         @param item
             Menu item to be deleted.
 

-        @see FindItem(), Deletes(), Remove()
+        @see FindItem(), Delete(), Remove()

     */
     bool Destroy(wxMenuItem* item);
 
     */
     bool Destroy(wxMenuItem* item);
 


@@ -794,9 +781,6 @@ public:
     /**
         Returns the title of the menu.
 
     /**
         Returns the title of the menu.
 

-        @remarks This is relevant only to popup menus, use
-                 wxMenuBar::GetMenuLabel for the menus in the menubar.
-

         @see SetTitle()
     */
     const wxString& GetTitle() const;
         @see SetTitle()
     */
     const wxString& GetTitle() const;


@@ -966,8 +950,9 @@ public:
         @param title
             The title to set.
 
         @param title
             The title to set.
 

-        @remarks This is relevant only to popup menus, use
-                 wxMenuBar::SetLabelTop for the menus in the menubar.
+        @remarks Notice that you can only call this method directly for the
+            popup menus, to change the title of a menu that is part of a menu
+            bar you need to use wxMenuBar::SetLabelTop().

 
         @see GetTitle()
     */
 
         @see GetTitle()
     */