X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..066f3611df971be93b2ec46b82c2f05f3ff9a422:/docs/latex/wx/closeevt.tex?ds=sidebyside diff --git a/docs/latex/wx/closeevt.tex b/docs/latex/wx/closeevt.tex index 4a70a1707d..1684c16c86 100644 --- a/docs/latex/wx/closeevt.tex +++ b/docs/latex/wx/closeevt.tex @@ -18,12 +18,17 @@ to return {\tt true} or {\tt false} depending on whether the close instruction w \wxheading{Derived from} -\helpref{wxEvent}{wxevent} +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Event table macros} To process a close event, use these event handler macros to direct input to member @@ -42,19 +47,20 @@ This event applies to wxApp only.} \wxheading{See also} \helpref{wxWindow::Close}{wxwindowclose},\rtfsp -\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession},\rtfsp %% GD: OnXXX functions are not documented %%\helpref{wxApp::OnEndSession}{wxapponendsession},\rtfsp \helpref{Window deletion overview}{windowdeletionoverview} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxCloseEvent::wxCloseEvent} + +\membersection{wxCloseEvent::wxCloseEvent}\label{wxcloseeventctor} \func{}{wxCloseEvent}{\param{WXTYPE}{ commandEventType = 0}, \param{int}{ id = 0}} Constructor. + \membersection{wxCloseEvent::CanVeto}\label{wxcloseeventcanveto} \func{bool}{CanVeto}{\void} @@ -63,24 +69,15 @@ Returns true if you can veto a system shutdown or a window close event. Vetoing a window close event is not possible if the calling code wishes to force the application to exit, and so this function must be called to check this. + \membersection{wxCloseEvent::GetLoggingOff}\label{wxcloseeventgetloggingoff} \constfunc{bool}{GetLoggingOff}{\void} -Returns true if the user is logging off. - -\membersection{wxCloseEvent::GetSessionEnding}\label{wxcloseeventgetsessionending} - -\constfunc{bool}{GetSessionEnding}{\void} +Returns true if the user is just logging off or false if the system is +shutting down. This method can only be called for end session and query end +session events, it doesn't make sense for close window event. -Returns true if the session is ending. - -\membersection{wxCloseEvent::GetForce}\label{wxcloseeventgetforce} - -\constfunc{bool}{GetForce}{\void} - -Returns true if the application wishes to force the window to close. -This will shortly be obsolete, replaced by CanVeto. \membersection{wxCloseEvent::SetCanVeto}\label{wxcloseeventsetcanveto} @@ -88,18 +85,21 @@ This will shortly be obsolete, replaced by CanVeto. Sets the 'can veto' flag. + \membersection{wxCloseEvent::SetForce}\label{wxcloseeventsetforce} \constfunc{void}{SetForce}{\param{bool}{ force}} Sets the 'force' flag. + \membersection{wxCloseEvent::SetLoggingOff}\label{wxcloseeventsetloggingoff} \constfunc{void}{SetLoggingOff}{\param{bool}{ loggingOff}} Sets the 'logging off' flag. + \membersection{wxCloseEvent::Veto}\label{wxcloseeventveto} \func{void}{Veto}{\param{bool}{ veto = true}}