latex/wx/menu.tex

18 A menu item has an integer ID associated with it which can be used to
19 identify the selection, or to change the menu item in some way. A menu item
20 with a special identifier $-1$ is a separator item and doesn't have an
33 wxWidgets automatically toggles the flag value when the item is clicked and its
37 notification for the item in question.
40 in the same radio group are unchecked when a radio item is checked. The radio
42 first item of this kind and ends with the first item of a different kind (or
44 of the item positions inserting or removing the items in the menu containing
72 \item Derive a new class from wxMenu and define event table entries using the EVT\_MENU macro.
73 \item Set a new event handler for wxMenu, using an object whose class has EVT\_MENU entries.
74 \item Provide EVT\_MENU handlers in the window which pops up the menu, or in an ancestor of
76 \item Define a callback of type wxFunction, which you pass to the wxMenu constructor.
130 \func{wxMenuItem*}{Append}{\param{int}{ id}, \param{const wxString\& }{ item = ""}, \param{const wxString\& }{helpString = ""},\rtfsp
133 Adds a string item to the end of the menu.
135 \func{wxMenuItem*}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{wxMenu *}{subMenu},\rtfsp
144 Adds a menu item object. This is the most generic variant of Append() method
146 because you can also specify various extra properties of a menu item this way,
153 \docparam{item}{The string to appear on the menu item.}
160 \docparam{helpString}{An optional help string associated with the item.
172 The {\it item} string for the normal menu items (not submenus or separators)
173 may include the accelerator which can be used to activate the menu item
174 from keyboard. The accelerator string follows the item label and is separated
223 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
225 Adds a checkable item to the end of the menu.
236 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
238 Adds a radio item to the end of the menu. All consequent radio items form a
239 group and when an item in the group is checked, all the others are
266 submenu item is selected.
273 Inserts a break in a menu, causing the next appended item to appear in a new column.
280 Checks or unchecks the menu item.
284 \docparam{id}{The menu item identifier.}
286 \docparam{check}{If true, the item will be checked, otherwise it will be unchecked.}
297 \func{void}{Delete}{\param{wxMenuItem *}{item}}
299 Deletes the menu item from the menu. If the item is a submenu, it will
305 \docparam{id}{Id of the menu item to be deleted.}
307 \docparam{item}{Menu item to be deleted.}
320 \func{void}{Destroy}{\param{wxMenuItem *}{item}}
322 Deletes the menu item from the menu. If the item is a submenu, it will
328 \docparam{id}{Id of the menu item to be deleted.}
330 \docparam{item}{Menu item to be deleted.}
343 Enables or disables (greys out) a menu item.
347 \docparam{id}{The menu item identifier.}
349 \docparam{enable}{true to enable the menu item, false to disable it.}
360 Finds the menu item id for a menu item string.
364 Finds the menu item object associated with the given menu item identifier and,
369 context it returns a 2-element list {\tt ( item, submenu )}}
373 \docparam{itemString}{Menu item string to find.}
375 \docparam{id}{Menu item identifier.}
377 \docparam{menu}{If the pointer is not NULL, it will be filled with the item's
378 parent menu (if the item was found)}
382 First form: menu item identifier, or {\tt wxNOT\_FOUND} if none is found.
384 Second form: returns the menu item object, or NULL if it is not found.
406 Returns the help string associated with a menu item.
410 \docparam{id}{The menu item identifier.}
415 item was not found.
426 Returns a menu item label, including any mnemonics and accelerators.
430 \docparam{id}{The menu item identifier.}
434 The item label, or the empty string if the item was not found.
445 Returns a menu item label, without any of the original mnemonics and accelerators.
449 \docparam{id}{The menu item identifier.}
453 The item label, or the empty string if the item was not found.
494 \func{wxMenuItem*}{Insert}{\param{size\_t }{pos}, \param{wxMenuItem *}{item}}
497 \param{const wxString\& }{ item = ""}, \param{const wxString\& }{helpString = ""},\rtfsp
500 Inserts the given {\it item} before the position {\it pos}. Inserting the item
513 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
515 Inserts a checkable item at the given position.
526 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
528 Inserts a radio item at the given position.
552 Determines whether a menu item is checked.
556 \docparam{id}{The menu item identifier.}
560 true if the menu item is checked, false otherwise.
571 Determines whether a menu item is enabled.
575 \docparam{id}{The menu item identifier.}
579 true if the menu item is enabled, false otherwise.
588 \func{wxMenuItem*}{Prepend}{\param{wxMenuItem *}{item}}
591 \param{const wxString\& }{ item = ""}, \param{const wxString\& }{helpString = ""},\rtfsp
594 Inserts the given {\it item} at position $0$, i.e. before all the other
606 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
608 Inserts a checkable item at position $0$.
619 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
621 Inserts a radio item at position $0$.
645 \func{wxMenuItem *}{Remove}{\param{wxMenuItem *}{item}}
647 Removes the menu item from the menu but doesn't delete the associated C++
648 object. This allows to reuse the same item later by adding it back to the menu
653 \docparam{id}{The identifier of the menu item to remove.}
655 \docparam{item}{The menu item to remove.}
659 The item which was detached from the menu.
666 Sets an item's help string.
670 \docparam{id}{The menu item identifier.}
683 Sets the label of a menu item.
687 \docparam{id}{The menu item identifier.}
689 \docparam{label}{The menu item label to set.}
801 Adds the item to the end of the menu bar.
822 Checks or unchecks a menu item.
826 \docparam{id}{The menu item identifier.}
828 \docparam{check}{If true, checks the menu item, otherwise the item is unchecked.}
840 Enables or disables (greys out) a menu item.
844 \docparam{id}{The menu item identifier.}
846 \docparam{enable}{true to enable the item, false to disable it.}
886 Finds the menu item id for a menu name/menu item string pair.
896 The menu item identifier, or {\tt wxNOT\_FOUND} if none was found.
908 Finds the menu item object associated with the given menu item identifier.
912 \docparam{id}{Menu item identifier.}
918 The found menu item object, or NULL if one was not found.
925 Gets the help string associated with the menu item identifier.
929 \docparam{id}{The menu item identifier.}
933 The help string, or the empty string if there was no help string or the menu item
945 Gets the label associated with a menu item.
949 \docparam{id}{The menu item identifier.}
953 The menu item label, or the empty string if the item was not found.
1081 Determines whether an item is checked.
1085 \docparam{id}{The menu item identifier.}
1089 true if the item was found and is checked, false otherwise.
1096 Determines whether an item is enabled.
1100 \docparam{id}{The menu item identifier.}
1104 true if the item was found and is enabled, false otherwise.
1157 Sets the help string associated with a menu item.
1161 \docparam{id}{Menu item identifier.}
1163 \docparam{helpString}{Help string to associate with the menu item.}
1174 Sets the label of a menu item.
1178 \docparam{id}{Menu item identifier.}
1180 \docparam{label}{Menu item label.}