X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9add93670bb4a38e4007b8422b34b29b6194eecb..ecda94753af66cb77d88fbf68be5de14193a5925:/docs/latex/wx/menu.tex diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index 763028545f..074289b494 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -9,10 +9,16 @@ 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). + 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. -wxWindows automatically toggles the flag value when the item is clicked and its +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 @@ -68,7 +74,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}} @@ -88,7 +94,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} @@ -154,6 +160,7 @@ 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} @@ -181,7 +188,8 @@ characters listed in the table below (again, case doesn't matter): \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 AppendMenu(id, string, aMenu, helpStr="")}}{} @@ -332,12 +340,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. @@ -430,7 +438,7 @@ menubar. \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} @@ -517,20 +525,20 @@ true if the menu item is enabled, false otherwise. \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 +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{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} @@ -542,7 +550,7 @@ Inserts a checkable item at the position $0$. \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} @@ -553,7 +561,7 @@ Inserts a radio item at the position $0$. \func{wxMenuItem*}{PrependSeparator}{\param{size\_t }{pos}} -Inserts a separator at the position $0$. +Inserts a separator at position $0$. \wxheading{See also} @@ -665,12 +673,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, @@ -682,7 +684,7 @@ 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}} @@ -709,7 +711,7 @@ Use wxMenuBar.Append instead.} \perlnote{wxPerl only supports the first constructor: use {\tt Append} instead.} -\membersection{wxMenuBar::\destruct{wxMenuBar}} +\membersection{wxMenuBar::\destruct{wxMenuBar}}\label{wxmenubardtor} \func{void}{\destruct{wxMenuBar}}{\void} @@ -790,7 +792,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. @@ -809,7 +811,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} @@ -993,7 +995,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}