X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/387a3b02e02d91da6c5d4331b667d835e32c83b0..a947a1e5e8a15b76d142eb91cb08e2e9ffb95def:/docs/latex/wx/closeevt.tex

diff --git a/docs/latex/wx/closeevt.tex b/docs/latex/wx/closeevt.tex
index 19576f9e7f..5e540e5afb 100644
--- a/docs/latex/wx/closeevt.tex
+++ b/docs/latex/wx/closeevt.tex
@@ -2,10 +2,28 @@
 
 This event class contains information about window and session close events.
 
+The handler function for EVT\_CLOSE is called when the user has tried to close a a frame
+or dialog box using the window manager (X) or system menu (Windows). It can
+also be invoked by the application itself programmatically, for example by
+calling the \helpref{wxWindow::Close}{wxwindowclose} function.
+
+You should check whether the application is forcing the deletion of the window
+using \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto}. If this is {\tt false},
+you {\it must} destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
+If the return value is true, it is up to you whether you respond by destroying the window.
+
+If you don't destroy the window, you should call \helpref{wxCloseEvent::Veto}{wxcloseeventveto} to
+let the calling code know that you did not destroy the window. This allows the \helpref{wxWindow::Close}{wxwindowclose} function
+to return {\tt true} or {\tt false} depending on whether the close instruction was honoured or not.
+
 \wxheading{Derived from}
 
 \helpref{wxEvent}{wxevent}
 
+\wxheading{Include files}
+
+<wx/event.h>
+
 \wxheading{Event table macros}
 
 To process a close event, use these event handler macros to direct input to member
@@ -17,21 +35,20 @@ functions that take a wxCloseEvent argument.
 event applies to wxFrame and wxDialog classes.}
 \twocolitem{{\bf EVT\_QUERY\_END\_SESSION(func)}}{Process a query end session event, supplying the member function.
 This event applies to wxApp only.}
-\twocolitem{{\bf EVT\__END\_SESSION(func)}}{Process an end session event, supplying the member function.
+\twocolitem{{\bf EVT\_END\_SESSION(func)}}{Process an end session event, supplying the member function.
 This event applies to wxApp only.}
 \end{twocollist}%
 
 \wxheading{See also}
 
-\helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
 \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
-\helpref{wxApp::OnQueryEndSession}{wxappqueryendsession},\rtfsp
-\helpref{wxApp::OnEndSession}{wxappendsession},\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}}
 
@@ -41,7 +58,7 @@ Constructor.
 
 \func{bool}{CanVeto}{\void}
 
-Returns TRUE if you can veto a system shutdown or a window close event.
+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.
 
@@ -49,19 +66,13 @@ force the application to exit, and so this function must be called to check this
 
 \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 session is ending.
+Returns true if the user is logging off.
 
 \membersection{wxCloseEvent::GetForce}\label{wxcloseeventgetforce}
 
 \constfunc{bool}{GetForce}{\void}
 
-Returns TRUE if the application wishes to force the window to close.
+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}
@@ -84,12 +95,12 @@ Sets the 'logging off' flag.
 
 \membersection{wxCloseEvent::Veto}\label{wxcloseeventveto}
 
-\func{void}{Veto}{\param{bool}{ veto = TRUE}}
+\func{void}{Veto}{\param{bool}{ veto = true}}
 
 Call this from your event handler to veto a system shutdown or to signal
 to the calling application that a window close did not happen.
 
 You can only veto a shutdown if \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto} returns
-TRUE.
+true.
 
 
