X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d65c269b3f665e15a8ae1b8fff063b2ec0ef19a7..c07103f267adc57a49d2fffa12acdd06b3ff7a57:/docs/latex/wx/menu.tex diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index e53ab4519e..72c93feb33 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -1,11 +1,56 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: menu.tex +%% Purpose: wxMenu documentation +%% Author: wxWidgets Team +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets Team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxMenu}}\label{wxmenu} A menu is a popup (or pull down) list of items, one of which may be selected before the menu goes away (clicking elsewhere dismisses the -menu). Menus may be used to construct either menu bars or popup menus. +menu). Menus may be used to construct either menu bars or popup menus. 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. +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. + +{\bf NB:} Please note that {\it wxID\_ABOUT} and {\it wxID\_EXIT} are +predefined by wxWidgets and have a special meaning since entries +using these IDs will be taken out of the normal menus under MacOS X +and will be inserted into the system menu (following the appropriate +MacOS X interface guideline). On PalmOS {\it wxID\_EXIT} is disabled according +to Palm OS Companion guidelines. + +Menu items may be either normal items, check items or radio items. Normal items +don't have any special properties while the check items have a boolean flag +associated to them and they show a checkmark in the menu when the flag is set. +wxWidgets automatically toggles the flag value when the item is clicked and its +value may be retrieved using either \helpref{IsChecked}{wxmenuischecked} method +of wxMenu or wxMenuBar itself or by using +\helpref{wxEvent::IsChecked}{wxcommandeventischecked} when you get the menu +notification for the item in question. + +The radio items are similar to the check items except that all the other items +in the same radio group are unchecked when a radio item is checked. The radio +group is formed by a contiguous range of radio items, i.e. it starts at the +first item of this kind and ends with the first item of a different kind (or +the end of the menu). Notice that because the radio groups are defined in terms +of the item positions inserting or removing the items in the menu containing +the radio items risks to not work correctly. Finally note that radio items +are not supported under Motif. + +\wxheading{Allocation strategy} + +All menus except the popup ones must be created on the heap. All menus +attached to a menubar or to another menu will be deleted by their parent when +it is deleted. As the frame menubar is deleted by the frame itself, it means +that normally all menus used are deleted automatically. \wxheading{Derived from} @@ -41,7 +86,7 @@ not be used in the new code, it is provided for backwards compatibility only. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMenu::wxMenu}\label{wxmenuconstr} +\membersection{wxMenu::wxMenu}\label{wxmenuctor} \func{}{wxMenu}{\param{const wxString\& }{title = ""}, \param{long}{ style = 0}} @@ -61,7 +106,7 @@ Constructs a wxMenu object. \docparam{style}{If set to {\tt wxMENU\_TEAROFF}, the menu will be detachable (wxGTK only).} -\membersection{wxMenu::\destruct{wxMenu}} +\membersection{wxMenu::\destruct{wxMenu}}\label{wxmenudtor} \func{}{\destruct{wxMenu}}{\void} @@ -76,17 +121,19 @@ and recreation of internal data structures. \membersection{wxMenu::Append}\label{wxmenuappend} -\func{void}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp -\param{wxItemKind}{ kind = wxItem\_Normal}} +\func{wxMenuItem*}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp +\param{wxItemKind}{ kind = wxITEM\_NORMAL}} Adds a string item to the end of the menu. -\func{void}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{wxMenu *}{subMenu},\rtfsp +\func{wxMenuItem*}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{wxMenu *}{subMenu},\rtfsp \param{const wxString\& }{helpString = ""}} -Adds a pull-right submenu to the end of the menu. +Adds a pull-right submenu to the end of the menu. Append the submenu to the parent +menu {\it after} you have added your menu items, or accelerators may not be +registered properly. -\func{void}{Append}{\param{wxMenuItem*}{ menuItem}} +\func{wxMenuItem*}{Append}{\param{wxMenuItem*}{ menuItem}} Adds a menu item object. This is the most generic variant of Append() method because it may be used for both items (including separators) and submenus and @@ -101,11 +148,11 @@ such as bitmaps and fonts. \docparam{menu}{Pull-right submenu.} -\docparam{kind}{May be {\tt wxItem\_Separator}, {\tt wxItem\_Normal}, -{\tt wxItem\_Check} or {\tt wxItem\_Radio}} +\docparam{kind}{May be {\tt wxITEM\_SEPARATOR}, {\tt wxITEM\_NORMAL}, +{\tt wxITEM\_CHECK} or {\tt wxITEM\_RADIO}} \docparam{helpString}{An optional help string associated with the item. -By default, \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays +By default, the handler for the wxEVT\_MENU\_HIGHLIGHT event displays this string in the status line.} \docparam{menuItem}{A menuitem object. It will be owned by the wxMenu object after this function @@ -116,6 +163,33 @@ is called, so do not delete it yourself.} This command can be used after the menu has been shown, as well as on initial creation of a menu or menubar. +The {\it 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 {\tt TAB} character ({\tt '$\backslash$t'}). Its general syntax is +any combination of {\tt "CTRL"}, {\tt "ALT"} and {\tt "SHIFT"} strings (case +doesn't matter) separated by either {\tt '-'} or {\tt '+'} characters and +followed by the accelerator itself. The accelerator may be any alphanumeric +character, any function key (from {\tt F1} to {\tt F12}) or one of the special +characters listed in the table below (again, case doesn't matter): + +\begin{twocollist}\itemsep=0pt +\twocolitem{{\tt DEL} or {\tt DELETE}}{Delete key} +\twocolitem{{\tt INS} or {\tt INSERT}}{Insert key} +\twocolitem{{\tt ENTER} or {\tt RETURN}}{Enter key} +\twocolitem{{\tt PGUP}}{PageUp key} +\twocolitem{{\tt PGDN}}{PageDown key} +\twocolitem{{\tt LEFT}}{Left cursor arrow key} +\twocolitem{{\tt RIGHT}}{Right cursor arrow key} +\twocolitem{{\tt UP}}{Up cursor arrow key} +\twocolitem{{\tt DOWN}}{Down cursor arrow key} +\twocolitem{{\tt HOME}}{Home key} +\twocolitem{{\tt END}}{End key} +\twocolitem{{\tt SPACE}}{Space} +\twocolitem{{\tt TAB}}{Tab key} +\twocolitem{{\tt ESC} or {\tt ESCAPE}}{Escape key (Windows only)} +\end{twocollist} + \wxheading{See also} \helpref{wxMenu::AppendSeparator}{wxmenuappendseparator},\rtfsp @@ -126,9 +200,10 @@ creation of a menu or menubar. \helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem} \pythonnote{In place of a single overloaded method name, wxPython -implements the following methods:\par +implements the following methods: + \indented{2cm}{\begin{twocollist} -\twocolitem{{\bf Append(id, string, helpStr="", checkable=FALSE)}}{} +\twocolitem{{\bf Append(id, string, helpStr="", checkable=false)}}{} \twocolitem{{\bf AppendMenu(id, string, aMenu, helpStr="")}}{} \twocolitem{{\bf AppendItem(aMenuItem)}}{} \end{twocollist}} @@ -136,7 +211,7 @@ implements the following methods:\par \membersection{wxMenu::AppendCheckItem}\label{wxmenuappendcheckitem} -\func{void}{AppendCheckItem}{\param{int}{ id},\rtfsp +\func{wxMenuItem*}{AppendCheckItem}{\param{int}{ id},\rtfsp \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} Adds a checkable item to the end of the menu. @@ -148,7 +223,7 @@ Adds a checkable item to the end of the menu. \membersection{wxMenu::AppendRadioItem}\label{wxmenuappendradioitem} -\func{void}{AppendRadioItem}{\param{int}{ id},\rtfsp +\func{wxMenuItem*}{AppendRadioItem}{\param{int}{ id},\rtfsp \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} Adds a radio item to the end of the menu. All consequent radio items form a @@ -156,7 +231,7 @@ group and when an item in the group is checked, all the others are automatically unchecked. {\bf NB:} Currently only implemented under Windows and GTK, use -{\tt #if wxHAS\_RADIO\_MENU\_ITEMS} to test for availability of this feature. +{\tt\#if wxHAS\_RADIO\_MENU\_ITEMS} to test for availability of this feature. \wxheading{See also} @@ -165,7 +240,7 @@ automatically unchecked. \membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator} -\func{void}{AppendSeparator}{\void} +\func{wxMenuItem*}{AppendSeparator}{\void} Adds a separator to the end of the menu. @@ -190,7 +265,7 @@ Checks or unchecks the menu item. \docparam{id}{The menu item identifier.} -\docparam{check}{If TRUE, the item will be checked, otherwise it will be unchecked.} +\docparam{check}{If true, the item will be checked, otherwise it will be unchecked.} \wxheading{See also} @@ -250,7 +325,7 @@ Enables or disables (greys out) a menu item. \docparam{id}{The menu item identifier.} -\docparam{enable}{TRUE to enable the menu item, FALSE to disable it.} +\docparam{enable}{true to enable the menu item, false to disable it.} \wxheading{See also} @@ -277,12 +352,12 @@ context it returns a 2-element list {\tt ( item, submenu )}} \docparam{id}{Menu item identifier.} -\docparam{menu}{If the pointer is not NULL, it will be filled with the items +\docparam{menu}{If the pointer is not NULL, it will be filled with the item's parent menu (if the item was found)} \wxheading{Return value} -First form: menu item identifier, or wxNOT\_FOUND if none is found. +First form: menu item identifier, or {\tt wxNOT\_FOUND} if none is found. Second form: returns the menu item object, or NULL if it is not found. @@ -294,6 +369,12 @@ before matching. \pythonnote{The name of this method in wxPython is {\tt FindItemById} and it does not support the second parameter.} +\membersection{wxMenu::FindItemByPosition}\label{wxmenufinditembyposition} + +\constfunc{wxMenuItem*}{FindItemByPosition}{\param{size\_t }{position}} + +Returns the wxMenuItem given a position in the menu. + \membersection{wxMenu::GetHelpString}\label{wxmenugethelpstring} \constfunc{wxString}{GetHelpString}{\param{int}{ id}} @@ -352,7 +433,9 @@ Returns the title of the menu. \wxheading{Remarks} -This is relevant only to popup menus. +This is relevant only to popup menus, use +\helpref{wxMenuBar::GetLabelTop}{wxmenubargetlabeltop} for the menus in the +menubar. \wxheading{See also} @@ -360,14 +443,14 @@ This is relevant only to popup menus. \membersection{wxMenu::Insert}\label{wxmenuinsert} -\func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenuItem *}{item}} +\func{wxMenuItem*}{Insert}{\param{size\_t }{pos}, \param{wxMenuItem *}{item}} -\func{void}{Insert}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp +\func{wxMenuItem*}{Insert}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp -\param{wxItemKind}{ kind = wxItem\_Normal}} +\param{wxItemKind}{ kind = wxITEM\_NORMAL}} Inserts the given {\it item} before the position {\it pos}. Inserting the item -at the position \helpref{GetMenuItemCount}{wxmenugetmenuitemcount} is the same +at position \helpref{GetMenuItemCount}{wxmenugetmenuitemcount} is the same as appending it. \wxheading{See also} @@ -377,7 +460,7 @@ as appending it. \membersection{wxMenu::InsertCheckItem}\label{wxmenuinsertcheckitem} -\func{void}{InsertCheckItem}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp +\func{wxMenuItem*}{InsertCheckItem}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} Inserts a checkable item at the given position. @@ -389,7 +472,7 @@ Inserts a checkable item at the given position. \membersection{wxMenu::InsertRadioItem}\label{wxmenuinsertradioitem} -\func{void}{InsertRadioItem}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp +\func{wxMenuItem*}{InsertRadioItem}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} Inserts a radio item at the given position. @@ -401,7 +484,7 @@ Inserts a radio item at the given position. \membersection{wxMenu::InsertSeparator}\label{wxmenuinsertseparator} -\func{void}{InsertSeparator}{\param{size\_t }{pos}} +\func{wxMenuItem*}{InsertSeparator}{\param{size\_t }{pos}} Inserts a separator at the given position. @@ -422,7 +505,7 @@ Determines whether a menu item is checked. \wxheading{Return value} -TRUE if the menu item is checked, FALSE otherwise. +true if the menu item is checked, false otherwise. \wxheading{See also} @@ -440,7 +523,7 @@ Determines whether a menu item is enabled. \wxheading{Return value} -TRUE if the menu item is enabled, FALSE otherwise. +true if the menu item is enabled, false otherwise. \wxheading{See also} @@ -448,25 +531,26 @@ TRUE if the menu item is enabled, FALSE otherwise. \membersection{wxMenu::Prepend}\label{wxmenuprepend} -\func{bool}{Prepend}{\param{size\_t }{pos}, \param{wxMenuItem *}{item}} +\func{wxMenuItem*}{Prepend}{\param{wxMenuItem *}{item}} -\func{void}{Prepend}{\param{int}{ id},\rtfsp +\func{wxMenuItem*}{Prepend}{\param{int}{ id},\rtfsp \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp -\param{wxItemKind}{ kind = wxItem\_Normal}} +\param{wxItemKind}{ kind = wxITEM\_NORMAL}} -Inserts the given {\it item} at the position $0$. +Inserts the given {\it item} at position $0$, i.e. before all the other +existing items. \wxheading{See also} \helpref{wxMenu::Append}{wxmenuappend},\rtfsp -\helpref{wxMenu::Inserts}{wxmenuinsert} +\helpref{wxMenu::Insert}{wxmenuinsert} \membersection{wxMenu::PrependCheckItem}\label{wxmenuprependcheckitem} -\func{void}{PrependCheckItem}{\param{int}{ id},\rtfsp +\func{wxMenuItem*}{PrependCheckItem}{\param{int}{ id},\rtfsp \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} -Inserts a checkable item at the position $0$. +Inserts a checkable item at position $0$. \wxheading{See also} @@ -475,10 +559,10 @@ Inserts a checkable item at the position $0$. \membersection{wxMenu::PrependRadioItem}\label{wxmenuprependradioitem} -\func{void}{PrependRadioItem}{\param{int}{ id},\rtfsp +\func{wxMenuItem*}{PrependRadioItem}{\param{int}{ id},\rtfsp \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} -Inserts a radio item at the position $0$. +Inserts a radio item at position $0$. \wxheading{See also} @@ -487,9 +571,9 @@ Inserts a radio item at the position $0$. \membersection{wxMenu::PrependSeparator}\label{wxmenuprependseparator} -\func{void}{PrependSeparator}{\param{size\_t }{pos}} +\func{wxMenuItem*}{PrependSeparator}{\void} -Inserts a separator at the position $0$. +Inserts a separator at position $0$. \wxheading{See also} @@ -560,11 +644,13 @@ Sets the title of the menu. \wxheading{Remarks} -This is relevant only to popup menus. +This is relevant only to popup menus, use +\helpref{wxMenuBar::SetLabelTop}{wxmenubarsetlabeltop} for the menus in the +menubar. \wxheading{See also} -\helpref{wxMenu::SetTitle}{wxmenusettitle} +\helpref{wxMenu::GetTitle}{wxmenugettitle} \membersection{wxMenu::UpdateUI}\label{wxmenuupdateui} @@ -584,6 +670,7 @@ A menu bar is a series of menus accessible from the top of a frame. \wxheading{Derived from} +\helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} @@ -598,12 +685,6 @@ that contains the menu bar. If you have a toolbar which uses the same identifier as your EVT\_MENU entries, events from the toolbar will also be processed by your EVT\_MENU event handlers. -Note that menu commands (and UI update events for menus) are first sent to -the focus window within the frame. If no window within the frame has the focus, -then the events are sent directly to the frame. This allows command and UI update -handling to be processed by specific windows and controls, and not necessarily -by the application frame. - {\bf Tip:} under Windows, if you discover that menu shortcuts (for example, Alt-F to show the file menu) are not working, check any EVT\_CHAR events you are handling in child windows. If you are not calling {\tt event.Skip()} for events that you don't process in these event handlers, @@ -615,13 +696,13 @@ menu shortcuts may cease to work. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMenuBar::wxMenuBar}\label{wxmenubarconstr} +\membersection{wxMenuBar::wxMenuBar}\label{wxmenubarctor} -\func{void}{wxMenuBar}{\param{long }{style = 0}} +\func{}{wxMenuBar}{\param{long }{style = 0}} Default constructor. -\func{void}{wxMenuBar}{\param{int}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}} +\func{}{wxMenuBar}{\param{size\_t}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}, \param{long }{style = 0}} Construct a menu bar from arrays of menus and titles. @@ -637,12 +718,12 @@ menu bar.} \docparam{style}{If {\tt wxMB\_DOCKABLE} the menu bar can be detached (wxGTK only).} \pythonnote{Only the default constructor is supported in wxPython. -Use wxMenuBar.Append instead.} +Use \helpref{wxMenuBar::Append}{wxmenubarappend} instead.} -\perlnote{wxPerl only supports the first contructor: -use {\tt Append} instead.} +\perlnote{wxPerl only supports the first constructor: +use \helpref{wxMenuBar::Append}{wxmenubarappend} instead.} -\membersection{wxMenuBar::\destruct{wxMenuBar}} +\membersection{wxMenuBar::\destruct{wxMenuBar}}\label{wxmenubardtor} \func{void}{\destruct{wxMenuBar}}{\void} @@ -662,7 +743,7 @@ Adds the item to the end of the menu bar. \wxheading{Return value} -TRUE on success, FALSE if an error occurred. +true on success, false if an error occurred. \wxheading{See also} @@ -678,7 +759,7 @@ Checks or unchecks a menu item. \docparam{id}{The menu item identifier.} -\docparam{check}{If TRUE, checks the menu item, otherwise the item is unchecked.} +\docparam{check}{If true, checks the menu item, otherwise the item is unchecked.} \wxheading{Remarks} @@ -695,7 +776,7 @@ Enables or disables (greys out) a menu item. \docparam{id}{The menu item identifier.} -\docparam{enable}{TRUE to enable the item, FALSE to disable it.} +\docparam{enable}{true to enable the item, false to disable it.} \wxheading{Remarks} @@ -712,7 +793,7 @@ Enables or disables a whole menu. \docparam{pos}{The position of the menu, starting from zero.} -\docparam{enable}{TRUE to enable the menu, FALSE to disable it.} +\docparam{enable}{true to enable the menu, false to disable it.} \wxheading{Remarks} @@ -723,7 +804,7 @@ associated with a frame. \constfunc{int}{FindMenu}{\param{const wxString\& }{title}} -Returns the index of the menu with the given {\it title} or wxNOT\_FOUND if no +Returns the index of the menu with the given {\it title} or {\tt wxNOT\_FOUND} if no such menu exists in this menubar. The {\it title} parameter may specify either the menu title (with accelerator characters, i.e. {\tt "\&File"}) or just the menu label ({\tt "File"}) indifferently. @@ -742,7 +823,7 @@ Finds the menu item id for a menu name/menu item string pair. \wxheading{Return value} -The menu item identifier, or wxNOT\_FOUND if none was found. +The menu item identifier, or {\tt wxNOT\_FOUND} if none was found. \wxheading{Remarks} @@ -769,7 +850,7 @@ The found menu item object, or NULL if one was not found. \constfunc{wxString}{GetHelpString}{\param{int}{ id}} -Gets the help string associated with the menu item identifer. +Gets the help string associated with the menu item identifier. \wxheading{Parameters} @@ -806,7 +887,9 @@ Use only after the menubar has been associated with a frame. \constfunc{wxString}{GetLabelTop}{\param{int}{ pos}} -Returns the label of a top-level menu. +Returns the label of a top-level menu. Note that the returned string does not +include the accelerator characters which could have been specified in the menu +title string during its construction. \wxheading{Parameters} @@ -855,7 +938,7 @@ position $0$ will insert it in the very beginning of it, inserting at position \wxheading{Return value} -TRUE on success, FALSE if an error occurred. +true on success, false if an error occurred. \wxheading{See also} @@ -873,7 +956,7 @@ Determines whether an item is checked. \wxheading{Return value} -TRUE if the item was found and is checked, FALSE otherwise. +true if the item was found and is checked, false otherwise. \membersection{wxMenuBar::IsEnabled}\label{wxmenubarisenabled} @@ -887,7 +970,7 @@ Determines whether an item is enabled. \wxheading{Return value} -TRUE if the item was found and is enabled, FALSE otherwise. +true if the item was found and is enabled, false otherwise. \membersection{wxMenuBar::Refresh}\label{wxmenubarrefresh} @@ -924,7 +1007,7 @@ Replaces the menu at the given position with another one. \wxheading{Return value} -The menu which was previously at the position {\it pos}. The caller is +The menu which was previously at position {\it pos}. The caller is responsible for deleting it. \wxheading{See also}