X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/809f39fe42dbc118540dfa2c18c6f3f538f68752..dc92adaf0c8d1d8b71b4a4cabe6f42c3a17f62a1:/docs/latex/wx/menu.tex diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index 91f540d1ea..e95ae3db05 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -2,10 +2,37 @@ 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. + +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 the radio items +are only supported under Windows and GTK+ currently. + +\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} @@ -76,17 +103,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{const bool}{ checkable = FALSE}} +\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,10 +130,11 @@ such as bitmaps and fonts. \docparam{menu}{Pull-right submenu.} -\docparam{checkable}{If TRUE, this item is checkable.} +\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 @@ -115,31 +145,91 @@ 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 +\helpref{wxMenu::AppendCheckItem}{wxmenuappendcheckitem},\rtfsp +\helpref{wxMenu::AppendRadioItem}{wxmenuappendradioitem},\rtfsp \helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp \helpref{wxMenu::SetLabel}{wxmenusetlabel}, \helpref{wxMenu::GetHelpString}{wxmenugethelpstring},\rtfsp \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}} } +\membersection{wxMenu::AppendCheckItem}\label{wxmenuappendcheckitem} + +\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. + +\wxheading{See also} + +\helpref{wxMenu::Append}{wxmenuappend},\rtfsp +\helpref{wxMenu::InsertCheckItem}{wxmenuinsertcheckitem} + +\membersection{wxMenu::AppendRadioItem}\label{wxmenuappendradioitem} + +\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 +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. + +\wxheading{See also} + +\helpref{wxMenu::Append}{wxmenuappend},\rtfsp +\helpref{wxMenu::InsertRadioItem}{wxmenuinsertradioitem} + \membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator} -\func{void}{AppendSeparator}{\void} +\func{wxMenuItem*}{AppendSeparator}{\void} Adds a separator to the end of the menu. \wxheading{See also} -\helpref{wxMenu::Append}{wxmenuappend} +\helpref{wxMenu::Append}{wxmenuappend},\rtfsp +\helpref{wxMenu::InsertSeparator}{wxmenuinsertseparator} \membersection{wxMenu::Break}\label{wxmenubreak} @@ -157,7 +247,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} @@ -217,7 +307,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} @@ -236,7 +326,7 @@ optionally, the (sub)menu it belongs to. \perlnote{In wxPerl this method takes just the {\tt id} parameter; in scalar context it returns the associated {\tt Wx::MenuItem}, in list -context it returns a two element list ( item, submenu )} +context it returns a 2-element list {\tt ( item, submenu )}} \wxheading{Parameters} @@ -261,6 +351,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}} @@ -319,7 +415,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} @@ -327,7 +425,11 @@ 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{wxMenuItem*}{Insert}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp +\param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp +\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 @@ -335,7 +437,43 @@ as appending it. \wxheading{See also} -\helpref{wxMenu::Append}{wxmenuappend} +\helpref{wxMenu::Append}{wxmenuappend},\rtfsp +\helpref{wxMenu::Prepend}{wxmenuprepend} + +\membersection{wxMenu::InsertCheckItem}\label{wxmenuinsertcheckitem} + +\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. + +\wxheading{See also} + +\helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp +\helpref{wxMenu::AppendCheckItem}{wxmenuappendcheckitem} + +\membersection{wxMenu::InsertRadioItem}\label{wxmenuinsertradioitem} + +\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. + +\wxheading{See also} + +\helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp +\helpref{wxMenu::AppendRadioItem}{wxmenuappendradioitem} + +\membersection{wxMenu::InsertSeparator}\label{wxmenuinsertseparator} + +\func{wxMenuItem*}{InsertSeparator}{\param{size\_t }{pos}} + +Inserts a separator at the given position. + +\wxheading{See also} + +\helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp +\helpref{wxMenu::AppendSeparator}{wxmenuappendseparator} \membersection{wxMenu::IsChecked}\label{wxmenuischecked} @@ -349,7 +487,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} @@ -367,12 +505,63 @@ 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} \helpref{wxMenu::Enable}{wxmenuenable} +\membersection{wxMenu::Prepend}\label{wxmenuprepend} + +\func{wxMenuItem*}{Prepend}{\param{wxMenuItem *}{item}} + +\func{wxMenuItem*}{Prepend}{\param{int}{ id},\rtfsp +\param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp +\param{wxItemKind}{ kind = wxITEM\_NORMAL}} + +Inserts the given {\it item} at the position $0$, i.e. before all the other +existing items. + +\wxheading{See also} + +\helpref{wxMenu::Append}{wxmenuappend},\rtfsp +\helpref{wxMenu::Inserts}{wxmenuinsert} + +\membersection{wxMenu::PrependCheckItem}\label{wxmenuprependcheckitem} + +\func{wxMenuItem*}{PrependCheckItem}{\param{int}{ id},\rtfsp +\param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} + +Inserts a checkable item at the position $0$. + +\wxheading{See also} + +\helpref{wxMenu::Prepend}{wxmenuprepend},\rtfsp +\helpref{wxMenu::AppendCheckItem}{wxmenuappendcheckitem} + +\membersection{wxMenu::PrependRadioItem}\label{wxmenuprependradioitem} + +\func{wxMenuItem*}{PrependRadioItem}{\param{int}{ id},\rtfsp +\param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}} + +Inserts a radio item at the position $0$. + +\wxheading{See also} + +\helpref{wxMenu::Prepend}{wxmenuprepend},\rtfsp +\helpref{wxMenu::AppendRadioItem}{wxmenuappendradioitem} + +\membersection{wxMenu::PrependSeparator}\label{wxmenuprependseparator} + +\func{wxMenuItem*}{PrependSeparator}{\param{size\_t }{pos}} + +Inserts a separator at the position $0$. + +\wxheading{See also} + +\helpref{wxMenu::Prepend}{wxmenuprepend},\rtfsp +\helpref{wxMenu::AppendSeparator}{wxmenuappendseparator} + \membersection{wxMenu::Remove}\label{wxmenuremove} \func{wxMenuItem *}{Remove}{\param{int }{id}} @@ -437,11 +626,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} @@ -461,6 +652,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} @@ -475,11 +667,10 @@ 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, +menu shortcuts may cease to work. \wxheading{See also} @@ -511,7 +702,7 @@ menu bar.} \pythonnote{Only the default constructor is supported in wxPython. Use wxMenuBar.Append instead.} -\perlnote{wxPerl only supports the first contructor: +\perlnote{wxPerl only supports the first constructor: use {\tt Append} instead.} \membersection{wxMenuBar::\destruct{wxMenuBar}} @@ -534,7 +725,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} @@ -550,7 +741,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} @@ -567,7 +758,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} @@ -584,7 +775,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} @@ -641,7 +832,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} @@ -678,7 +869,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} @@ -727,7 +920,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} @@ -745,7 +938,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} @@ -759,7 +952,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} @@ -772,7 +965,7 @@ Redraw the menu bar \func{wxMenu *}{Remove}{\param{size\_t }{pos}} Removes the menu from the menu bar and returns the menu object - the caller is -reposnbile for deleting it. This function may be used together with +responsible for deleting it. This function may be used together with \helpref{wxMenuBar::Insert}{wxmenubarinsert} to change the menubar dynamically.