Class: Wx::Timer

Inherits:

EvtHandler

• Object
• Object
• EvtHandler
• Wx::Timer

Defined in:

lib/wx/doc/gen/timer.rb

Overview

The Timer class allows you to execute code at specified intervals.

Its precision is platform-dependent, but in general will not be better than 1ms nor worse than 1s. There are three different ways to use this class:

• You may derive a new class from Timer and override the #notify member to perform the required action.

• You may redirect the notifications to any EvtHandler derived object by using the non-default constructor or #set_owner. Then use the EVT_TIMER macro to connect it to the event handler which will receive TimerEvent notifications.

• You may use a derived class and the EVT_TIMER macro to connect it to an event handler defined in the derived class. If the default constructor is used, the timer object will be its own owner object, since it is derived from EvtHandler.

In any case, you must start the timer with #start after constructing it before it actually starts sending notifications. It can be stopped later with #stop.

Note:

A timer can only be used from the main thread.

Category: Miscellaneous

See Also:

• StopWatch

Requires:

• USE_TIMER

Instance Method Summary

• #get_id ⇒ Integer (also: #id)

  Returns the ID of the events generated by this timer.

• #get_interval ⇒ Integer (also: #interval)

  Returns the current interval for the timer (in milliseconds).

• #get_owner ⇒ Wx::EvtHandler (also: #owner)

  Returns the current owner of the timer.

• #initialize(*args) ⇒ Timer constructor

  A new instance of Timer.

• #is_one_shot ⇒ Boolean (also: #one_shot?)

  Returns true if the timer is one shot, i.e.

• #is_running ⇒ Boolean (also: #running?)

  Returns true if the timer is running, false if it is stopped.

• #notify ⇒ void

  This member should be overridden by the user if the default constructor was used and #set_owner wasn’t called.

• #set_owner(owner, id = -1)) ⇒ void (also: #owner=)

  Associates the timer with the given owner object.

• #start(milliseconds = -1,, oneShot = Wx::TIMER_CONTINUOUS) ⇒ Boolean

  (Re)starts the timer.

• #start_once(milliseconds = -1)) ⇒ Boolean

  Starts the timer for a once-only notification.

