X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c436b310655047ec56f9f49668bf7dc7f98ac2cf..65baafba0e8cd74f2264b7e2f7625ff5bea84864:/docs/latex/wx/menu.tex?ds=sidebyside diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index 074289b494..7daf283906 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 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 @@ -9,11 +20,12 @@ 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 +{\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). +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 @@ -30,8 +42,8 @@ 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. +the radio items risks to not work correctly. Finally note that radio items +are not supported under Motif. \wxheading{Allocation strategy} @@ -70,7 +82,10 @@ not be used in the new code, it is provided for backwards compatibility only. \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}}} @@ -559,7 +574,7 @@ Inserts a radio item at position $0$. \membersection{wxMenu::PrependSeparator}\label{wxmenuprependseparator} -\func{wxMenuItem*}{PrependSeparator}{\param{size\_t }{pos}} +\func{wxMenuItem*}{PrependSeparator}{\void} Inserts a separator at position $0$. @@ -686,11 +701,11 @@ menu shortcuts may cease to work. \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. @@ -706,10 +721,10 @@ 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 constructor: -use {\tt Append} instead.} +use \helpref{wxMenuBar::Append}{wxmenubarappend} instead.} \membersection{wxMenuBar::\destruct{wxMenuBar}}\label{wxmenubardtor}