fix LaTeX error (escape underscores); don't abuse bold face

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

\section{\class{wxContextMenuEvent}}\label{wxcontextmenuevent}

This class is used for context menu events, sent to give
the application a chance to show a context (popup) menu.

Note that if \helpref{GetPosition}{wxcontextmenueventgetposition} returns wxDefaultPosition, this means that the event originated
from a keyboard context button event, and you should compute a suitable position yourself,
for example by calling \helpref{wxGetMousePosition}{wxgetmouseposition}.

When a keyboard context menu button is pressed on Windows, a right-click event with default position is sent first,
and if this event is not processed, the context menu event is sent. So if you process mouse events and you find your context menu event handler
is not being called, you could call wxEvent::Skip for mouse right-down events.

\wxheading{Derived from}

\helpref{wxCommandEvent}{wxcommandevent}\\
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<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
functions that take a wxContextMenuEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_CONTEXT\_MENU(func)}}{A right click (or other context menu command depending on platform) has been detected.}
\end{twocollist}

\wxheading{See also}

\helpref{Command events}{wxcommandevent},\\
\helpref{Event handling overview}{eventhandlingoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxContextMenuEvent::wxContextMenuEvent}\label{wxcontextmenueventctor}

\func{}{wxContextMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{const wxPoint\&}{ pos=wxDefaultPosition}}

Constructor.

\membersection{wxContextMenuEvent::GetPosition}\label{wxcontextmenueventgetposition}

\constfunc{wxPoint}{GetPosition}{\void}

Returns the position in screen coordinates at which the menu should be shown. Use \helpref{wxWindow::ScreenToClient}{wxwindowscreentoclient} to
convert to client coordinates. You can also omit a position from \helpref{wxWindow::PopupMenu}{wxwindowpopupmenu} in order to use
the current mouse pointer position.

If the event originated from a keyboard event, the value returned from this function will be wxDefaultPosition.

\membersection{wxContextMenuEvent::SetPosition}\label{wxcontextmenueventsetposition}

\func{void}{SetPosition}{\param{const wxPoint\&}{ point}}

Sets the position at which the menu should be shown.