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
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.
+the radio items risks to not work correctly. Finally note that radio items
+are not supported under Motif.
\wxheading{Allocation strategy}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxMenu::wxMenu}\label{wxmenuconstr}
+\membersection{wxMenu::wxMenu}\label{wxmenuctor}
\func{}{wxMenu}{\param{const wxString\& }{title = ""}, \param{long}{ style = 0}}
\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}
\membersection{wxMenu::Append}\label{wxmenuappend}
-\func{void}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp
+\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. 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
{\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
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}
\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="")}}{}
\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.
\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
\membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator}
-\func{void}{AppendSeparator}{\void}
+\func{wxMenuItem*}{AppendSeparator}{\void}
Adds a separator to the end of the menu.
\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.
\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}}
\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}}
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}
\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.
\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.
\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.
\membersection{wxMenu::Prepend}\label{wxmenuprepend}
-\func{bool}{Prepend}{\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}}
-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{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}
\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}
\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}
\wxheading{Derived from}
+\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
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,
\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{int}{ n}, \param{wxMenu*}{ menus[]}, \param{const wxString }{titles[]}}
Construct a menu bar from arrays of menus and titles.
\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}
\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.
\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}
\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}
projects / wxWidgets.git / blobdiff