Added logic, API and docs for wxDataViewModel::HasDefaultCompare indicating a compare...

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

diff --git a/docs/latex/wx/activevt.tex b/docs/latex/wx/activevt.tex
index 6eca563147e88030a9fc6018164249a6e16a62bc..c507ff729f7892e8bf4e8a94626bc5a6f0bf0320 100644 (file)
--- a/docs/latex/wx/activevt.tex
+++ b/docs/latex/wx/activevt.tex
@@ -8,6 +8,14 @@ or deactivated.
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/event.h>
+
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Event table macros}
 
 To process an activate event, use these event handler macros to direct input to a member
 \wxheading{Event table macros}
 
 To process an activate event, use these event handler macros to direct input to a member


@@ -17,40 +25,40 @@ function that takes a wxActivateEvent argument.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_ACTIVATE(func)}}{Process a wxEVT\_ACTIVATE event.}
 \twocolitem{{\bf EVT\_ACTIVATE\_APP(func)}}{Process a wxEVT\_ACTIVATE\_APP event.}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_ACTIVATE(func)}}{Process a wxEVT\_ACTIVATE event.}
 \twocolitem{{\bf EVT\_ACTIVATE\_APP(func)}}{Process a wxEVT\_ACTIVATE\_APP event.}

+\twocolitem{{\bf EVT\_HIBERNATE(func)}}{Process a hibernate event, supplying the member function.
+This event applies to wxApp only, and only on Windows SmartPhone and PocketPC. It is generated when the
+system is low on memory; the application should free up as much memory as possible, and restore
+full working state when it receives a wxEVT\_ACTIVATE or wxEVT\_ACTIVATE\_APP event.}

 \end{twocollist}%
 
 \wxheading{Remarks}
 
 \end{twocollist}%
 
 \wxheading{Remarks}
 

-A top-level window (a dialog or frame) receives an activate event when is
+A top-level window (a dialog or frame) receives an activate event when it is

 being activated or deactivated. This is indicated visually by the title
 bar changing colour, and a subwindow gaining the keyboard focus.
 
 An application is activated or deactivated when one of its frames becomes activated,
 being activated or deactivated. This is indicated visually by the title
 bar changing colour, and a subwindow gaining the keyboard focus.
 
 An application is activated or deactivated when one of its frames becomes activated,

-or a frame becomes inactivate resulting in all application frames being inactive. (Windows only)
+or a frame becomes inactivated resulting in all application frames being inactive.
+
+Please note that usually you should call \helpref{event.Skip()}{wxeventskip} in
+your handlers for these events as not doing so can result in strange effects.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxWindow::OnActivate}{wxwindowonactivate},\rtfsp
-\helpref{wxApp::OnActivate}{wxapponactivate},\rtfsp
-\helpref{Event handling overview}{eventhandlingoverview}
+\helpref{Event handling overview}{eventhandlingoverview},\rtfsp
+\helpref{wxApp::IsActive}{wxappisactive}

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

-\membersection{wxActivateEvent::wxActivateEvent}
+\membersection{wxActivateEvent::wxActivateEvent}\label{wxactivateeventctor}

 
 

-\func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{int }{id = 0}}
+\func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = true}, \param{int }{id = 0}}

 
 Constructor.
 
 
 Constructor.
 

-\membersection{wxActivateEvent::m\_active}
-
-\member{bool}{m\_active}
-
-TRUE if the window or application was activated.
-

 \membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive}
 
 \constfunc{bool}{GetActive}{\void}
 
 \membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive}
 
 \constfunc{bool}{GetActive}{\void}
 

-Returns TRUE if the application or window is being activated, FALSE otherwise.
+Returns true if the application or window is being activated, false otherwise.