]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/closeevt.tex
Added periods
[wxWidgets.git] / docs / latex / wx / closeevt.tex
index 9c90c4f5f31a86adf393928b39328f8ccac94473..44432451bc1fa0a268c08f6f196d7663b670f77b 100644 (file)
@@ -24,6 +24,10 @@ to return {\tt true} or {\tt false} depending on whether the close instruction w
 
 <wx/event.h>
 
+\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 +46,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}\label{wxcloseeventctor}
 
 \func{}{wxCloseEvent}{\param{WXTYPE}{ commandEventType = 0}, \param{int}{ id = 0}}
 
 Constructor.
 
+
 \membersection{wxCloseEvent::CanVeto}\label{wxcloseeventcanveto}
 
 \func{bool}{CanVeto}{\void}
@@ -63,24 +68,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 +84,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}}