docs/latex/wx/closeevt.tex

   1 \section{\class{wxCloseEvent}}\label{wxcloseevent}
   2
   3 This event class contains information about window and session close events.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxEvent}{wxevent}
   8
   9 \wxheading{Event table macros}
  10
  11 To process a close event, use these event handler macros to direct input to member
  12 functions that take a wxCloseEvent argument.
  13
  14 \twocolwidtha{7cm}
  15 \begin{twocollist}\itemsep=0pt
  16 \twocolitem{{\bf EVT\_CLOSE(func)}}{Process a close event, supplying the member function.}
  17 \end{twocollist}%
  18
  19 \wxheading{See also}
  20
  21 \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
  22 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
  23 \helpref{Window deletion overview}{windowdeletionoverview}
  24
  25 \latexignore{\rtfignore{\wxheading{Members}}}
  26
  27 \membersection{wxCloseEvent::wxCloseEvent}
  28
  29 \func{}{wxCloseEvent}{\param{WXTYPE}{ commandEventType = 0}, \param{int}{ id = 0}}
  30
  31 Constructor.
  32
  33 \membersection{wxCloseEvent::GetLoggingOff}\label{wxcloseeventgetloggingoff}
  34
  35 \constfunc{bool}{GetLoggingOff}{\void}
  36
  37 Returns TRUE if the user is logging off.
  38
  39 \membersection{wxCloseEvent::GetSessionEnding}\label{wxcloseeventgetsessionending}
  40
  41 \constfunc{bool}{GetSessionEnding}{\void}
  42
  43 Returns TRUE if the session is ending.
  44
  45 \membersection{wxCloseEvent::GetForce}\label{wxcloseeventgetforce}
  46
  47 \constfunc{void}{GetForce}{\void}
  48
  49 Returns TRUE if the application wishes to force the window to close.
  50
  51 \membersection{wxCloseEvent::Veto}\label{wxcloseeventveto}
  52
  53 \func{void}{Veto}{\void}
  54
  55 Call this from your event handler to veto a system shutdown.
  56
  57