projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxIdleEvent}}\label{wxidleevent} |
| 2 | ||
| 3 | This class is used for idle events, which are generated when the system is idle. | |
| 4 | ||
| 5 | \wxheading{Derived from} | |
| 6 | ||
| 7 | \helpref{wxEvent}{wxevent}\\ | |
| 8 | \helpref{wxObject}{wxobject} | |
| 9 | ||
| 954b8ae6 JS |
10 | \wxheading{Include files} |
| 11 | ||
| 12 | <wx/event.h> | |
| 13 | ||
| a660d684 KB |
14 | \wxheading{Event table macros} |
| 15 | ||
| 16 | To process an idle event, use this event handler macro to direct input to a member | |
| 17 | function that takes a wxIdleEvent argument. | |
| 18 | ||
| 19 | \twocolwidtha{7cm} | |
| 20 | \begin{twocollist}\itemsep=0pt | |
| 21 | \twocolitem{{\bf EVT\_IDLE(func)}}{Process a wxEVT\_IDLE event.} | |
| 22 | \end{twocollist}% | |
| 23 | ||
| 24 | \wxheading{Remarks} | |
| 25 | ||
| 26 | Idle events can be caught by the wxApp class, or by top-level window classes. | |
| 27 | ||
| 28 | \wxheading{See also} | |
| 29 | ||
| 4d5a0f67 GD |
30 | %% GD: OnXXX functions are not documented |
| 31 | %%\helpref{wxApp::OnIdle}{wxapponidle}, | |
| 32 | \helpref{Event handling overview}{eventhandlingoverview} | |
| a660d684 KB |
33 | |
| 34 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 35 | ||
| 36 | \membersection{wxIdleEvent::wxIdleEvent} | |
| 37 | ||
| 38 | \func{}{wxIdleEvent}{\void} | |
| 39 | ||
| 40 | Constructor. | |
| 41 | ||
| 42 | \membersection{wxIdleEvent::RequestMore}\label{wxidleeventrequestmore} | |
| 43 | ||
| 44 | \func{void}{RequestMore}{\param{bool}{ needMore = TRUE}} | |
| 45 | ||
| 46 | Tells wxWindows that more processing is required. This function can be called by an OnIdle | |
| 47 | handler for a window or window event handler to indicate that wxApp::OnIdle should | |
| 48 | forward the OnIdle event once more to the application windows. If no window calls this function | |
| 49 | during OnIdle, then the application will remain in a passive event loop (not calling OnIdle) until a | |
| 50 | new event is posted to the application by the windowing system. | |
| 51 | ||
| 52 | \wxheading{See also} | |
| 53 | ||
| 4d5a0f67 GD |
54 | \helpref{wxIdleEvent::MoreRequested}{wxidleeventmorerequested} |
| 55 | %% GD: OnXXX functions are not documented | |
| 56 | %%\helpref{wxApp::OnIdle}{wxapponidle} | |
| a660d684 KB |
57 | |
| 58 | \membersection{wxIdleEvent::MoreRequested}\label{wxidleeventmorerequested} | |
| 59 | ||
| 60 | \constfunc{bool}{MoreRequested}{\void} | |
| 61 | ||
| 62 | Returns TRUE if the OnIdle function processing this event requested more processing time. | |
| 63 | ||
| 64 | \wxheading{See also} | |
| 65 | ||
| 4d5a0f67 GD |
66 | \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore} |
| 67 | %% GD: OnXXX functions are not documented | |
| 68 | %%\helpref{wxApp::OnIdle}{wxapponidle} | |
| a660d684 | 69 |