projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxActivateEvent}}\label{wxactivateevent} |
| 2 | ||
| 3 | An activate event is sent when a window or application is being activated | |
| 4 | or deactivated. | |
| 5 | ||
| 6 | \wxheading{Derived from} | |
| 7 | ||
| 8 | \helpref{wxEvent}{wxevent}\\ | |
| 9 | \helpref{wxObject}{wxobject} | |
| 10 | ||
| 954b8ae6 JS |
11 | \wxheading{Include files} |
| 12 | ||
| 13 | <wx/event.h> | |
| 14 | ||
| a660d684 KB |
15 | \wxheading{Event table macros} |
| 16 | ||
| 17 | To process an activate event, use these event handler macros to direct input to a member | |
| 18 | function that takes a wxActivateEvent argument. | |
| 19 | ||
| 20 | \twocolwidtha{7cm} | |
| 21 | \begin{twocollist}\itemsep=0pt | |
| 22 | \twocolitem{{\bf EVT\_ACTIVATE(func)}}{Process a wxEVT\_ACTIVATE event.} | |
| 23 | \twocolitem{{\bf EVT\_ACTIVATE\_APP(func)}}{Process a wxEVT\_ACTIVATE\_APP event.} | |
| 24 | \end{twocollist}% | |
| 25 | ||
| 26 | \wxheading{Remarks} | |
| 27 | ||
| 28 | A top-level window (a dialog or frame) receives an activate event when is | |
| 29 | being activated or deactivated. This is indicated visually by the title | |
| 30 | bar changing colour, and a subwindow gaining the keyboard focus. | |
| 31 | ||
| 32 | An application is activated or deactivated when one of its frames becomes activated, | |
| 33 | or a frame becomes inactivate resulting in all application frames being inactive. (Windows only) | |
| 34 | ||
| 35 | \wxheading{See also} | |
| 36 | ||
| f4fcc291 | 37 | %\helpref{wxWindow::OnActivate}{wxwindowonactivate},\rtfsp |
| 4d5a0f67 GD |
38 | %% GD: OnXXX functions are not documented |
| 39 | %%\helpref{wxApp::OnActivate}{wxapponactivate},\rtfsp | |
| a660d684 KB |
40 | \helpref{Event handling overview}{eventhandlingoverview} |
| 41 | ||
| 42 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 43 | ||
| 44 | \membersection{wxActivateEvent::wxActivateEvent} | |
| 45 | ||
| cc81d32f | 46 | \func{}{wxActivateEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = true}, \param{int }{id = 0}} |
| a660d684 KB |
47 | |
| 48 | Constructor. | |
| 49 | ||
| 50 | \membersection{wxActivateEvent::m\_active} | |
| 51 | ||
| 52 | \member{bool}{m\_active} | |
| 53 | ||
| cc81d32f | 54 | true if the window or application was activated. |
| a660d684 KB |
55 | |
| 56 | \membersection{wxActivateEvent::GetActive}\label{wxactivateeventgetactive} | |
| 57 | ||
| 58 | \constfunc{bool}{GetActive}{\void} | |
| 59 | ||
| cc81d32f | 60 | Returns true if the application or window is being activated, false otherwise. |
| a660d684 | 61 |