fix warning

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

diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex
index d6cab4486b655686c432106ee41461ec6cd8e1d1..5bc1600cb86ff51d741e8a81b3726fbcfa464a8f 100644 (file)
--- a/docs/latex/wx/menuevt.tex
+++ b/docs/latex/wx/menuevt.tex
@@ -4,7 +4,7 @@ This class is used for a variety of menu-related events. Note that
 these do not include menu command events, which are
 handled using \helpref{wxCommandEvent}{wxcommandevent} objects.
 
 these do not include menu command events, which are
 handled using \helpref{wxCommandEvent}{wxcommandevent} objects.
 

-The handler \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help
+The default handler for wxEVT\_MENU\_HIGHLIGHT displays help

 text in the first field of the status bar.
 
 \wxheading{Derived from}
 text in the first field of the status bar.
 
 \wxheading{Derived from}


@@ -23,14 +23,15 @@ functions that take a wxMenuEvent argument.
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt

-\twocolitem{{\bf EVT\_MENU\_OPEN(func)}}{A menu is about to be opened.}
+\twocolitem{{\bf EVT\_MENU\_OPEN(func)}}{A menu is about to be opened. On Windows,
+this is only sent once for each navigation of the menubar (up until all menus have closed).}

 \twocolitem{{\bf EVT\_MENU\_CLOSE(func)}}{A menu has been just closed.}
 \twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(id, func)}}{The menu item with the
 specified id has been highlighted: used to show help prompts in the status bar
 by \helpref{wxFrame}{wxframe}}
 \twocolitem{{\bf EVT\_MENU\_HIGHLIGHT\_ALL(func)}}{A menu item has been
 highlighted, i.e. the currently selected menu item has changed.}
 \twocolitem{{\bf EVT\_MENU\_CLOSE(func)}}{A menu has been just closed.}
 \twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(id, func)}}{The menu item with the
 specified id has been highlighted: used to show help prompts in the status bar
 by \helpref{wxFrame}{wxframe}}
 \twocolitem{{\bf EVT\_MENU\_HIGHLIGHT\_ALL(func)}}{A menu item has been
 highlighted, i.e. the currently selected menu item has changed.}

-\end{twocollist}%
+\end{twocollist}

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


@@ -39,18 +40,29 @@ highlighted, i.e. the currently selected menu item has changed.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxMenuEvent::wxMenuEvent}
 
 \func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
 
 Constructor.
 
 \membersection{wxMenuEvent::wxMenuEvent}
 
 \func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
 
 Constructor.
 

+

 \membersection{wxMenuEvent::m\_menuId}
 
 \member{int}{m\_menuId}
 
 The relevant menu identifier.
 
 \membersection{wxMenuEvent::m\_menuId}
 
 \member{int}{m\_menuId}
 
 The relevant menu identifier.
 

+
+\membersection{wxMenuEvent::GetMenu}\label{wxmenueventgetmenu}
+
+\constfunc{wxMenu *}{GetMenu}{\void}
+
+Returns the menu which is being opened or closed. This method should be only
+used with the \texttt{OPEN} and \texttt{CLOSE} events.
+
+

 \membersection{wxMenuEvent::GetMenuId}\label{wxmenueventgetmenuid}
 
 \constfunc{int}{GetMenuId}{\void}
 \membersection{wxMenuEvent::GetMenuId}\label{wxmenueventgetmenuid}
 
 \constfunc{int}{GetMenuId}{\void}


@@ -58,6 +70,7 @@ The relevant menu identifier.
 Returns the menu identifier associated with the event. This method should be
 only used with the {\tt HIGHLIGHT} events.
 
 Returns the menu identifier associated with the event. This method should be
 only used with the {\tt HIGHLIGHT} events.
 

+

 \membersection{wxMenuEvent::IsPopup}\label{wxmenueventispopup}
 
 \constfunc{bool}{IsPopup}{\void}
 \membersection{wxMenuEvent::IsPopup}\label{wxmenueventispopup}
 
 \constfunc{bool}{IsPopup}{\void}