added missing const

[wxWidgets.git] / docs / latex / wx / menu.tex

diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex
index 4f04df6731831ef048dab25549c2fd3f051f68aa..cf33986ac3dc500465059c83a20041a4c95fd69f 100644 (file)
--- a/docs/latex/wx/menu.tex
+++ b/docs/latex/wx/menu.tex
@@ -12,7 +12,7 @@ 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.
 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 togles the flag value when the item is clicked and its
+wxWindows 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
 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


@@ -27,6 +27,13 @@ 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 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}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \wxheading{Derived from}
 
 \helpref{wxEvtHandler}{wxevthandler}\\


@@ -97,14 +104,16 @@ 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
 \membersection{wxMenu::Append}\label{wxmenuappend}
 
 \func{void}{Append}{\param{int}{ id}, \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp

-\param{wxItemKind}{ kind = wxItem\_Normal}}
+\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
 \param{const wxString\& }{helpString = ""}}
 
 
 Adds a string item to the end of the menu.
 
 \func{void}{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{void}{Append}{\param{wxMenuItem*}{ menuItem}}
 


@@ -121,8 +130,8 @@ such as bitmaps and fonts.
 
 \docparam{menu}{Pull-right submenu.}
 
 
 \docparam{menu}{Pull-right submenu.}
 

-\docparam{kind}{May be {\tt wxItem\_Separator}, {\tt wxItem\_Normal}, 
-{\tt wxItem\_Check} or {\tt wxItem\_Radio}}
+\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
 
 \docparam{helpString}{An optional help string associated with the item.
 By default, \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays


@@ -148,7 +157,7 @@ creation of a menu or menubar.
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 \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}}
 \twocolitem{{\bf AppendMenu(id, string, aMenu, helpStr="")}}{}
 \twocolitem{{\bf AppendItem(aMenuItem)}}{}
 \end{twocollist}}


@@ -176,7 +185,7 @@ 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
 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.
+{\tt\#if wxHAS\_RADIO\_MENU\_ITEMS} to test for availability of this feature.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -210,7 +219,7 @@ Checks or unchecks the menu item.
 
 \docparam{id}{The menu item identifier.}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -270,7 +279,7 @@ Enables or disables (greys out) a menu item.
 
 \docparam{id}{The menu item identifier.}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -372,7 +381,9 @@ Returns the title of the menu.
 
 \wxheading{Remarks}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -384,7 +395,7 @@ This is relevant only to popup menus.
 
 \func{void}{Insert}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp
 
 \func{void}{Insert}{\param{size\_t }{pos}, \param{int}{ id},\rtfsp
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp

-\param{wxItemKind}{ kind = wxItem\_Normal}}
+\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
 
 Inserts the given {\it item} before the position {\it pos}. Inserting the item
 at the position \helpref{GetMenuItemCount}{wxmenugetmenuitemcount} is the same


@@ -442,7 +453,7 @@ Determines whether a menu item is checked.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the menu item is checked, FALSE otherwise.
+true if the menu item is checked, false otherwise.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -460,7 +471,7 @@ Determines whether a menu item is enabled.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the menu item is enabled, FALSE otherwise.
+true if the menu item is enabled, false otherwise.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -468,13 +479,14 @@ TRUE if the menu item is enabled, FALSE otherwise.
 
 \membersection{wxMenu::Prepend}\label{wxmenuprepend}
 
 
 \membersection{wxMenu::Prepend}\label{wxmenuprepend}
 

-\func{bool}{Prepend}{\param{size\_t }{pos}, \param{wxMenuItem *}{item}}
+\func{bool}{Prepend}{\param{wxMenuItem *}{item}}

 
 \func{void}{Prepend}{\param{int}{ id},\rtfsp
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp
 
 \func{void}{Prepend}{\param{int}{ id},\rtfsp
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp

-\param{wxItemKind}{ kind = wxItem\_Normal}}
+\param{wxItemKind}{ kind = wxITEM\_NORMAL}}

 
 

-Inserts the given {\it item} at the position $0$.
+Inserts the given {\it item} at the position $0$, i.e. before all the other
+existing items.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -580,11 +592,13 @@ Sets the title of the menu.
 
 \wxheading{Remarks}
 
 
 \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}
 
 
 \wxheading{See also}
 

-\helpref{wxMenu::SetTitle}{wxmenusettitle}
+\helpref{wxMenu::GetTitle}{wxmenugettitle}

 
 \membersection{wxMenu::UpdateUI}\label{wxmenuupdateui}
 
 
 \membersection{wxMenu::UpdateUI}\label{wxmenuupdateui}
 


@@ -659,7 +673,7 @@ menu bar.}
 \pythonnote{Only the default constructor is supported in wxPython.
 Use wxMenuBar.Append instead.}
 
 \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}}
 use {\tt Append} instead.}
 
 \membersection{wxMenuBar::\destruct{wxMenuBar}}


@@ -682,7 +696,7 @@ Adds the item to the end of the menu bar.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE on success, FALSE if an error occurred.
+true on success, false if an error occurred.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -698,7 +712,7 @@ Checks or unchecks a menu item.
 
 \docparam{id}{The menu item identifier.}
 
 
 \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}
 
 
 \wxheading{Remarks}
 


@@ -715,7 +729,7 @@ Enables or disables (greys out) a menu item.
 
 \docparam{id}{The menu item identifier.}
 
 
 \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}
 
 
 \wxheading{Remarks}
 


@@ -732,7 +746,7 @@ Enables or disables a whole menu.
 
 \docparam{pos}{The position of the menu, starting from zero.}
 
 
 \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}
 
 
 \wxheading{Remarks}
 


@@ -789,7 +803,7 @@ The found menu item object, or NULL if one was not found.
 
 \constfunc{wxString}{GetHelpString}{\param{int}{ id}}
 
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -826,7 +840,9 @@ Use only after the menubar has been associated with a frame.
 
 \constfunc{wxString}{GetLabelTop}{\param{int}{ pos}}
 
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -875,7 +891,7 @@ position $0$ will insert it in the very beginning of it, inserting at position
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE on success, FALSE if an error occurred.
+true on success, false if an error occurred.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -893,7 +909,7 @@ Determines whether an item is checked.
 
 \wxheading{Return value}
 
 
 \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}
 
 
 \membersection{wxMenuBar::IsEnabled}\label{wxmenubarisenabled}
 


@@ -907,7 +923,7 @@ Determines whether an item is enabled.
 
 \wxheading{Return value}
 
 
 \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}
 
 
 \membersection{wxMenuBar::Refresh}\label{wxmenubarrefresh}