• #stop ⇒ void

  Stops the timer.

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_display_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_hotkey, #evt_html_cell_clicked, #evt_html_cell_hover, #evt_html_link_clicked, #evt_hyperlink, #evt_iconize, #evt_idle, #evt_init_dialog, #evt_joy_button_down, #evt_joy_button_up, #evt_joy_move, #evt_joy_zmove, #evt_joystick_events, #evt_key_down, #evt_key_up, #evt_kill_focus, #evt_leave_window, #evt_left_dclick, #evt_left_down, #evt_left_up, #evt_list_begin_drag, #evt_list_begin_label_edit, #evt_list_begin_rdrag, #evt_list_cache_hint, #evt_list_col_begin_drag, #evt_list_col_click, #evt_list_col_dragging, #evt_list_col_end_drag, #evt_list_col_right_click, #evt_list_delete_all_items, #evt_list_delete_item, #evt_list_end_label_edit, #evt_list_insert_item, #evt_list_item_activated, #evt_list_item_checked, #evt_list_item_deselected, #evt_list_item_focused, #evt_list_item_middle_click, #evt_list_item_right_click, #evt_list_item_selected, #evt_list_item_unchecked, #evt_list_key_down, #evt_listbook_page_changed, #evt_listbook_page_changing, #evt_listbox, #evt_listbox_dclick, #evt_long_press, #evt_magnify, #evt_maximize, #evt_media_finished, #evt_media_loaded, #evt_media_pause, #evt_media_play, #evt_media_statechanged, #evt_media_stop, #evt_menu, #evt_menu_close, #evt_menu_highlight, #evt_menu_highlight_all, #evt_menu_open, #evt_menu_range, #evt_middle_dclick, #evt_middle_down, #evt_middle_up, #evt_motion, #evt_mouse_aux1_dclick, #evt_mouse_aux1_down, #evt_mouse_aux1_up, #evt_mouse_aux2_dclick, #evt_mouse_aux2_down, #evt_mouse_aux2_up, #evt_mouse_capture_changed, #evt_mouse_capture_lost, #evt_mouse_events, #evt_mousewheel, #evt_move, #evt_move_end, #evt_move_start, #evt_moving, #evt_navigation_key, #evt_notebook_page_changed, #evt_notebook_page_changing, #evt_paint, #evt_pg_changed, #evt_pg_changing, #evt_pg_col_begin_drag, #evt_pg_col_dragging, #evt_pg_col_end_drag, #evt_pg_double_click, #evt_pg_highlighted, #evt_pg_item_collapsed, #evt_pg_item_expanded, #evt_pg_label_edit_begin, #evt_pg_label_edit_ending, #evt_pg_page_changed, #evt_pg_right_click, #evt_pg_selected, #evt_press_and_tap, #evt_query_end_session, #evt_query_layout_info, #evt_radiobox, #evt_radiobutton, #evt_ribbonbar_help_click, #evt_ribbonbar_page_changed, #evt_ribbonbar_page_changing, #evt_ribbonbar_tab_left_dclick, #evt_ribbonbar_tab_middle_down, #evt_ribbonbar_tab_middle_up, #evt_ribbonbar_tab_right_down, #evt_ribbonbar_tab_right_up, #evt_ribbonbar_toggled, #evt_ribbonbuttonbar_clicked, #evt_ribbonbuttonbar_dropdown_clicked, #evt_ribbongallery_clicked, #evt_ribbongallery_hover_changed, #evt_ribbongallery_selected, #evt_ribbonpanel_extbutton_activated, #evt_ribbontoolbar_clicked, #evt_ribbontoolbar_dropdown_clicked, #evt_richtext_buffer_reset, #evt_richtext_character, #evt_richtext_consuming_character, #evt_richtext_content_deleted, #evt_richtext_content_inserted, #evt_richtext_delete, #evt_richtext_focus_object_changed, #evt_richtext_left_click, #evt_richtext_left_dclick, #evt_richtext_middle_click, #evt_richtext_properties_changed, #evt_richtext_return, #evt_richtext_right_click, #evt_richtext_selection_changed, #evt_richtext_style_changed, #evt_richtext_stylesheet_changed, #evt_richtext_stylesheet_replaced, #evt_richtext_stylesheet_replacing, #evt_right_dclick, #evt_right_down, #evt_right_up, #evt_sash_dragged, #evt_sash_dragged_range, #evt_scroll, #evt_scroll_bottom, #evt_scroll_changed, #evt_scroll_command, #evt_scroll_linedown, #evt_scroll_lineup, #evt_scroll_pagedown, #evt_scroll_pageup, #evt_scroll_thumbrelease, #evt_scroll_thumbtrack, #evt_scroll_top, #evt_scrollbar, #evt_scrollwin, #evt_scrollwin_bottom, #evt_scrollwin_linedown, #evt_scrollwin_lineup, #evt_scrollwin_pagedown, #evt_scrollwin_pageup, #evt_scrollwin_thumbrelease, #evt_scrollwin_thumbtrack, #evt_scrollwin_top, #evt_search, #evt_search_cancel, #evt_set_cursor, #evt_set_focus, #evt_show, #evt_size, #evt_slider, #evt_spin, #evt_spin_down, #evt_spin_up, #evt_spinctrl, #evt_spinctrldouble, #evt_splitter_dclick, #evt_splitter_sash_pos_changed, #evt_splitter_sash_pos_changing, #evt_splitter_sash_pos_resize, #evt_splitter_unsplit, #evt_stc_autocomp_cancelled, #evt_stc_autocomp_char_deleted, #evt_stc_autocomp_completed, #evt_stc_autocomp_selection, #evt_stc_autocomp_selection_change, #evt_stc_calltip_click, #evt_stc_change, #evt_stc_charadded, #evt_stc_clipboard_copy, #evt_stc_clipboard_paste, #evt_stc_do_drop, #evt_stc_doubleclick, #evt_stc_drag_over, #evt_stc_dwellend, #evt_stc_dwellstart, #evt_stc_hotspot_click, #evt_stc_hotspot_dclick, #evt_stc_hotspot_release_click, #evt_stc_indicator_click, #evt_stc_indicator_release, #evt_stc_macrorecord, #evt_stc_margin_right_click, #evt_stc_marginclick, #evt_stc_modified, #evt_stc_needshown, #evt_stc_painted, #evt_stc_romodifyattempt, #evt_stc_savepointleft, #evt_stc_savepointreached, #evt_stc_start_drag, #evt_stc_styleneeded, #evt_stc_updateui, #evt_stc_userlistselection, #evt_stc_zoom, #evt_sys_colour_changed, #evt_taskbar_click, #evt_taskbar_left_dclick, #evt_taskbar_left_down, #evt_taskbar_left_up, #evt_taskbar_move, #evt_taskbar_right_dclick, #evt_taskbar_right_down, #evt_taskbar_right_up, #evt_text, #evt_text_copy, #evt_text_cut, #evt_text_enter, #evt_text_maxlen, #evt_text_paste, #evt_text_url, #evt_time_changed, #evt_timer, #evt_togglebutton, #evt_tool, #evt_tool_dropdown, #evt_tool_enter, #evt_tool_range, #evt_tool_rclicked, #evt_tool_rclicked_range, #evt_toolbook_page_changed, #evt_toolbook_page_changing, #evt_tree_begin_drag, #evt_tree_begin_label_edit, #evt_tree_begin_rdrag, #evt_tree_delete_item, #evt_tree_end_drag, #evt_tree_end_label_edit, #evt_tree_get_info, #evt_tree_item_activated, #evt_tree_item_collapsed, #evt_tree_item_collapsing, #evt_tree_item_expanded, #evt_tree_item_expanding, #evt_tree_item_gettooltip, #evt_tree_item_menu, #evt_tree_item_middle_click, #evt_tree_item_right_click, #evt_tree_key_down, #evt_tree_sel_changed, #evt_tree_sel_changing, #evt_tree_set_info, #evt_tree_state_image_click, #evt_treebook_node_collapsed, #evt_treebook_node_expanded, #evt_treebook_page_changed, #evt_treebook_page_changing, #evt_two_finger_tap, #evt_update_ui, #evt_update_ui_range, #evt_window_create, #evt_window_destroy, #evt_wizard_before_page_changed, #evt_wizard_cancel, #evt_wizard_finished, #evt_wizard_help, #evt_wizard_page_changed, #evt_wizard_page_changing, #evt_wizard_page_shown, #get_client_object, #get_evt_handler_enabled, #get_next_handler, #get_previous_handler, #is_unlinked, #process_event, #process_event_locally, #process_pending_events, #queue_event, register_class, remove_filter, #safely_process_event, #set_client_object, #set_evt_handler_enabled, #set_next_handler, #set_previous_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::Timer #initialize(owner, id = -1) ⇒ Wx::Timer

