Added logic, API and docs for wxDataViewModel::HasDefaultCompare indicating a compare...

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

diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex
index d5a7f29a39736d8c614612eee0d21db52b6bb159..a6d1d45d3677553f016a9918ec11dbabb12b8a65 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}


@@ -16,21 +16,27 @@ text in the first field of the status bar.
 
 <wx/event.h>
 
 
 <wx/event.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Event table macros}
 
 To process a menu event, use these event handler macros to direct input to member
 \wxheading{Event table macros}
 
 To process a menu event, use these event handler macros to direct input to member

-functions that take a wxMenuEvent argument.
+functions that take a wxMenuEvent argument. They can only be processed by
+a menubar's frame.

 
 \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,17 +45,22 @@ 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}}
+\membersection{wxMenuEvent::wxMenuEvent}\label{wxmenueventctor}
+
+\func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxMenu* }{menu = NULL}}

 
 Constructor.
 
 
 Constructor.
 

-\membersection{wxMenuEvent::m\_menuId}

 
 

-\member{int}{m\_menuId}
+\membersection{wxMenuEvent::GetMenu}\label{wxmenueventgetmenu}
+
+\constfunc{wxMenu *}{GetMenu}{\void}
+
+Returns the menu which is being opened or closed. This method should only be
+used with the \texttt{OPEN} and \texttt{CLOSE} events and even for them the
+returned pointer may be \NULL in some ports.

 
 

-The relevant menu identifier.

 
 \membersection{wxMenuEvent::GetMenuId}\label{wxmenueventgetmenuid}
 
 
 \membersection{wxMenuEvent::GetMenuId}\label{wxmenueventgetmenuid}
 


@@ -58,13 +69,14 @@ 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}
 

-Returns {\tt TRUE} if the menu which is being opened or closed is a popup menu, 
-{\tt FALSE} if it is a normal one.
+Returns {\tt true} if the menu which is being opened or closed is a popup menu, 
+{\tt false} if it is a normal one.

 
 

-This method should be only used with the {\tt OPEN} and {\tt CLOSE} events.
+This method should only be used with the {\tt OPEN} and {\tt CLOSE} events.