+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% 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
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.
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}
\wxheading{See also}
\helpref{wxMenuBar}{wxmenubar}, \helpref{wxWindow::PopupMenu}{wxwindowpopupmenu},\rtfsp
-\helpref{Event handling overview}{eventhandlingoverview}
+\helpref{Event handling overview}{eventhandlingoverview},\rtfsp
+\helpref{wxFileHistory (most recently used files menu)}{wxfilehistory}
+
+
\latexignore{\rtfignore{\wxheading{Members}}}
+
\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}}\label{wxmenudtor}
\func{}{\destruct{wxMenu}}{\void}
a different window from last time, which causes an implicit destruction
and recreation of internal data structures.
+
\membersection{wxMenu::Append}\label{wxmenuappend}
\func{wxMenuItem*}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp
\helpref{wxMenu::AppendSeparator}{wxmenuappendseparator},\rtfsp
\helpref{wxMenu::AppendCheckItem}{wxmenuappendcheckitem},\rtfsp
\helpref{wxMenu::AppendRadioItem}{wxmenuappendradioitem},\rtfsp
+\helpref{wxMenu::AppendSubMenu}{wxmenuappendsubmenu},\rtfsp
\helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp
\helpref{wxMenu::SetLabel}{wxmenusetlabel}, \helpref{wxMenu::GetHelpString}{wxmenugethelpstring},\rtfsp
\helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem}
\end{twocollist}}
}
+
\membersection{wxMenu::AppendCheckItem}\label{wxmenuappendcheckitem}
\func{wxMenuItem*}{AppendCheckItem}{\param{int}{ id},\rtfsp
\helpref{wxMenu::Append}{wxmenuappend},\rtfsp
\helpref{wxMenu::InsertCheckItem}{wxmenuinsertcheckitem}
+
\membersection{wxMenu::AppendRadioItem}\label{wxmenuappendradioitem}
\func{wxMenuItem*}{AppendRadioItem}{\param{int}{ id},\rtfsp
\helpref{wxMenu::Append}{wxmenuappend},\rtfsp
\helpref{wxMenu::InsertRadioItem}{wxmenuinsertradioitem}
+
\membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator}
\func{wxMenuItem*}{AppendSeparator}{\void}
\helpref{wxMenu::Append}{wxmenuappend},\rtfsp
\helpref{wxMenu::InsertSeparator}{wxmenuinsertseparator}
+
+\membersection{wxMenu::AppendSubMenu}\label{wxmenuappendsubmenu}
+
+\func{wxMenuItem *}{AppendSubMenu}{\param{wxMenu *}{submenu}, \param{const wxString\& }{text}, \param{const wxString\& }{help = wxEmptyString}}
+
+Adds the given \arg{submenu} to this menu. \arg{text} is the text shown in the
+menu for it and \arg{help} is the help string shown in the status bar when the
+submenu item is selected.
+
+
\membersection{wxMenu::Break}\label{wxmenubreak}
\func{void}{Break}{\void}
Inserts a break in a menu, causing the next appended item to appear in a new column.
+
\membersection{wxMenu::Check}\label{wxmenucheck}
\func{void}{Check}{\param{int}{ id}, \param{const bool}{ check}}
\helpref{wxMenu::IsChecked}{wxmenuischecked}
+
\membersection{wxMenu::Delete}\label{wxmenudelete}
\func{void}{Delete}{\param{int }{id}}
\helpref{wxMenu::Destroy}{wxmenudestroy},\rtfsp
\helpref{wxMenu::Remove}{wxmenuremove}
+
\membersection{wxMenu::Destroy}\label{wxmenudestroy}
\func{void}{Destroy}{\param{int }{id}}
\helpref{wxMenu::Deletes}{wxmenudelete},\rtfsp
\helpref{wxMenu::Remove}{wxmenuremove}
+
\membersection{wxMenu::Enable}\label{wxmenuenable}
\func{void}{Enable}{\param{int}{ id}, \param{const bool}{ enable}}
\helpref{wxMenu::IsEnabled}{wxmenuisenabled}
+
\membersection{wxMenu::FindItem}\label{wxmenufinditem}
\constfunc{int}{FindItem}{\param{const wxString\& }{itemString}}
\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}
\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}}
\helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenu::Append}{wxmenuappend}
+
\membersection{wxMenu::GetLabel}\label{wxmenugetlabel}
\constfunc{wxString}{GetLabel}{\param{int}{ id}}
\helpref{wxMenu::SetLabel}{wxmenusetlabel}
+
\membersection{wxMenu::GetMenuItemCount}\label{wxmenugetmenuitemcount}
\constfunc{size\_t}{GetMenuItemCount}{\void}
Returns the number of items in the menu.
+
\membersection{wxMenu::GetMenuItems}\label{wxmenugetmenuitems}
\constfunc{wxMenuItemList\&}{GetMenuItems}{\void}
Returns the list of items in the menu. wxMenuItemList is a pseudo-template
list class containing wxMenuItem pointers.
+
\membersection{wxMenu::GetTitle}\label{wxmenugettitle}
\constfunc{wxString}{GetTitle}{\void}
\helpref{wxMenu::SetTitle}{wxmenusettitle}
+
\membersection{wxMenu::Insert}\label{wxmenuinsert}
\func{wxMenuItem*}{Insert}{\param{size\_t }{pos}, \param{wxMenuItem *}{item}}
\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}
\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
\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
\helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp
\helpref{wxMenu::AppendRadioItem}{wxmenuappendradioitem}
+
\membersection{wxMenu::InsertSeparator}\label{wxmenuinsertseparator}
\func{wxMenuItem*}{InsertSeparator}{\param{size\_t }{pos}}
\helpref{wxMenu::Insert}{wxmenuinsert},\rtfsp
\helpref{wxMenu::AppendSeparator}{wxmenuappendseparator}
+
\membersection{wxMenu::IsChecked}\label{wxmenuischecked}
\constfunc{bool}{IsChecked}{\param{int}{ id}}
\helpref{wxMenu::Check}{wxmenucheck}
+
\membersection{wxMenu::IsEnabled}\label{wxmenuisenabled}
\constfunc{bool}{IsEnabled}{\param{int}{ id}}
\helpref{wxMenu::Enable}{wxmenuenable}
+
\membersection{wxMenu::Prepend}\label{wxmenuprepend}
\func{wxMenuItem*}{Prepend}{\param{wxMenuItem *}{item}}
\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}
\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$.
+Inserts a radio item at 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}}
+\func{wxMenuItem*}{PrependSeparator}{\void}
-Inserts a separator at the position $0$.
+Inserts a separator at 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}}
The item which was detached from the menu.
+
\membersection{wxMenu::SetHelpString}\label{wxmenusethelpstring}
\func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}}
\helpref{wxMenu::GetHelpString}{wxmenugethelpstring}
+
\membersection{wxMenu::SetLabel}\label{wxmenusetlabel}
\func{void}{SetLabel}{\param{int}{ id}, \param{const wxString\& }{label}}
\helpref{wxMenu::Append}{wxmenuappend}, \helpref{wxMenu::GetLabel}{wxmenugetlabel}
+
\membersection{wxMenu::SetTitle}\label{wxmenusettitle}
\func{void}{SetTitle}{\param{const wxString\& }{title}}
\helpref{wxMenu::GetTitle}{wxmenugettitle}
+
\membersection{wxMenu::UpdateUI}\label{wxmenuupdateui}
\constfunc{void}{UpdateUI}{\param{wxEvtHandler*}{ source = NULL}}
\latexignore{\rtfignore{\wxheading{Members}}}
+
\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.
\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 constructor:
-use {\tt Append} instead.}
+use \helpref{wxMenuBar::Append}{wxmenubarappend} instead.}
+
\membersection{wxMenuBar::\destruct{wxMenuBar}}\label{wxmenubardtor}
Destructor, destroying the menu bar and removing it from the parent frame (if any).
+
\membersection{wxMenuBar::Append}\label{wxmenubarappend}
\func{bool}{Append}{\param{wxMenu *}{menu}, \param{const wxString\& }{title}}
\helpref{wxMenuBar::Insert}{wxmenubarinsert}
+
\membersection{wxMenuBar::Check}\label{wxmenubarcheck}
\func{void}{Check}{\param{int}{ id}, \param{const bool}{ check}}
Only use this when the menu bar has been associated
with a frame; otherwise, use the wxMenu equivalent call.
+
\membersection{wxMenuBar::Enable}\label{wxmenubarenable}
\func{void}{Enable}{\param{int}{ id}, \param{const bool}{ enable}}
Only use this when the menu bar has been
associated with a frame; otherwise, use the wxMenu equivalent call.
+
\membersection{wxMenuBar::EnableTop}\label{wxmenubarenabletop}
\func{void}{EnableTop}{\param{int}{ pos}, \param{const bool}{ enable}}
Only use this when the menu bar has been
associated with a frame.
+
\membersection{wxMenuBar::FindMenu}\label{wxmenubarfindmenu}
\constfunc{int}{FindMenu}{\param{const wxString\& }{title}}
the menu title (with accelerator characters, i.e. {\tt "\&File"}) or just the
menu label ({\tt "File"}) indifferently.
+
\membersection{wxMenuBar::FindMenuItem}\label{wxmenubarfindmenuitem}
\constfunc{int}{FindMenuItem}{\param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
Any special menu codes are stripped out of source and target strings
before matching.
+
\membersection{wxMenuBar::FindItem}\label{wxmenubarfinditem}
\constfunc{wxMenuItem *}{FindItem}{\param{int}{ id}, \param{wxMenu}{ **menu = NULL}}
The found menu item object, or NULL if one was not found.
+
\membersection{wxMenuBar::GetHelpString}\label{wxmenubargethelpstring}
\constfunc{wxString}{GetHelpString}{\param{int}{ id}}
\helpref{wxMenuBar::SetHelpString}{wxmenubarsethelpstring}
+
\membersection{wxMenuBar::GetLabel}\label{wxmenubargetlabel}
\constfunc{wxString}{GetLabel}{\param{int}{ id}}
Use only after the menubar has been associated with a frame.
+
\membersection{wxMenuBar::GetLabelTop}\label{wxmenubargetlabeltop}
\constfunc{wxString}{GetLabelTop}{\param{int}{ pos}}
\helpref{wxMenuBar::SetLabelTop}{wxmenubarsetlabeltop}
+
\membersection{wxMenuBar::GetMenu}\label{wxmenubargetmenu}
\constfunc{wxMenu*}{GetMenu}{\param{int}{ menuIndex}}
Returns the menu at {\it menuIndex} (zero-based).
+
\membersection{wxMenuBar::GetMenuCount}\label{wxmenubargetmenucount}
\constfunc{int}{GetMenuCount}{\void}
Returns the number of menus in this menubar.
+
\membersection{wxMenuBar::Insert}\label{wxmenubarinsert}
\func{bool}{Insert}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
\helpref{wxMenuBar::Append}{wxmenubarappend}
+
\membersection{wxMenuBar::IsChecked}\label{wxmenubarischecked}
\constfunc{bool}{IsChecked}{\param{int}{ id}}
true if the item was found and is checked, false otherwise.
+
\membersection{wxMenuBar::IsEnabled}\label{wxmenubarisenabled}
\constfunc{bool}{IsEnabled}{\param{int}{ id}}
true if the item was found and is enabled, false otherwise.
+
\membersection{wxMenuBar::Refresh}\label{wxmenubarrefresh}
\func{void}{Refresh}{\void}
Redraw the menu bar
+
\membersection{wxMenuBar::Remove}\label{wxmenubarremove}
\func{wxMenu *}{Remove}{\param{size\_t }{pos}}
\helpref{wxMenuBar::Replace}{wxmenubarreplace}
+
\membersection{wxMenuBar::Replace}\label{wxmenubarreplace}
\func{wxMenu *}{Replace}{\param{size\_t }{pos}, \param{wxMenu *}{menu}, \param{const wxString\& }{title}}
\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}
\helpref{wxMenuBar::Insert}{wxmenubarinsert},\rtfsp
\helpref{wxMenuBar::Remove}{wxmenubarremove}
+
\membersection{wxMenuBar::SetHelpString}\label{wxmenubarsethelpstring}
\func{void}{SetHelpString}{\param{int}{ id}, \param{const wxString\& }{helpString}}
\helpref{wxMenuBar::GetHelpString}{wxmenubargethelpstring}
+
\membersection{wxMenuBar::SetLabel}\label{wxmenubarsetlabel}
\func{void}{SetLabel}{\param{int}{ id}, \param{const wxString\& }{label}}
\helpref{wxMenuBar::GetLabel}{wxmenubargetlabel}
+
\membersection{wxMenuBar::SetLabelTop}\label{wxmenubarsetlabeltop}
\func{void}{SetLabelTop}{\param{int}{ pos}, \param{const wxString\& }{label}}
projects / wxWidgets.git / blobdiff