Returns a new instance of Timer.

Overloads:

• #initialize ⇒ Wx::Timer

  Default constructor.

  If you use it to construct the object and don’t call #set_owner later, you must override #notify method to process the notifications.
• #initialize(owner, id = -1) ⇒ Wx::Timer

  Creates a timer and associates it with owner.

  Please see #set_owner for the description of parameters.

  Parameters:

  • owner (Wx::EvtHandler)
  • id (Integer) (defaults to: -1)

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

def initialize(*args) end

Instance Method Details

#get_id ⇒ Integer Also known as: id

Returns the ID of the events generated by this timer.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/timer.rb', line 49

def get_id; end

#get_interval ⇒ Integer Also known as: interval

Returns the current interval for the timer (in milliseconds).

Returns:

• (Integer)

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

def get_interval; end

#get_owner ⇒ Wx::EvtHandler Also known as: owner

Returns the current owner of the timer.

If non-NULL this is the event handler which will receive the timer events (see Wx::TimerEvent) when the timer is running.

Returns:

• (Wx::EvtHandler)

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

def get_owner; end

#is_one_shot ⇒ Boolean Also known as: one_shot?

Returns true if the timer is one shot, i.e. if it will stop after firing the first notification automatically.

Returns:

• (Boolean)

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

def is_one_shot; end

#is_running ⇒ Boolean Also known as: running?

Returns true if the timer is running, false if it is stopped.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/timer.rb', line 71

def is_running; end

#notify ⇒ void

This method returns an undefined value.

This member should be overridden by the user if the default constructor was used and #set_owner wasn’t called.

Perform whatever action which is to be taken periodically here. Notice that throwing exceptions from this method is currently not supported, use event-based timer handling approach if an exception can be thrown while handling timer notifications.

# File 'lib/wx/doc/gen/timer.rb', line 79

def notify; end

#set_owner(owner, id = -1)) ⇒ void Also known as: owner=

This method returns an undefined value.

Associates the timer with the given owner object.

When the timer is running, the owner will receive timer events (see Wx::TimerEvent) with id equal to id specified here.

Parameters:

• owner (Wx::EvtHandler)
• id (Integer) (defaults to: -1))

# File 'lib/wx/doc/gen/timer.rb', line 87

def set_owner(owner, id=-1) end

#start(milliseconds = -1,, oneShot = Wx::TIMER_CONTINUOUS) ⇒ Boolean

(Re)starts the timer.

If milliseconds parameter is -1 (value by default), the previous value is used. Returns false if the timer could not be started, true otherwise (in MS Windows timers are a limited resource). If oneShot is false (the default), the #notify function will be called repeatedly until the timer is stopped. If true, it will be called only once and the timer will stop automatically. To make your code more readable you may also use the following symbolic constants:

• Wx::TIMER_CONTINUOUS: Start a normal, continuously running, timer

• Wx::TIMER_ONE_SHOT: Start a one shot timer Alternatively, use #start_once.

If the timer was already running, it will be stopped by this method before restarting it.

Parameters:

• milliseconds (Integer) (defaults to: -1,)
• oneShot (Boolean) (defaults to: Wx::TIMER_CONTINUOUS)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/timer.rb', line 103

def start(milliseconds=-1, oneShot=Wx::TIMER_CONTINUOUS) end

#start_once(milliseconds = -1)) ⇒ Boolean

Starts the timer for a once-only notification.

This is a simple wrapper for #start with Wx::TIMER_ONE_SHOT parameter.

Parameters:

• milliseconds (Integer) (defaults to: -1))

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/timer.rb', line 110

def start_once(milliseconds=-1) end

#stop ⇒ void

This method returns an undefined value.

Stops the timer.

# File 'lib/wx/doc/gen/timer.rb', line 114

def stop; end