docs/latex/wx/idleevt.tex

   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
  10 \wxheading{Event table macros}
  11
  12 To process an idle event, use this event handler macro to direct input to a member
  13 function that takes a wxIdleEvent argument.
  14
  15 \twocolwidtha{7cm}
  16 \begin{twocollist}\itemsep=0pt
  17 \twocolitem{{\bf EVT\_IDLE(func)}}{Process a wxEVT\_IDLE event.}
  18 \end{twocollist}%
  19
  20 \wxheading{Remarks}
  21
  22 Idle events can be caught by the wxApp class, or by top-level window classes.
  23
  24 \wxheading{See also}
  25
  26 \helpref{wxApp::OnIdle}{wxapponidle}, \helpref{Event handling overview}{eventhandlingoverview}
  27
  28 \latexignore{\rtfignore{\wxheading{Members}}}
  29
  30 \membersection{wxIdleEvent::wxIdleEvent}
  31
  32 \func{}{wxIdleEvent}{\void}
  33
  34 Constructor.
  35
  36 \membersection{wxIdleEvent::RequestMore}\label{wxidleeventrequestmore}
  37
  38 \func{void}{RequestMore}{\param{bool}{ needMore = TRUE}}
  39
  40 Tells wxWindows that more processing is required. This function can be called by an OnIdle
  41 handler for a window or window event handler to indicate that wxApp::OnIdle should
  42 forward the OnIdle event once more to the application windows. If no window calls this function
  43 during OnIdle, then the application will remain in a passive event loop (not calling OnIdle) until a
  44 new event is posted to the application by the windowing system.
  45
  46 \wxheading{See also}
  47
  48 \helpref{wxIdleEvent::MoreRequested}{wxidleeventmorerequested}, \helpref{wxApp::OnIdle}{wxapponidle}
  49
  50 \membersection{wxIdleEvent::MoreRequested}\label{wxidleeventmorerequested}
  51
  52 \constfunc{bool}{MoreRequested}{\void}
  53
  54 Returns TRUE if the OnIdle function processing this event requested more processing time.
  55
  56 \wxheading{See also}
  57
  58 \helpref{wxIdleEvent::RequestMore}{wxidleeventrequestmore}, \helpref{wxApp::OnIdle}{wxapponidle}
  59