Class: Wx::IdleEvent

Inherits:
Event show all
Defined in:
lib/wx/doc/gen/events.rb

Overview

This class is used for idle events, which are generated when the system becomes idle.

Note that, unless you do something specifically, the idle events are not sent if the system remains idle once it has become it, e.g. only a single idle event will be generated until something else resulting in more normal events happens and only then is the next idle event sent again. If you need to ensure a continuous stream of idle events, you can either use #request_more method in your handler or call wake_up_idle periodically (for example from a timer event handler), but note that both of these approaches (and especially the first one) increase the system load and so should be avoided if possible. By default, idle events are sent to all windows, including even the hidden ones because they may be shown if some condition is met from their EVT_IDLE (or related EVT_UPDATE_UI) handler. The children of hidden windows do not receive idle events however as they can’t change their state in any way noticeable by the user. Finally, the global App object also receives these events, as usual, so it can be used for any global idle time processing. If sending idle events to all windows is causing a significant overhead in your application, you can call IdleEvent.set_mode with the value Wx::IdleMode::IDLE_PROCESS_SPECIFIED, and set the WS_EX_PROCESS_IDLE extra window style for every window which should receive idle events, all the other ones will not receive them in this case.

Events using this class

The following event-handler methods redirect the events to member method or handler blocks for IdleEvent events. Event handler methods:

Category: Events

Delayed Action Mechanism

IdleEvent can be used to perform some action “at slightly later time”. This can be necessary in several circumstances when, for whatever reason, something can’t be done in the current event handler. For example, if a mouse event handler is called with the mouse button pressed, the mouse can be currently captured and some operations with it notably capturing it again might be impossible or lead to undesirable results. If you still want to capture it, you can do it from EVT_IDLE handler when it is called the next time instead of doing it immediately. This can be achieved in two different ways: when using static event tables, you will need a flag indicating to the (always connected) idle event handler whether the desired action should be performed. The originally called handler would then set it to indicate that it should indeed be done and the idle handler itself would reset it to prevent it from doing the same action again. Using dynamically connected event handlers things are even simpler as the original event handler can simply EvtHandler#connect or EvtHandler#bind the idle event handler which would only be executed then and could EvtHandler#disconnect or EvtHandler#unbind itself.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::IdleEvent

Constructor.



38
 
# File 'lib/wx/doc/gen/events.rb', line 38

def initialize; end

Class Method Details

.get_mode ⇒ Wx::IdleMode

Static function returning a value specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.

Returns:

See Also:



61
 
# File 'lib/wx/doc/gen/events.rb', line 61

def self.get_mode; end

.set_mode(mode) ⇒ void

This method returns an undefined value.

Static function for specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.

Parameters:



66
 
# File 'lib/wx/doc/gen/events.rb', line 66

def self.set_mode(mode) end

Instance Method Details

#more_requested ⇒ Boolean

Returns true if the OnIdle function processing this event requested more processing time.

Returns:

  • (Boolean)

See Also:



45
 
# File 'lib/wx/doc/gen/events.rb', line 45

def more_requested; end

#request_more(needMore = true) ⇒ void

This method returns an undefined value.

Tells wxWidgets that more processing is required.

This function can be called by an OnIdle handler for a window or window event handler to indicate that App::OnIdle should forward the OnIdle event once more to the application windows. If no window calls this function during OnIdle, then the application will remain in a passive event loop (not calling OnIdle) until a new event is posted to the application by the windowing system.

Parameters:

  • needMore (Boolean) (defaults to: true)

See Also:



54
 
# File 'lib/wx/doc/gen/events.rb', line 54

def request_more(needMore=true) end