Fixed problem with Calltip tab not refreshing properly on Windows.

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

diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex
index 5a42e562f84cd975ecc6e3fc78acb80aec227c85..763028545f53b511b741f85ce670dce2979529d6 100644 (file)
--- a/docs/latex/wx/menu.tex
+++ b/docs/latex/wx/menu.tex
@@ -103,19 +103,19 @@ and recreation of internal data structures.
 
 \membersection{wxMenu::Append}\label{wxmenuappend}
 
 
 \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.
 
 \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.
 
 \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
 
 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


@@ -134,7 +134,7 @@ such as bitmaps and fonts.
 {\tt wxITEM\_CHECK} or {\tt wxITEM\_RADIO}}
 
 \docparam{helpString}{An optional help string associated with the item.
 {\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
 this string in the status line.}
 
 \docparam{menuItem}{A menuitem object. It will be owned by the wxMenu object after this function


@@ -145,6 +145,32 @@ is called, so do not delete it yourself.}
 This command can be used after the menu has been shown, as well as on initial
 creation of a menu or menubar.
 
 This command can be used after the menu has been shown, as well as on initial
 creation of a menu or menubar.
 

+The {\it item} string for the normal menu items (not submenus or separators)
+may include the accelerator which can be used to activate the menu item
+from keyboard. The accelerator string follows the item label and is separated
+from it by a {\tt TAB} character ({\tt '$\backslash$t'}). Its general syntax is
+any combination of {\tt "CTRL"}, {\tt "ALT"} and {\tt "SHIFT"} strings (case
+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}
+\twocolitem{{\tt ENTER} or {\tt RETURN}}{Enter key}
+\twocolitem{{\tt PGUP}}{PageUp key}
+\twocolitem{{\tt PGDN}}{PageDown key}
+\twocolitem{{\tt LEFT}}{Left cursor arrow key}
+\twocolitem{{\tt RIGHT}}{Right cursor arrow key}
+\twocolitem{{\tt UP}}{Up cursor arrow key}
+\twocolitem{{\tt DOWN}}{Down cursor arrow key}
+\twocolitem{{\tt HOME}}{Home key}
+\twocolitem{{\tt END}}{End key}
+\twocolitem{{\tt SPACE}}{Space}
+\twocolitem{{\tt TAB}}{Tab key}
+\twocolitem{{\tt ESC} or {\tt ESCAPE}}{Escape key (Windows only)}
+\end{twocollist}
+

 \wxheading{See also}
 
 \helpref{wxMenu::AppendSeparator}{wxmenuappendseparator},\rtfsp
 \wxheading{See also}
 
 \helpref{wxMenu::AppendSeparator}{wxmenuappendseparator},\rtfsp


@@ -157,7 +183,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}}


@@ -165,7 +191,7 @@ implements the following methods:\par
 
 \membersection{wxMenu::AppendCheckItem}\label{wxmenuappendcheckitem}
 
 
 \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.
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
 
 Adds a checkable item to the end of the menu.


@@ -177,7 +203,7 @@ Adds a checkable item to the end of the menu.
 
 \membersection{wxMenu::AppendRadioItem}\label{wxmenuappendradioitem}
 
 
 \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
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
 
 Adds a radio item to the end of the menu. All consequent radio items form a


@@ -194,7 +220,7 @@ automatically unchecked.
 
 \membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator}
 
 
 \membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator}
 

-\func{void}{AppendSeparator}{\void}
+\func{wxMenuItem*}{AppendSeparator}{\void}

 
 Adds a separator to the end of the menu.
 
 
 Adds a separator to the end of the menu.
 


@@ -219,7 +245,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}
 


@@ -279,7 +305,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}
 


@@ -323,6 +349,12 @@ before matching.
 \pythonnote{The name of this method in wxPython is {\tt FindItemById} 
 and it does not support the second parameter.}
 
 \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::GetHelpString}\label{wxmenugethelpstring}
 
 \constfunc{wxString}{GetHelpString}{\param{int}{ id}}


@@ -391,9 +423,9 @@ menubar.
 
 \membersection{wxMenu::Insert}\label{wxmenuinsert}
 
 
 \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}}
 
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp
 \param{wxItemKind}{ kind = wxITEM\_NORMAL}}
 


@@ -408,7 +440,7 @@ as appending it.
 
 \membersection{wxMenu::InsertCheckItem}\label{wxmenuinsertcheckitem}
 
 
 \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.
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
 
 Inserts a checkable item at the given position.


@@ -420,7 +452,7 @@ Inserts a checkable item at the given position.
 
 \membersection{wxMenu::InsertRadioItem}\label{wxmenuinsertradioitem}
 
 
 \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.
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
 
 Inserts a radio item at the given position.


@@ -432,7 +464,7 @@ Inserts a radio item at the given position.
 
 \membersection{wxMenu::InsertSeparator}\label{wxmenuinsertseparator}
 
 
 \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.
 
 
 Inserts a separator at the given position.
 


@@ -453,7 +485,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}
 


@@ -471,7 +503,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}
 


@@ -479,13 +511,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{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}}
 
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""},\rtfsp
 \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}
 


@@ -494,7 +527,7 @@ Inserts the given {\it item} at the position $0$.
 
 \membersection{wxMenu::PrependCheckItem}\label{wxmenuprependcheckitem}
 
 
 \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$.
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
 
 Inserts a checkable item at the position $0$.


@@ -506,7 +539,7 @@ Inserts a checkable item at the position $0$.
 
 \membersection{wxMenu::PrependRadioItem}\label{wxmenuprependradioitem}
 
 
 \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$.
 \param{const wxString\& }{ item}, \param{const wxString\& }{helpString = ""}}
 
 Inserts a radio item at the position $0$.


@@ -518,7 +551,7 @@ Inserts a radio item at the position $0$.
 
 \membersection{wxMenu::PrependSeparator}\label{wxmenuprependseparator}
 
 
 \membersection{wxMenu::PrependSeparator}\label{wxmenuprependseparator}
 

-\func{void}{PrependSeparator}{\param{size\_t }{pos}}
+\func{wxMenuItem*}{PrependSeparator}{\param{size\_t }{pos}}

 
 Inserts a separator at the position $0$.
 
 
 Inserts a separator at the position $0$.
 


@@ -617,6 +650,7 @@ A menu bar is a series of menus accessible from the top of a frame.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

+\helpref{wxWindow}{wxwindow}\\

 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 


@@ -695,7 +729,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}
 


@@ -711,7 +745,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}
 


@@ -728,7 +762,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}
 


@@ -745,7 +779,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}
 


@@ -890,7 +924,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}
 


@@ -908,7 +942,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}
 


@@ -922,7 +956,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}