Class: Wx::EvtHandler

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/evt_handler.rb,
lib/wx/doc/pg/events.rb,
lib/wx/doc/evthandler.rb,
lib/wx/doc/gen/event_list.rb,
lib/wx/doc/gen/pg/event_list.rb,
lib/wx/doc/gen/aui/event_list.rb,
lib/wx/doc/gen/prt/event_list.rb,
lib/wx/doc/gen/rbn/event_list.rb,
lib/wx/doc/gen/rtc/event_list.rb,
lib/wx/doc/gen/stc/event_list.rb,
lib/wx/doc/gen/grid/event_list.rb,
lib/wx/doc/gen/html/event_list.rb

Overview

A class that can handle events from the windowing system.

Window is (and therefore all window classes are) derived from this class. When events are received, EvtHandler invokes the method listed in the event table using itself as the object. When using multiple inheritance it is imperative that the EvtHandler(-derived) class is the first class inherited such that the this pointer for the overall object will be identical to the this pointer of the EvtHandler portion.

Category: Events

See Also:

PG Event handler methods collapse

Wx Event handler methods collapse

AUI Event handler methods collapse

RBN Event handler methods collapse

RTC Event handler methods collapse

STC Event handler methods collapse

GRID Event handler methods collapse

HTML Event handler methods collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initializeWx::EvtHandler

Constructor.



197
# File 'lib/wx/doc/gen/evt_handler.rb', line 197

def initialize; end

Class Method Details

.add_filter(filter) ⇒ void

This method returns an undefined value.

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

The filters are called in LIFO order and App is registered as an event filter by default. The pointer must remain valid until it’s removed with remove_filter and is not deleted by Wx::EvtHandler.

Parameters:



186
# File 'lib/wx/doc/gen/evt_handler.rb', line 186

def self.add_filter(filter) end

.clear_filtersvoid

This method returns an undefined value.

Removes all (Ruby) installed EventFilter-s.



18
# File 'lib/wx/doc/evthandler.rb', line 18

def self.clear_filters; end

.register_class(klass, konstant = nil, meth = nil, arity = nil) ⇒ Integer

Public method to register the mapping of a custom event type konstant (which should be a unique integer; one will be created if not supplied) to a custom event class klass. If meth and arity are given, a convenience evt_handler method called meth will be created, which accepts arity arguments (specify both or neither).

Parameters:

  • klass (Class)

    event class

  • konstant (Integer) (defaults to: nil)

    unique event type id (if nil a unique value will be autogenerated)

  • meth (String, Symbol) (defaults to: nil)

    optional event handler method name

  • arity (Integer) (defaults to: nil)

    event handler method arity (should be 0, 1 or 2 if not nil)

Returns:

  • (Integer)

    unique event type id



30
# File 'lib/wx/doc/evthandler.rb', line 30

def self.register_class(klass, konstant = nil, meth = nil, arity = nil) end

.remove_filter(filter) ⇒ void

This method returns an undefined value.

Remove a filter previously installed with add_filter.

It’s an error to remove a filter that hadn’t been previously added or was already removed.

Parameters:



193
# File 'lib/wx/doc/gen/evt_handler.rb', line 193

def self.remove_filter(filter) end

Instance Method Details

#add_pending_event(event) ⇒ void

This method returns an undefined value.

Post an event to be processed later.

This function is similar to #queue_event but can’t be used to post events from worker threads for the event objects with String fields (i.e. in practice most of them) because of an unsafe use of the same String object which happens because the String field in the original event object and its copy made internally by this function share the same string buffer internally. Use #queue_event to avoid this. A copy of event is made by the function, so the original can be deleted as soon as function returns (it is common that the original is created on the stack). This requires that the Wx::Event#clone method be implemented by event so that it can be duplicated and stored until it gets processed.

Parameters:

  • event (Wx::Event)

    Event to add to the pending events queue.



39
# File 'lib/wx/doc/gen/evt_handler.rb', line 39

def add_pending_event(event) end

#call_after(meth = nil, *args) {|*args| ... } ⇒ void

This method returns an undefined value.

Schedule a call for asynchronous execution (at idle time).

Parameters:

  • meth (Symbol, String, Method, Proc) (defaults to: nil)

    (name of) method or proc to call

  • args (Array<Object>)

    optional arguments to pass to the call

Yields:

  • (*args)

    optional arguments



143
# File 'lib/wx/doc/evthandler.rb', line 143

def call_after(meth = nil, *args, &block) end

#connect(first_id, last_id, evt_id, handler) ⇒ Boolean

Connects the given event handler dynamically for id(s) and event type.

This is the core event connecting method. In Ruby using named event connector methods like #evt_menu is highly recommended as using #connect does not provide any better options (less even) than using named event connectors as all event connecting is dynamic.

Parameters:

  • first_id (Integer)

    The first ID of the identifier range to be associated with the event handler. Should be Wx::ANY_ID for events that do not require identifiers.

  • last_id (Integer)

    The last ID of the identifier range to be associated with the event handler. Should be Wx::ANY_ID for events requiring a single identifier (like MenuEvt).

  • evt_id (Integer)

    The event type identifier like Wx::EVT_MENU.

  • handler (Proc, Method)

    The event handler proc or method.

Returns:

  • (Boolean)

    Always returns true.



43
# File 'lib/wx/doc/evthandler.rb', line 43

def connect(first_id, last_id, evt_id, handler) end

#delete_pending_eventsvoid

This method returns an undefined value.

Deletes all events queued on this event handler using #queue_event or #add_pending_event.

Use with care because the events which are deleted are (obviously) not processed and this may have unwanted consequences (e.g. user actions events will be lost).



72
# File 'lib/wx/doc/gen/evt_handler.rb', line 72

def delete_pending_events; end

#disconnect(first_id, last_id, evt_id) ⇒ Boolean

Note:

Note that in wxRuby it is not possible to remove a specific handler if multiple (chained) handler(s) have been connected.

Disconnects any event handler connected for the specified id(s) and event type.

Looks up connected event handler(s) using the specified parameters as search criteria and returning true if (a) matching handler(s) has(have) been found and removed.

Parameters:

  • first_id (Integer)

    The first ID of the identifier range associated with the event handler. Should be Wx::ANY_ID for events that have no associated identifiers.

  • last_id (Integer)

    The last ID of the identifier range associated with the event handler. Should be Wx::ANY_ID for events that have a single identifier associated.

  • evt_id (Integer, Symbol, nil)

    The event type identifier like Wx::EVT_MENU or event connector symbol (like :evt_menu).

Returns:

  • (Boolean)

    Returns true if any event handler found and removed, false otherwise.



56
# File 'lib/wx/doc/evthandler.rb', line 56

def disconnect(first_id, last_id, evt_id) end

#evt_activate(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_ACTIVATE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



393
# File 'lib/wx/doc/gen/event_list.rb', line 393

def evt_activate(meth = nil, &block) end

#evt_activate_app(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_ACTIVATE_APP event. See ActivateEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



398
# File 'lib/wx/doc/gen/event_list.rb', line 398

def evt_activate_app(meth = nil, &block) end

#evt_aui_pane_activated(meth = nil) {|event| ... } ⇒ Object

Triggered when a pane is made ‘active’. This event is new since wxWidgets 2.9.4. Processes a AUI::EVT_AUI_PANE_ACTIVATED event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



41
# File 'lib/wx/doc/gen/aui/event_list.rb', line 41

def evt_aui_pane_activated(meth = nil, &block) end

#evt_aui_pane_button(meth = nil) {|event| ... } ⇒ Object

Triggered when any button is pressed for any docked panes. Processes a AUI::EVT_AUI_PANE_BUTTON event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



17
# File 'lib/wx/doc/gen/aui/event_list.rb', line 17

def evt_aui_pane_button(meth = nil, &block) end

#evt_aui_pane_close(meth = nil) {|event| ... } ⇒ Object

Triggered when a docked or floating pane is closed. Processes a AUI::EVT_AUI_PANE_CLOSE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



23
# File 'lib/wx/doc/gen/aui/event_list.rb', line 23

def evt_aui_pane_close(meth = nil, &block) end

#evt_aui_pane_maximize(meth = nil) {|event| ... } ⇒ Object

Triggered when a pane is maximized. Processes a AUI::EVT_AUI_PANE_MAXIMIZE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



29
# File 'lib/wx/doc/gen/aui/event_list.rb', line 29

def evt_aui_pane_maximize(meth = nil, &block) end

#evt_aui_pane_restore(meth = nil) {|event| ... } ⇒ Object

Triggered when a pane is restored. Processes a AUI::EVT_AUI_PANE_RESTORE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



35
# File 'lib/wx/doc/gen/aui/event_list.rb', line 35

def evt_aui_pane_restore(meth = nil, &block) end

#evt_aui_render(meth = nil) {|event| ... } ⇒ Object

This event can be caught to override the default renderer in order to custom draw your AUI::AuiManager window (not recommended). Processes a AUI::EVT_AUI_RENDER event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



47
# File 'lib/wx/doc/gen/aui/event_list.rb', line 47

def evt_aui_render(meth = nil, &block) end

#evt_auinotebook_allow_dnd(id, meth = nil) {|event| ... } ⇒ Object

Whether to allow a tab to be dropped. Processes a AUI::EVT_AUINOTEBOOK_ALLOW_DND event. This event must be specially allowed.

Parameters:

Yield Parameters:



101
# File 'lib/wx/doc/gen/aui/event_list.rb', line 101

def evt_auinotebook_allow_dnd(id, meth = nil, &block) end

#evt_auinotebook_begin_drag(id, meth = nil) {|event| ... } ⇒ Object

Dragging is about to begin. Processes a AUI::EVT_AUINOTEBOOK_BEGIN_DRAG event.

Parameters:

Yield Parameters:



83
# File 'lib/wx/doc/gen/aui/event_list.rb', line 83

def evt_auinotebook_begin_drag(id, meth = nil, &block) end

#evt_auinotebook_bg_dclick(winid, meth = nil) {|event| ... } ⇒ Object

Double clicked on the tabs background area. Processes a AUI::EVT_AUINOTEBOOK_BG_DCLICK event.

Parameters:

  • winid (Integer, Wx::Enum, Wx::Window, Wx::MenuItem, Wx::ToolBarTool, Wx::Timer)

    window/control id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



137
# File 'lib/wx/doc/gen/aui/event_list.rb', line 137

def evt_auinotebook_bg_dclick(winid, meth = nil, &block) end

#evt_auinotebook_button(id, meth = nil) {|event| ... } ⇒ Object

The window list button has been pressed. Processes a AUI::EVT_AUINOTEBOOK_BUTTON event.

Parameters:

Yield Parameters:



77
# File 'lib/wx/doc/gen/aui/event_list.rb', line 77

def evt_auinotebook_button(id, meth = nil, &block) end

#evt_auinotebook_drag_done(winid, meth = nil) {|event| ... } ⇒ Object

Notify that the tab has been dragged. Processes a AUI::EVT_AUINOTEBOOK_DRAG_DONE event.

Parameters:

  • winid (Integer, Wx::Enum, Wx::Window, Wx::MenuItem, Wx::ToolBarTool, Wx::Timer)

    window/control id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



107
# File 'lib/wx/doc/gen/aui/event_list.rb', line 107

def evt_auinotebook_drag_done(winid, meth = nil, &block) end

#evt_auinotebook_drag_motion(id, meth = nil) {|event| ... } ⇒ Object

Emitted during a drag and drop operation. Processes a AUI::EVT_AUINOTEBOOK_DRAG_MOTION event.

Parameters:

Yield Parameters:



95
# File 'lib/wx/doc/gen/aui/event_list.rb', line 95

def evt_auinotebook_drag_motion(id, meth = nil, &block) end

#evt_auinotebook_end_drag(id, meth = nil) {|event| ... } ⇒ Object

Dragging has ended. Processes a AUI::EVT_AUINOTEBOOK_END_DRAG event.

Parameters:

Yield Parameters:



89
# File 'lib/wx/doc/gen/aui/event_list.rb', line 89

def evt_auinotebook_end_drag(id, meth = nil, &block) end

#evt_auinotebook_page_changed(id, meth = nil) {|event| ... } ⇒ Object

The page selection was changed. Processes a AUI::EVT_AUINOTEBOOK_PAGE_CHANGED event.

Parameters:

Yield Parameters:



65
# File 'lib/wx/doc/gen/aui/event_list.rb', line 65

def evt_auinotebook_page_changed(id, meth = nil, &block) end

#evt_auinotebook_page_changing(id, meth = nil) {|event| ... } ⇒ Object

The page selection is about to be changed. Processes a AUI::EVT_AUINOTEBOOK_PAGE_CHANGING event. This event can be vetoed.

Parameters:

Yield Parameters:



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

def evt_auinotebook_page_changing(id, meth = nil, &block) end

#evt_auinotebook_page_close(id, meth = nil) {|event| ... } ⇒ Object

A page is about to be closed. Processes a AUI::EVT_AUINOTEBOOK_PAGE_CLOSE event.

Parameters:

Yield Parameters:



53
# File 'lib/wx/doc/gen/aui/event_list.rb', line 53

def evt_auinotebook_page_close(id, meth = nil, &block) end

#evt_auinotebook_page_closed(winid, meth = nil) {|event| ... } ⇒ Object

A page has been closed. Processes a AUI::EVT_AUINOTEBOOK_PAGE_CLOSED event.

Parameters:

  • winid (Integer, Wx::Enum, Wx::Window, Wx::MenuItem, Wx::ToolBarTool, Wx::Timer)

    window/control id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



59
# File 'lib/wx/doc/gen/aui/event_list.rb', line 59

def evt_auinotebook_page_closed(winid, meth = nil, &block) end

#evt_auinotebook_tab_middle_down(winid, meth = nil) {|event| ... } ⇒ Object

The middle mouse button is pressed on a tab. Processes a AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN event.

Parameters:

  • winid (Integer, Wx::Enum, Wx::Window, Wx::MenuItem, Wx::ToolBarTool, Wx::Timer)

    window/control id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



113
# File 'lib/wx/doc/gen/aui/event_list.rb', line 113

def evt_auinotebook_tab_middle_down(winid, meth = nil, &block) end

#evt_auinotebook_tab_middle_up(winid, meth = nil) {|event| ... } ⇒ Object

The middle mouse button is released on a tab. Processes a AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_UP event.

Parameters:

  • winid (Integer, Wx::Enum, Wx::Window, Wx::MenuItem, Wx::ToolBarTool, Wx::Timer)

    window/control id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



119
# File 'lib/wx/doc/gen/aui/event_list.rb', line 119

def evt_auinotebook_tab_middle_up(winid, meth = nil, &block) end

#evt_auinotebook_tab_right_down(winid, meth = nil) {|event| ... } ⇒ Object

The right mouse button is pressed on a tab. Processes a AUI::EVT_AUINOTEBOOK_TAB_RIGHT_DOWN event.

Parameters:

  • winid (Integer, Wx::Enum, Wx::Window, Wx::MenuItem, Wx::ToolBarTool, Wx::Timer)

    window/control id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



125
# File 'lib/wx/doc/gen/aui/event_list.rb', line 125

def evt_auinotebook_tab_right_down(winid, meth = nil, &block) end

#evt_auinotebook_tab_right_up(winid, meth = nil) {|event| ... } ⇒ Object

The right mouse button is released on a tab. Processes a AUI::EVT_AUINOTEBOOK_TAB_RIGHT_UP event.

Parameters:

  • winid (Integer, Wx::Enum, Wx::Window, Wx::MenuItem, Wx::ToolBarTool, Wx::Timer)

    window/control id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



131
# File 'lib/wx/doc/gen/aui/event_list.rb', line 131

def evt_auinotebook_tab_right_up(winid, meth = nil, &block) end

#evt_auitoolbar_begin_drag(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



167
# File 'lib/wx/doc/gen/aui/event_list.rb', line 167

def evt_auitoolbar_begin_drag(id, meth = nil, &block) end

#evt_auitoolbar_middle_click(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



161
# File 'lib/wx/doc/gen/aui/event_list.rb', line 161

def evt_auitoolbar_middle_click(id, meth = nil, &block) end

#evt_auitoolbar_overflow_click(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



149
# File 'lib/wx/doc/gen/aui/event_list.rb', line 149

def evt_auitoolbar_overflow_click(id, meth = nil, &block) end

#evt_auitoolbar_right_click(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



155
# File 'lib/wx/doc/gen/aui/event_list.rb', line 155

def evt_auitoolbar_right_click(id, meth = nil, &block) end

#evt_auitoolbar_tool_dropdown(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



143
# File 'lib/wx/doc/gen/aui/event_list.rb', line 143

def evt_auitoolbar_tool_dropdown(id, meth = nil, &block) end

#evt_button(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_BUTTON event, when the button is clicked.

Parameters:

Yield Parameters:



1157
# File 'lib/wx/doc/gen/event_list.rb', line 1157

def evt_button(id, meth = nil, &block) end

#evt_calculate_layout(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_CALCULATE_LAYOUT event, which asks the window to take a ‘bite’ out of a rectangle provided by the algorithm.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1059
# File 'lib/wx/doc/gen/event_list.rb', line 1059

def evt_calculate_layout(meth = nil, &block) end

#evt_calendar(id, meth = nil) {|event| ... } ⇒ Object

A day was double clicked in the calendar. Processes a Wx::EVT_CALENDAR event.

Parameters:

Yield Parameters:



1559
# File 'lib/wx/doc/gen/event_list.rb', line 1559

def evt_calendar(id, meth = nil, &block) end

#evt_calendar_page_changed(id, meth = nil) {|event| ... } ⇒ Object

The selected month (and/or year) changed. Processes a Wx::EVT_CALENDAR_PAGE_CHANGED event.

Parameters:

Yield Parameters:



1573
# File 'lib/wx/doc/gen/event_list.rb', line 1573

def evt_calendar_page_changed(id, meth = nil, &block) end

#evt_calendar_sel_changed(id, meth = nil) {|event| ... } ⇒ Object

The selected date changed. Processes a Wx::EVT_CALENDAR_SEL_CHANGED event.

Parameters:

Yield Parameters:



1566
# File 'lib/wx/doc/gen/event_list.rb', line 1566

def evt_calendar_sel_changed(id, meth = nil, &block) end

#evt_calendar_week_clicked(id, meth = nil) {|event| ... } ⇒ Object

User clicked on the week of the year number (only generic). Processes a Wx::EVT_CALENDAR_WEEK_CLICKED event.

Parameters:

Yield Parameters:



1587
# File 'lib/wx/doc/gen/event_list.rb', line 1587

def evt_calendar_week_clicked(id, meth = nil, &block) end

#evt_calendar_weekday_clicked(id, meth = nil) {|event| ... } ⇒ Object

User clicked on the week day header (only generic). Processes a Wx::EVT_CALENDAR_WEEKDAY_CLICKED event.

Parameters:

Yield Parameters:



1580
# File 'lib/wx/doc/gen/event_list.rb', line 1580

def evt_calendar_weekday_clicked(id, meth = nil, &block) end

#evt_char(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_CHAR event. See KeyEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



338
# File 'lib/wx/doc/gen/event_list.rb', line 338

def evt_char(meth = nil, &block) end

#evt_char_hook(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_CHAR_HOOK event. See KeyEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



343
# File 'lib/wx/doc/gen/event_list.rb', line 343

def evt_char_hook(meth = nil, &block) end

#evt_checkbox(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_CHECKBOX event, when the checkbox is clicked.

Parameters:

Yield Parameters:



1163
# File 'lib/wx/doc/gen/event_list.rb', line 1163

def evt_checkbox(id, meth = nil, &block) end

#evt_checklistbox(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_CHECKLISTBOX event, when an item in the check list box is checked or unchecked. CommandEvent#get_int will contain the index of the item that was checked or unchecked. CommandEvent#is_checked is not valid! Use CheckListBox#is_checked instead.

Parameters:

Yield Parameters:



1193
# File 'lib/wx/doc/gen/event_list.rb', line 1193

def evt_checklistbox(id, meth = nil, &block) end

#evt_child_focus(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_CHILD_FOCUS event. See ChildFocusEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



592
# File 'lib/wx/doc/gen/event_list.rb', line 592

def evt_child_focus(meth = nil, &block) end

#evt_choice(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_CHOICE event, when an item on the list is selected.

Parameters:

Yield Parameters:



1169
# File 'lib/wx/doc/gen/event_list.rb', line 1169

def evt_choice(id, meth = nil, &block) end

#evt_choicebook_page_changed(id, meth = nil) {|event| ... } ⇒ Object

The page selection was changed. Processes a Wx::EVT_CHOICEBOOK_PAGE_CHANGED event.

Parameters:

Yield Parameters:



1413
# File 'lib/wx/doc/gen/event_list.rb', line 1413

def evt_choicebook_page_changed(id, meth = nil, &block) end

#evt_choicebook_page_changing(id, meth = nil) {|event| ... } ⇒ Object

The page selection is about to be changed. Processes a Wx::EVT_CHOICEBOOK_PAGE_CHANGING event. This event can be vetoed (using NotifyEvent#veto).

Parameters:

Yield Parameters:



1419
# File 'lib/wx/doc/gen/event_list.rb', line 1419

def evt_choicebook_page_changing(id, meth = nil, &block) end

#evt_close(meth = nil) {|event| ... } ⇒ Object

The dialog is being closed by the user or programmatically (see Window#close). The user may generate this event clicking the close button (typically the ‘X’ on the top-right of the title bar) if it’s present (see the CLOSE_BOX style). Processes a Wx::EVT_CLOSE_WINDOW event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



439
# File 'lib/wx/doc/gen/event_list.rb', line 439

def evt_close(meth = nil, &block) end

#evt_collapsiblepane_changed(id, meth = nil) {|event| ... } ⇒ Object

The user expanded or collapsed the collapsible pane. Processes a Wx::EVT_COLLAPSIBLEPANE_CHANGED event.

Parameters:

Yield Parameters:



599
# File 'lib/wx/doc/gen/event_list.rb', line 599

def evt_collapsiblepane_changed(id, meth = nil, &block) end

#evt_colourpicker_changed(id, meth = nil) {|event| ... } ⇒ Object

The user changed the colour selected in the control either using the button or using text control (see CLRP_USE_TEXTCTRL; note that in this case the event is fired only if the user’s input is valid, i.e. recognizable). When using a popup dialog for changing the colour, this event is sent only when the changes in the dialog are accepted by the user, unlike EVT_COLOURPICKER_CURRENT_CHANGED. Processes a Wx::EVT_COLOURPICKER_CHANGED event.

Parameters:

Yield Parameters:



676
# File 'lib/wx/doc/gen/event_list.rb', line 676

def evt_colourpicker_changed(id, meth = nil, &block) end

#evt_colourpicker_current_changed(id, meth = nil) {|event| ... } ⇒ Object

The user changed the currently selected colour in the dialog associated with the control. This event is sent immediately when the selection changes and you must also handle EVT_COLOUR_CANCELLED to revert to the previously selected colour if the selection ends up not being accepted. This event is new since wxWidgets 3.1.3 and currently is only implemented in WXMSW. Processes a Wx::EVT_COLOURPICKER_CURRENT_CHANGED event.

Parameters:

Yield Parameters:



683
# File 'lib/wx/doc/gen/event_list.rb', line 683

def evt_colourpicker_current_changed(id, meth = nil, &block) end

#evt_colourpicker_dialog_cancelled(id, meth = nil) {|event| ... } ⇒ Object

The user cancelled the colour dialog associated with the control, i.e. closed it without accepting the selection. This event is new since wxWidgets 3.1.3 and currently is only implemented in WXMSW. Processes a Wx::EVT_COLOURPICKER_DIALOG_CANCELLED event.

Parameters:

Yield Parameters:



690
# File 'lib/wx/doc/gen/event_list.rb', line 690

def evt_colourpicker_dialog_cancelled(id, meth = nil, &block) end

#evt_combobox(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMBOBOX event, when an item on the list is selected. Note that calling get_value returns the new value of selection.

Parameters:

Yield Parameters:



1175
# File 'lib/wx/doc/gen/event_list.rb', line 1175

def evt_combobox(id, meth = nil, &block) end

#evt_combobox_closeup(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMBOBOX_CLOSEUP event, which is generated when the popup window of the combo control disappears (closes up). You should avoid adding or deleting items in this event.

Parameters:

Yield Parameters:



1357
# File 'lib/wx/doc/gen/event_list.rb', line 1357

def evt_combobox_closeup(id, meth = nil, &block) end

#evt_combobox_dropdown(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMBOBOX_DROPDOWN event, which is generated when the popup window is shown (drops down).

Parameters:

Yield Parameters:



1351
# File 'lib/wx/doc/gen/event_list.rb', line 1351

def evt_combobox_dropdown(id, meth = nil, &block) end

#evt_command(id, evt_id, meth = nil) {|event| ... } ⇒ Object

Process a command, supplying the window identifier, command event identifier, and member function or proc.

Parameters:

  • id (Integer)

    window identifier

  • evt_id (Integer)

    event type identifier

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or event handling proc

Yield Parameters:



92
# File 'lib/wx/doc/evthandler.rb', line 92

def evt_command(id, evt_id, meth = nil, &block) end

#evt_command_enter(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMMAND_ENTER command, which is generated by a control.

Parameters:

Yield Parameters:



1326
# File 'lib/wx/doc/gen/event_list.rb', line 1326

def evt_command_enter(id, meth = nil, &block) end

#evt_command_kill_focus(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMMAND_KILL_FOCUS command, which is generated by a control (WXMSW only).

Parameters:

Yield Parameters:



1320
# File 'lib/wx/doc/gen/event_list.rb', line 1320

def evt_command_kill_focus(id, meth = nil, &block) end

#evt_command_left_click(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMMAND_LEFT_CLICK command, which is generated by a control (WXMSW only).

Parameters:

Yield Parameters:



1296
# File 'lib/wx/doc/gen/event_list.rb', line 1296

def evt_command_left_click(id, meth = nil, &block) end

#evt_command_left_dclick(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMMAND_LEFT_DCLICK command, which is generated by a control (WXMSW only).

Parameters:

Yield Parameters:



1302
# File 'lib/wx/doc/gen/event_list.rb', line 1302

def evt_command_left_dclick(id, meth = nil, &block) end

#evt_command_range(id1, id2, evt_id, meth = nil) {|event| ... } ⇒ Object

Process a command for a range of window identifiers, supplying the minimum and maximum window identifiers, command event identifier, and member function or proc.

Parameters:

  • id1 (Integer)

    minimum window identifier

  • id2 (Integer)

    maximum window identifier

  • evt_id (Integer)

    event type identifier

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or event handling proc

Yield Parameters:



100
# File 'lib/wx/doc/evthandler.rb', line 100

def evt_command_range(id1, id2, evt_id, meth = nil, &block) end

#evt_command_right_click(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMMAND_RIGHT_CLICK command, which is generated by a control (WXMSW only).

Parameters:

Yield Parameters:



1308
# File 'lib/wx/doc/gen/event_list.rb', line 1308

def evt_command_right_click(id, meth = nil, &block) end

#evt_command_scroll(id, meth = nil) {|event| ... } ⇒ Object

Process all scroll events.

Parameters:

Yield Parameters:



72
# File 'lib/wx/doc/gen/event_list.rb', line 72

def evt_command_scroll(id, meth = nil, &block) end

#evt_command_scroll_bottom(id, meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_BOTTOM scroll to bottom or rightmost (maximum) position events.

Parameters:

Yield Parameters:



84
# File 'lib/wx/doc/gen/event_list.rb', line 84

def evt_command_scroll_bottom(id, meth = nil, &block) end

#evt_command_scroll_changed(id, meth = nil) {|event| ... } ⇒ Object

Processes a Wx::EVT_COMMAND_SCROLL_CHANGED event.

Parameters:

Yield Parameters:



126
# File 'lib/wx/doc/gen/event_list.rb', line 126

def evt_command_scroll_changed(id, meth = nil, &block) end

#evt_command_scroll_linedown(id, meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_LINEDOWN line down or right events.

Parameters:

Yield Parameters:



96
# File 'lib/wx/doc/gen/event_list.rb', line 96

def evt_command_scroll_linedown(id, meth = nil, &block) end

#evt_command_scroll_lineup(id, meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_LINEUP line up or left events.

Parameters:

Yield Parameters:



90
# File 'lib/wx/doc/gen/event_list.rb', line 90

def evt_command_scroll_lineup(id, meth = nil, &block) end

#evt_command_scroll_pagedown(id, meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_PAGEDOWN page down or right events.

Parameters:

Yield Parameters:



108
# File 'lib/wx/doc/gen/event_list.rb', line 108

def evt_command_scroll_pagedown(id, meth = nil, &block) end

#evt_command_scroll_pageup(id, meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_PAGEUP page up or left events.

Parameters:

Yield Parameters:



102
# File 'lib/wx/doc/gen/event_list.rb', line 102

def evt_command_scroll_pageup(id, meth = nil, &block) end

#evt_command_scroll_thumbrelease(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



120
# File 'lib/wx/doc/gen/event_list.rb', line 120

def evt_command_scroll_thumbrelease(id, meth = nil, &block) end

#evt_command_scroll_thumbtrack(id, meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the user drags the thumbtrack).

Parameters:

Yield Parameters:



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

def evt_command_scroll_thumbtrack(id, meth = nil, &block) end

#evt_command_scroll_top(id, meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_TOP scroll to top or leftmost (minimum) position events.

Parameters:

Yield Parameters:



78
# File 'lib/wx/doc/gen/event_list.rb', line 78

def evt_command_scroll_top(id, meth = nil, &block) end

#evt_command_set_focus(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_COMMAND_SET_FOCUS command, which is generated by a control (WXMSW only).

Parameters:

Yield Parameters:



1314
# File 'lib/wx/doc/gen/event_list.rb', line 1314

def evt_command_set_focus(id, meth = nil, &block) end

#evt_context_menu(meth = nil) {|event| ... } ⇒ Object

A right click (or other context menu command depending on platform) has been detected. See ContextMenuEvent. Processes a Wx::EVT_CONTEXT_MENU event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



587
# File 'lib/wx/doc/gen/event_list.rb', line 587

def evt_context_menu(meth = nil, &block) end

#evt_date_changed(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_DATE_CHANGED event, which fires when the user changes the current selection in the control.

Parameters:

Yield Parameters:



1593
# File 'lib/wx/doc/gen/event_list.rb', line 1593

def evt_date_changed(id, meth = nil, &block) end

#evt_dialup_connected(meth = nil) {|event| ... } ⇒ Object

A connection with the network was established. Processes a Wx::EVT_DIALUP_CONNECTED event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1332
# File 'lib/wx/doc/gen/event_list.rb', line 1332

def evt_dialup_connected(meth = nil, &block) end

#evt_dialup_disconnected(meth = nil) {|event| ... } ⇒ Object

The connection with the network was lost. Processes a Wx::EVT_DIALUP_DISCONNECTED event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1338
# File 'lib/wx/doc/gen/event_list.rb', line 1338

def evt_dialup_disconnected(meth = nil, &block) end

#evt_dirctrl_fileactivated(id, meth = nil) {|event| ... } ⇒ Object

The user activated a file by double-clicking or pressing Enter. Available since wxWidgets 2.9.5.
Processes a Wx::EVT_DIRCTRL_FILEACTIVATED event.

Parameters:

Yield Parameters:



1653
# File 'lib/wx/doc/gen/event_list.rb', line 1653

def evt_dirctrl_fileactivated(id, meth = nil, &block) end

#evt_dirctrl_selectionchanged(id, meth = nil) {|event| ... } ⇒ Object

Selected directory has changed. Processes a Wx::EVT_DIRCTRL_SELECTIONCHANGED event type. Notice that this event is generated even for the changes done by the program itself and not only those done by the user. Available since wxWidgets 2.9.5.

Parameters:

Yield Parameters:



1646
# File 'lib/wx/doc/gen/event_list.rb', line 1646

def evt_dirctrl_selectionchanged(id, meth = nil, &block) end

#evt_dirpicker_changed(id, meth = nil) {|event| ... } ⇒ Object

The user changed the directory selected in the control either using the button or using text control (see DIRP_USE_TEXTCTRL; note that in this case the event is fired only if the user’s input is valid, e.g. an existing directory path). Processes a Wx::EVT_DIRPICKER_CHANGED event.

Parameters:

Yield Parameters:



704
# File 'lib/wx/doc/gen/event_list.rb', line 704

def evt_dirpicker_changed(id, meth = nil, &block) end

#evt_display_changed(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_DISPLAY_CHANGED event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



532
# File 'lib/wx/doc/gen/event_list.rb', line 532

def evt_display_changed(meth = nil, &block) end

#evt_dpi_changed(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_DPI_CHANGED event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



537
# File 'lib/wx/doc/gen/event_list.rb', line 537

def evt_dpi_changed(meth = nil, &block) end

#evt_drop_files(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_DROP_FILES event. See DropFilesEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



499
# File 'lib/wx/doc/gen/event_list.rb', line 499

def evt_drop_files(meth = nil, &block) end

#evt_end_session(meth = nil) {|event| ... } ⇒ Object

Process an end session event, supplying the member function. See CloseEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



449
# File 'lib/wx/doc/gen/event_list.rb', line 449

def evt_end_session(meth = nil, &block) end

#evt_enter_window(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_ENTER_WINDOW event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



256
# File 'lib/wx/doc/gen/event_list.rb', line 256

def evt_enter_window(meth = nil, &block) end

#evt_erase_background(meth = nil) {|event| ... } ⇒ Object

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



378
# File 'lib/wx/doc/gen/event_list.rb', line 378

def evt_erase_background(meth = nil, &block) end

#evt_filectrl_fileactivated(id, meth = nil) {|event| ... } ⇒ Object

The user activated a file(by double-clicking or pressing Enter) Processes a Wx::EVT_FILECTRL_FILEACTIVATED event.

Parameters:

Yield Parameters:



711
# File 'lib/wx/doc/gen/event_list.rb', line 711

def evt_filectrl_fileactivated(id, meth = nil, &block) end

#evt_filectrl_filterchanged(id, meth = nil) {|event| ... } ⇒ Object

The current file filter of the file control has been changed Processes a Wx::EVT_FILECTRL_FILTERCHANGED event.

Parameters:

Yield Parameters:



732
# File 'lib/wx/doc/gen/event_list.rb', line 732

def evt_filectrl_filterchanged(id, meth = nil, &block) end

#evt_filectrl_folderchanged(id, meth = nil) {|event| ... } ⇒ Object

The current folder of the file control has been changed Processes a Wx::EVT_FILECTRL_FOLDERCHANGED event.

Parameters:

Yield Parameters:



725
# File 'lib/wx/doc/gen/event_list.rb', line 725

def evt_filectrl_folderchanged(id, meth = nil, &block) end

#evt_filectrl_selectionchanged(id, meth = nil) {|event| ... } ⇒ Object

The user changed the current selection(by selecting or deselecting a file) Processes a Wx::EVT_FILECTRL_SELECTIONCHANGED event.

Parameters:

Yield Parameters:



718
# File 'lib/wx/doc/gen/event_list.rb', line 718

def evt_filectrl_selectionchanged(id, meth = nil, &block) end

#evt_filepicker_changed(id, meth = nil) {|event| ... } ⇒ Object

The user changed the file selected in the control either using the button or using text control (see FLP_USE_TEXTCTRL; note that in this case the event is fired only if the user’s input is valid, e.g. an existing file path if FLP_FILE_MUST_EXIST was given). Processes a Wx::EVT_FILEPICKER_CHANGED event.

Parameters:

Yield Parameters:



697
# File 'lib/wx/doc/gen/event_list.rb', line 697

def evt_filepicker_changed(id, meth = nil, &block) end

#evt_find(id, meth = nil) {|event| ... } ⇒ Object

Find button was pressed in the dialog. Processes a Wx::EVT_FIND event.

Parameters:

Yield Parameters:



641
# File 'lib/wx/doc/gen/event_list.rb', line 641

def evt_find(id, meth = nil, &block) end

#evt_find_close(id, meth = nil) {|event| ... } ⇒ Object

The dialog is being destroyed, any pointers to it cannot be used any longer. Processes a Wx::EVT_FIND_CLOSE event.

Parameters:

Yield Parameters:



669
# File 'lib/wx/doc/gen/event_list.rb', line 669

def evt_find_close(id, meth = nil, &block) end

#evt_find_next(id, meth = nil) {|event| ... } ⇒ Object

Find next button was pressed in the dialog. Processes a Wx::EVT_FIND_NEXT event.

Parameters:

Yield Parameters:



648
# File 'lib/wx/doc/gen/event_list.rb', line 648

def evt_find_next(id, meth = nil, &block) end

#evt_find_replace(id, meth = nil) {|event| ... } ⇒ Object

Replace button was pressed in the dialog. Processes a Wx::EVT_FIND_REPLACE event.

Parameters:

Yield Parameters:



655
# File 'lib/wx/doc/gen/event_list.rb', line 655

def evt_find_replace(id, meth = nil, &block) end

#evt_find_replace_all(id, meth = nil) {|event| ... } ⇒ Object

Replace all button was pressed in the dialog. Processes a Wx::EVT_FIND_REPLACE_ALL event.

Parameters:

Yield Parameters:



662
# File 'lib/wx/doc/gen/event_list.rb', line 662

def evt_find_replace_all(id, meth = nil, &block) end

#evt_fontpicker_changed(id, meth = nil) {|event| ... } ⇒ Object

The user changed the font selected in the control either using the button or using text control (see FNTP_USE_TEXTCTRL; note that in this case the event is fired only if the user’s input is valid, i.e. recognizable). Processes a Wx::EVT_FONTPICKER_CHANGED event.

Parameters:

Yield Parameters:



634
# File 'lib/wx/doc/gen/event_list.rb', line 634

def evt_fontpicker_changed(id, meth = nil, &block) end

#evt_fullscreen(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_FULLSCREEN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



469
# File 'lib/wx/doc/gen/event_list.rb', line 469

def evt_fullscreen(meth = nil, &block) end

#evt_gesture_pan(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_GESTURE_PAN. Processes a Wx::EVT_GESTURE_PAN event.

Parameters:

Yield Parameters:



288
# File 'lib/wx/doc/gen/event_list.rb', line 288

def evt_gesture_pan(id, meth = nil, &block) end

#evt_gesture_rotate(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_GESTURE_ROTATE. Processes a Wx::EVT_GESTURE_ROTATE event.

Parameters:

Yield Parameters:



302
# File 'lib/wx/doc/gen/event_list.rb', line 302

def evt_gesture_rotate(id, meth = nil, &block) end

#evt_gesture_zoom(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_GESTURE_ZOOM. Processes a Wx::EVT_GESTURE_ZOOM event.

Parameters:

Yield Parameters:



295
# File 'lib/wx/doc/gen/event_list.rb', line 295

def evt_gesture_zoom(id, meth = nil, &block) end

#evt_grid_cell_changed(meth = nil) {|event| ... } ⇒ Object

The user changed the data in a cell. The old cell value as string is available from get_string event object method. Notice that vetoing this event still works for backwards compatibility reasons but any new code should only veto EVT_GRID_CELL_CHANGING event and not this one. Processes a GRID::EVT_GRID_CELL_CHANGED event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



21
# File 'lib/wx/doc/gen/grid/event_list.rb', line 21

def evt_grid_cell_changed(meth = nil, &block) end

#evt_grid_cell_changing(meth = nil) {|event| ... } ⇒ Object

The user is about to change the data in a cell. The new cell value as string is available from get_string event object method. This event can be vetoed if the change is not allowed. Processes a GRID::EVT_GRID_CELL_CHANGING event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



16
# File 'lib/wx/doc/gen/grid/event_list.rb', line 16

def evt_grid_cell_changing(meth = nil, &block) end

#evt_grid_cell_left_click(meth = nil) {|event| ... } ⇒ Object

The user clicked a cell with the left mouse button. Processes a GRID::EVT_GRID_CELL_LEFT_CLICK event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



26
# File 'lib/wx/doc/gen/grid/event_list.rb', line 26

def evt_grid_cell_left_click(meth = nil, &block) end

#evt_grid_cell_left_dclick(meth = nil) {|event| ... } ⇒ Object

The user double-clicked a cell with the left mouse button. Processes a GRID::EVT_GRID_CELL_LEFT_DCLICK event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



31
# File 'lib/wx/doc/gen/grid/event_list.rb', line 31

def evt_grid_cell_left_dclick(meth = nil, &block) end

#evt_grid_cell_right_click(meth = nil) {|event| ... } ⇒ Object

The user clicked a cell with the right mouse button. Processes a GRID::EVT_GRID_CELL_RIGHT_CLICK event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



36
# File 'lib/wx/doc/gen/grid/event_list.rb', line 36

def evt_grid_cell_right_click(meth = nil, &block) end

#evt_grid_cell_right_dclick(meth = nil) {|event| ... } ⇒ Object

The user double-clicked a cell with the right mouse button. Processes a GRID::EVT_GRID_CELL_RIGHT_DCLICK event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



41
# File 'lib/wx/doc/gen/grid/event_list.rb', line 41

def evt_grid_cell_right_dclick(meth = nil, &block) end

#evt_grid_cmd_col_size(id, meth = nil) {|event| ... } ⇒ Object

The user resized a column, corresponds to GRID::EVT_GRID_COL_SIZE event type. Processes a GRID::EVT_GRID_CMD_COL_SIZE event.

Parameters:

Yield Parameters:



107
# File 'lib/wx/doc/gen/grid/event_list.rb', line 107

def evt_grid_cmd_col_size(id, meth = nil, &block) end

#evt_grid_cmd_editor_created(id, meth = nil) {|event| ... } ⇒ Object

The editor for a cell was created; variant taking a window identifier. Processes a GRID::EVT_GRID_EDITOR_CREATED event type.

Parameters:

Yield Parameters:



149
# File 'lib/wx/doc/gen/grid/event_list.rb', line 149

def evt_grid_cmd_editor_created(id, meth = nil, &block) end

#evt_grid_cmd_range_selected(id, meth = nil) {|event| ... } ⇒ Object

The user selected a group of contiguous cells; variant taking a window identifier. Processes a GRID::EVT_GRID_RANGE_SELECTED event type. This event is available in wxWidgets 3.1.5 and later only and was called Wx::EVT_GRID_CMD_RANGE_SELECT in the previous versions.

Parameters:

Yield Parameters:



171
# File 'lib/wx/doc/gen/grid/event_list.rb', line 171

def evt_grid_cmd_range_selected(id, meth = nil, &block) end

#evt_grid_cmd_range_selecting(id, meth = nil) {|event| ... } ⇒ Object

The user is selecting a group of contiguous cells; variant taking a window identifier. Processes a GRID::EVT_GRID_RANGE_SELECTING event type. This event is available in wxWidgets 3.1.5 and later only.

Parameters:

Yield Parameters:



160
# File 'lib/wx/doc/gen/grid/event_list.rb', line 160

def evt_grid_cmd_range_selecting(id, meth = nil, &block) end

#evt_grid_cmd_row_size(id, meth = nil) {|event| ... } ⇒ Object

The user resized a row, corresponds to GRID::EVT_GRID_ROW_SIZE event type. Processes a GRID::EVT_GRID_CMD_ROW_SIZE event.

Parameters:

Yield Parameters:



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

def evt_grid_cmd_row_size(id, meth = nil, &block) end

#evt_grid_col_auto_size(meth = nil) {|event| ... } ⇒ Object

This event is sent when a column must be resized to its best size, e.g. when the user double clicks the column divider. The default implementation simply resizes the column to fit the column label (but not its contents as this could be too slow for big grids). This macro corresponds to GRID::EVT_GRID_COL_AUTO_SIZE event type and is new since wxWidgets 2.9.5. Processes a GRID::EVT_GRID_COL_AUTO_SIZE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



132
# File 'lib/wx/doc/gen/grid/event_list.rb', line 132

def evt_grid_col_auto_size(meth = nil, &block) end

#evt_grid_col_move(meth = nil) {|event| ... } ⇒ Object

The user tries to change the order of the columns in the grid by dragging the column specified by get_col. This event can be vetoed to either prevent the user from reordering the column change completely (but notice that if you don’t want to allow it at all, you simply shouldn’t call GRID::Grid#enable_drag_col_move in the first place), vetoed but handled in some way in the handler, e.g. by really moving the column to the new position at the associated table level, or allowed to proceed in which case GRID::Grid#set_col_pos is used to reorder the columns display order without affecting the use of the column indices otherwise. This event macro corresponds to GRID::EVT_GRID_COL_MOVE event type. Processes a GRID::EVT_GRID_COL_MOVE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



88
# File 'lib/wx/doc/gen/grid/event_list.rb', line 88

def evt_grid_col_move(meth = nil, &block) end

#evt_grid_col_size(meth = nil) {|event| ... } ⇒ Object

Same as EVT_GRID_CMD_COL_SIZE() but uses StandardID::ID_ANY id. Processes a GRID::EVT_GRID_COL_SIZE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



126
# File 'lib/wx/doc/gen/grid/event_list.rb', line 126

def evt_grid_col_size(meth = nil, &block) end

#evt_grid_col_sort(meth = nil) {|event| ... } ⇒ Object

This event is generated when a column is clicked by the user and its name is explained by the fact that the custom reaction to a click on a column is to sort the grid contents by this column. However the grid itself has no special support for sorting and it’s up to the handler of this event to update the associated table. But if the event is handled (and not vetoed) the grid supposes that the table was indeed resorted and updates the column to indicate the new sort order and refreshes itself. This event macro corresponds to GRID::EVT_GRID_COL_SORT event type. Processes a GRID::EVT_GRID_COL_SORT event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



94
# File 'lib/wx/doc/gen/grid/event_list.rb', line 94

def evt_grid_col_sort(meth = nil, &block) end

#evt_grid_editor_created(meth = nil) {|event| ... } ⇒ Object

The editor for a cell was created. Processes a GRID::EVT_GRID_EDITOR_CREATED event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



143
# File 'lib/wx/doc/gen/grid/event_list.rb', line 143

def evt_grid_editor_created(meth = nil, &block) end

#evt_grid_editor_hidden(meth = nil) {|event| ... } ⇒ Object

The editor for a cell was hidden. Processes a GRID::EVT_GRID_EDITOR_HIDDEN event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



46
# File 'lib/wx/doc/gen/grid/event_list.rb', line 46

def evt_grid_editor_hidden(meth = nil, &block) end

#evt_grid_editor_shown(meth = nil) {|event| ... } ⇒ Object

The editor for a cell was shown. Processes a GRID::EVT_GRID_EDITOR_SHOWN event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



51
# File 'lib/wx/doc/gen/grid/event_list.rb', line 51

def evt_grid_editor_shown(meth = nil, &block) end

#evt_grid_label_left_click(meth = nil) {|event| ... } ⇒ Object

The user clicked a label with the left mouse button. Processes a GRID::EVT_GRID_LABEL_LEFT_CLICK event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



56
# File 'lib/wx/doc/gen/grid/event_list.rb', line 56

def evt_grid_label_left_click(meth = nil, &block) end

#evt_grid_label_left_dclick(meth = nil) {|event| ... } ⇒ Object

The user double-clicked a label with the left mouse button. Processes a GRID::EVT_GRID_LABEL_LEFT_DCLICK event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



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

def evt_grid_label_left_dclick(meth = nil, &block) end

#evt_grid_label_right_click(meth = nil) {|event| ... } ⇒ Object

The user clicked a label with the right mouse button. Processes a GRID::EVT_GRID_LABEL_RIGHT_CLICK event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



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

def evt_grid_label_right_click(meth = nil, &block) end

#evt_grid_label_right_dclick(meth = nil) {|event| ... } ⇒ Object

The user double-clicked a label with the right mouse button. Processes a GRID::EVT_GRID_LABEL_RIGHT_DCLICK event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



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

def evt_grid_label_right_dclick(meth = nil, &block) end

#evt_grid_range_selected(meth = nil) {|event| ... } ⇒ Object

The user selected a group of contiguous cells. Processes a GRID::EVT_GRID_RANGE_SELECTED event type. This event is available in wxWidgets 3.1.5 and later only and was called Wx::EVT_GRID_RANGE_SELECT in the previous versions.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



165
# File 'lib/wx/doc/gen/grid/event_list.rb', line 165

def evt_grid_range_selected(meth = nil, &block) end

#evt_grid_range_selecting(meth = nil) {|event| ... } ⇒ Object

The user is selecting a group of contiguous cells. Processes a GRID::EVT_GRID_RANGE_SELECTING event type. This event is available in wxWidgets 3.1.5 and later only.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



154
# File 'lib/wx/doc/gen/grid/event_list.rb', line 154

def evt_grid_range_selecting(meth = nil, &block) end

#evt_grid_row_auto_size(meth = nil) {|event| ... } ⇒ Object

This event is sent when a row must be resized to its best size, e.g. when the user double clicks the row divider. The default implementation simply resizes the row to fit the row label (but not its contents as this could be too slow for big grids). This macro corresponds to GRID::EVT_GRID_ROW_AUTO_SIZE event type and is new since wxWidgets 3.1.7. Processes a GRID::EVT_GRID_ROW_AUTO_SIZE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



120
# File 'lib/wx/doc/gen/grid/event_list.rb', line 120

def evt_grid_row_auto_size(meth = nil, &block) end

#evt_grid_row_move(meth = nil) {|event| ... } ⇒ Object

The user tries to change the order of the rows in the grid by dragging the row specified by get_row. This event can be vetoed to either prevent the user from reordering the row change completely (but notice that if you don’t want to allow it at all, you simply shouldn’t call GRID::Grid#enable_drag_row_move in the first place), vetoed but handled in some way in the handler, e.g. by really moving the row to the new position at the associated table level, or allowed to proceed in which case GRID::Grid#set_row_pos is used to reorder the rows display order without affecting the use of the row indices otherwise. This event macro corresponds to GRID::EVT_GRID_ROW_MOVE event type. It is only available since wxWidgets 3.1.7. Processes a GRID::EVT_GRID_ROW_MOVE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



82
# File 'lib/wx/doc/gen/grid/event_list.rb', line 82

def evt_grid_row_move(meth = nil, &block) end

#evt_grid_row_size(meth = nil) {|event| ... } ⇒ Object

Same as EVT_GRID_CMD_ROW_SIZE() but uses StandardID::ID_ANY id. Processes a GRID::EVT_GRID_ROW_SIZE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



138
# File 'lib/wx/doc/gen/grid/event_list.rb', line 138

def evt_grid_row_size(meth = nil, &block) end

#evt_grid_select_cell(meth = nil) {|event| ... } ⇒ Object

The given cell is about to be made current, either by user or by the program via a call to GRID::Grid#set_grid_cursor or GRID::Grid#go_to_cell. The event can be vetoed to prevent this from happening and GRID::Grid#get_grid_cursor_coords still returns the previous current cell coordinates during the event handler execution, while the new ones are available via the event object get_row and get_col functions. Processes a GRID::EVT_GRID_SELECT_CELL event type.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



76
# File 'lib/wx/doc/gen/grid/event_list.rb', line 76

def evt_grid_select_cell(meth = nil, &block) end

#evt_grid_tabbing(meth = nil) {|event| ... } ⇒ Object

This event is generated when the user presses TAB or Shift-TAB in the grid. It can be used to customize the simple default TAB handling logic, e.g. to go to the next non-empty cell instead of just the next cell. See also GRID::Grid#set_tab_behaviour. This event is new since wxWidgets 2.9.5. Processes a GRID::EVT_GRID_TABBING event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



100
# File 'lib/wx/doc/gen/grid/event_list.rb', line 100

def evt_grid_tabbing(meth = nil, &block) end

#evt_header_begin_reorder(id, meth = nil) {|event| ... } ⇒ Object

The user started to drag the column with the specified index (this can only happen for the controls with HD_ALLOW_REORDER style). This event can be vetoed to prevent the column from being reordered, otherwise the end reorder message will be generated later. Processes a Wx::EVT_HEADER_BEGIN_REORDER event.

Parameters:

Yield Parameters:



1532
# File 'lib/wx/doc/gen/event_list.rb', line 1532

def evt_header_begin_reorder(id, meth = nil, &block) end

#evt_header_begin_resize(id, meth = nil) {|event| ... } ⇒ Object

The user started to drag the separator to the right of the column with the specified index (this can only happen for the columns for which HeaderColumn#is_resizeable returns true). The event can be vetoed to prevent the column from being resized. If it isn’t, the resizing and end resize (or dragging cancelled) events will be generated later. Processes a Wx::EVT_HEADER_BEGIN_RESIZE event.

Parameters:

Yield Parameters:



1511
# File 'lib/wx/doc/gen/event_list.rb', line 1511

def evt_header_begin_resize(id, meth = nil, &block) end

#evt_header_click(id, meth = nil) {|event| ... } ⇒ Object

A column heading was clicked. Processes a Wx::EVT_HEADER_CLICK event.

Parameters:

Yield Parameters:



1462
# File 'lib/wx/doc/gen/event_list.rb', line 1462

def evt_header_click(id, meth = nil, &block) end

#evt_header_dclick(id, meth = nil) {|event| ... } ⇒ Object

A column heading was double clicked. Processes a Wx::EVT_HEADER_DCLICK event.

Parameters:

Yield Parameters:



1483
# File 'lib/wx/doc/gen/event_list.rb', line 1483

def evt_header_dclick(id, meth = nil, &block) end

#evt_header_dragging_cancelled(id, meth = nil) {|event| ... } ⇒ Object

The resizing or reordering operation currently in progress was cancelled. This can happen if the user pressed Esc key while dragging the mouse or the mouse capture was lost for some other reason. You only need to handle this event if your application entered into some modal mode when resizing or reordering began, in which case it should handle this event in addition to the matching end resizing or reordering ones. Processes a Wx::EVT_HEADER_DRAGGING_CANCELLED event.

Parameters:

Yield Parameters:



1546
# File 'lib/wx/doc/gen/event_list.rb', line 1546

def evt_header_dragging_cancelled(id, meth = nil, &block) end

#evt_header_end_reorder(id, meth = nil) {|event| ... } ⇒ Object

The user dropped the column in its new location. The event can be vetoed to prevent the column from being placed at the new position or handled to update the display of the data in the associated control to match the new column location (available from HeaderCtrlEvent#get_new_order). Processes a Wx::EVT_HEADER_END_REORDER event.

Parameters:

Yield Parameters:



1539
# File 'lib/wx/doc/gen/event_list.rb', line 1539

def evt_header_end_reorder(id, meth = nil, &block) end

#evt_header_end_resize(id, meth = nil) {|event| ... } ⇒ Object

The user stopped dragging the column by releasing the mouse. The column should normally be resized to the value of HeaderCtrlEvent#get_width. Processes a Wx::EVT_HEADER_END_RESIZE event.

Parameters:

Yield Parameters:



1525
# File 'lib/wx/doc/gen/event_list.rb', line 1525

def evt_header_end_resize(id, meth = nil, &block) end

#evt_header_middle_click(id, meth = nil) {|event| ... } ⇒ Object

A column heading was clicked with the middle mouse button. Processes a Wx::EVT_HEADER_MIDDLE_CLICK event.

Parameters:

Yield Parameters:



1476
# File 'lib/wx/doc/gen/event_list.rb', line 1476

def evt_header_middle_click(id, meth = nil, &block) end

#evt_header_middle_dclick(id, meth = nil) {|event| ... } ⇒ Object

A column heading was double clicked with the middle mouse button. Processes a Wx::EVT_HEADER_MIDDLE_DCLICK event.

Parameters:

Yield Parameters:



1497
# File 'lib/wx/doc/gen/event_list.rb', line 1497

def evt_header_middle_dclick(id, meth = nil, &block) end

#evt_header_resizing(id, meth = nil) {|event| ... } ⇒ Object

The user is dragging the column with the specified index resizing it and its current width is HeaderCtrlEvent#get_width. The event can be vetoed to stop the dragging operation completely at any time. Processes a Wx::EVT_HEADER_RESIZING event.

Parameters:

Yield Parameters:



1518
# File 'lib/wx/doc/gen/event_list.rb', line 1518

def evt_header_resizing(id, meth = nil, &block) end

#evt_header_right_click(id, meth = nil) {|event| ... } ⇒ Object

A column heading was right clicked. Processes a Wx::EVT_HEADER_RIGHT_CLICK event.

Parameters:

Yield Parameters:



1469
# File 'lib/wx/doc/gen/event_list.rb', line 1469

def evt_header_right_click(id, meth = nil, &block) end

#evt_header_right_dclick(id, meth = nil) {|event| ... } ⇒ Object

A column heading was right double clicked. Processes a Wx::EVT_HEADER_RIGHT_DCLICK event.

Parameters:

Yield Parameters:



1490
# File 'lib/wx/doc/gen/event_list.rb', line 1490

def evt_header_right_dclick(id, meth = nil, &block) end

#evt_header_separator_dclick(id, meth = nil) {|event| ... } ⇒ Object

Separator to the right of the specified column was double clicked (this action is commonly used to resize the column to fit its contents width and the control provides update_column_width_to_fit method to make implementing this easier). Processes a Wx::EVT_HEADER_SEPARATOR_DCLICK event.

Parameters:

Yield Parameters:



1504
# File 'lib/wx/doc/gen/event_list.rb', line 1504

def evt_header_separator_dclick(id, meth = nil, &block) end

#evt_help(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_HELP event. See HelpEvent.

Parameters:

Yield Parameters:



553
# File 'lib/wx/doc/gen/event_list.rb', line 553

def evt_help(id, meth = nil, &block) end

#evt_help_range(id1, id2, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_HELP event for a range of ids. See HelpEvent.

Parameters:

Yield Parameters:



560
# File 'lib/wx/doc/gen/event_list.rb', line 560

def evt_help_range(id1,  id2, meth = nil, &block) end

#evt_hibernate(meth = nil) {|event| ... } ⇒ Object

Process a hibernate event. See ActivateEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



403
# File 'lib/wx/doc/gen/event_list.rb', line 403

def evt_hibernate(meth = nil, &block) end

#evt_hotkey(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_HOTKEY event.

Parameters:

  • id (Integer)

    hotkey id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



149
# File 'lib/wx/doc/evthandler.rb', line 149

def evt_hotkey(id, meth = nil, &block) end

#evt_html_cell_clicked(id, meth = nil) {|event| ... } ⇒ Object

A HTML::HtmlCell was clicked. See HTML::HtmlCellEvent. Processes a HTML::EVT_HTML_CELL_CLICKED event.

Parameters:

Yield Parameters:



25
# File 'lib/wx/doc/gen/html/event_list.rb', line 25

def evt_html_cell_clicked(id, meth = nil, &block) end

#evt_html_cell_hover(id, meth = nil) {|event| ... } ⇒ Object

The mouse passed over a HTML::HtmlCell. See HTML::HtmlCellEvent. Processes a HTML::EVT_HTML_CELL_HOVER event.

Parameters:

Yield Parameters:



18
# File 'lib/wx/doc/gen/html/event_list.rb', line 18

def evt_html_cell_hover(id, meth = nil, &block) end

A HTML::HtmlCell which contains a hyperlink was clicked. See HTML::HtmlLinkEvent Processes a HTML::EVT_HTML_LINK_CLICKED event.

Parameters:

Yield Parameters:



32
# File 'lib/wx/doc/gen/html/event_list.rb', line 32

def evt_html_link_clicked(id, meth = nil, &block) end

User clicked on a hyperlink. Processes a Wx::EVT_HYPERLINK event.

Parameters:

Yield Parameters:



1151
# File 'lib/wx/doc/gen/event_list.rb', line 1151

def evt_hyperlink(id, meth = nil, &block) end

#evt_iconize(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_ICONIZE event. See IconizeEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



459
# File 'lib/wx/doc/gen/event_list.rb', line 459

def evt_iconize(meth = nil, &block) end

#evt_idle(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_IDLE event. See IdleEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



16
# File 'lib/wx/doc/gen/event_list.rb', line 16

def evt_idle(meth = nil, &block) end

#evt_init_dialog(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_INIT_DIALOG event. See InitDialogEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



408
# File 'lib/wx/doc/gen/event_list.rb', line 408

def evt_init_dialog(meth = nil, &block) end

#evt_joy_button_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_JOY_BUTTON_DOWN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



474
# File 'lib/wx/doc/gen/event_list.rb', line 474

def evt_joy_button_down(meth = nil, &block) end

#evt_joy_button_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_JOY_BUTTON_UP event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



479
# File 'lib/wx/doc/gen/event_list.rb', line 479

def evt_joy_button_up(meth = nil, &block) end

#evt_joy_move(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_JOY_MOVE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



484
# File 'lib/wx/doc/gen/event_list.rb', line 484

def evt_joy_move(meth = nil, &block) end

#evt_joy_zmove(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_JOY_ZMOVE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



489
# File 'lib/wx/doc/gen/event_list.rb', line 489

def evt_joy_zmove(meth = nil, &block) end

#evt_joystick_events(meth = nil) {|event| ... } ⇒ Object

Processes all joystick events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



494
# File 'lib/wx/doc/gen/event_list.rb', line 494

def evt_joystick_events(meth = nil, &block) end

#evt_key_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_KEY_DOWN event (any key has been pressed). See KeyEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



328
# File 'lib/wx/doc/gen/event_list.rb', line 328

def evt_key_down(meth = nil, &block) end

#evt_key_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_KEY_UP event (any key has been released). See KeyEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



333
# File 'lib/wx/doc/gen/event_list.rb', line 333

def evt_key_up(meth = nil, &block) end

#evt_kill_focus(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_KILL_FOCUS event. See FocusEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



388
# File 'lib/wx/doc/gen/event_list.rb', line 388

def evt_kill_focus(meth = nil, &block) end

#evt_leave_window(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_LEAVE_WINDOW event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



261
# File 'lib/wx/doc/gen/event_list.rb', line 261

def evt_leave_window(meth = nil, &block) end

#evt_left_dclick(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_LEFT_DCLICK event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



186
# File 'lib/wx/doc/gen/event_list.rb', line 186

def evt_left_dclick(meth = nil, &block) end

#evt_left_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_LEFT_DOWN event. The handler of this event should normally call event.Skip() to allow the default processing to take place as otherwise the window under mouse wouldn’t get the focus.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



176
# File 'lib/wx/doc/gen/event_list.rb', line 176

def evt_left_down(meth = nil, &block) end

#evt_left_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_LEFT_UP event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



181
# File 'lib/wx/doc/gen/event_list.rb', line 181

def evt_left_up(meth = nil, &block) end

#evt_list_begin_drag(id, meth = nil) {|event| ... } ⇒ Object

Begin dragging with the left mouse button. Processes a Wx::EVT_LIST_BEGIN_DRAG event.

Parameters:

Yield Parameters:



739
# File 'lib/wx/doc/gen/event_list.rb', line 739

def evt_list_begin_drag(id, meth = nil, &block) end

#evt_list_begin_label_edit(id, meth = nil) {|event| ... } ⇒ Object

Begin editing a label. This can be prevented by calling veto. Processes a Wx::EVT_LIST_BEGIN_LABEL_EDIT event.

Parameters:

Yield Parameters:



753
# File 'lib/wx/doc/gen/event_list.rb', line 753

def evt_list_begin_label_edit(id, meth = nil, &block) end

#evt_list_begin_rdrag(id, meth = nil) {|event| ... } ⇒ Object

Begin dragging with the right mouse button. Processes a Wx::EVT_LIST_BEGIN_RDRAG event.

Parameters:

Yield Parameters:



746
# File 'lib/wx/doc/gen/event_list.rb', line 746

def evt_list_begin_rdrag(id, meth = nil, &block) end

#evt_list_cache_hint(id, meth = nil) {|event| ... } ⇒ Object

Prepare cache for a virtual list control Processes a Wx::EVT_LIST_CACHE_HINT event.

Parameters:

Yield Parameters:



872
# File 'lib/wx/doc/gen/event_list.rb', line 872

def evt_list_cache_hint(id, meth = nil, &block) end

#evt_list_col_begin_drag(id, meth = nil) {|event| ... } ⇒ Object

The user started resizing a column - can be vetoed. Processes a Wx::EVT_LIST_COL_BEGIN_DRAG event.

Parameters:

Yield Parameters:



851
# File 'lib/wx/doc/gen/event_list.rb', line 851

def evt_list_col_begin_drag(id, meth = nil, &block) end

#evt_list_col_click(id, meth = nil) {|event| ... } ⇒ Object

A column (m_col) has been left-clicked. Processes a Wx::EVT_LIST_COL_CLICK event.

Parameters:

Yield Parameters:



837
# File 'lib/wx/doc/gen/event_list.rb', line 837

def evt_list_col_click(id, meth = nil, &block) end

#evt_list_col_dragging(id, meth = nil) {|event| ... } ⇒ Object

The divider between columns is being dragged. Processes a Wx::EVT_LIST_COL_DRAGGING event.

Parameters:

Yield Parameters:



858
# File 'lib/wx/doc/gen/event_list.rb', line 858

def evt_list_col_dragging(id, meth = nil, &block) end

#evt_list_col_end_drag(id, meth = nil) {|event| ... } ⇒ Object

A column has been resized by the user. Processes a Wx::EVT_LIST_COL_END_DRAG event.

Parameters:

Yield Parameters:



865
# File 'lib/wx/doc/gen/event_list.rb', line 865

def evt_list_col_end_drag(id, meth = nil, &block) end

#evt_list_col_right_click(id, meth = nil) {|event| ... } ⇒ Object

A column (m_col) (which can be -1 if the click occurred outside any column) has been right-clicked. Processes a Wx::EVT_LIST_COL_RIGHT_CLICK event.

Parameters:

Yield Parameters:



844
# File 'lib/wx/doc/gen/event_list.rb', line 844

def evt_list_col_right_click(id, meth = nil, &block) end

#evt_list_delete_all_items(id, meth = nil) {|event| ... } ⇒ Object

Delete all items. Processes a Wx::EVT_LIST_DELETE_ALL_ITEMS event.

Parameters:

Yield Parameters:



774
# File 'lib/wx/doc/gen/event_list.rb', line 774

def evt_list_delete_all_items(id, meth = nil, &block) end

#evt_list_delete_item(id, meth = nil) {|event| ... } ⇒ Object

Delete an item. Processes a Wx::EVT_LIST_DELETE_ITEM event.

Parameters:

Yield Parameters:



767
# File 'lib/wx/doc/gen/event_list.rb', line 767

def evt_list_delete_item(id, meth = nil, &block) end

#evt_list_end_label_edit(id, meth = nil) {|event| ... } ⇒ Object

Finish editing a label. This can be prevented by calling veto. Processes a Wx::EVT_LIST_END_LABEL_EDIT event.

Parameters:

Yield Parameters:



760
# File 'lib/wx/doc/gen/event_list.rb', line 760

def evt_list_end_label_edit(id, meth = nil, &block) end

#evt_list_insert_item(id, meth = nil) {|event| ... } ⇒ Object

An item has been inserted. Processes a Wx::EVT_LIST_INSERT_ITEM event.

Parameters:

Yield Parameters:



830
# File 'lib/wx/doc/gen/event_list.rb', line 830

def evt_list_insert_item(id, meth = nil, &block) end

#evt_list_item_activated(id, meth = nil) {|event| ... } ⇒ Object

The item has been activated (ENTER or double click). Processes a Wx::EVT_LIST_ITEM_ACTIVATED event.

Parameters:

Yield Parameters:



795
# File 'lib/wx/doc/gen/event_list.rb', line 795

def evt_list_item_activated(id, meth = nil, &block) end

#evt_list_item_checked(id, meth = nil) {|event| ... } ⇒ Object

The item has been checked (new since wxWidgets 3.1.0). Processes a Wx::EVT_LIST_ITEM_CHECKED event.

Parameters:

Yield Parameters:



879
# File 'lib/wx/doc/gen/event_list.rb', line 879

def evt_list_item_checked(id, meth = nil, &block) end

#evt_list_item_deselected(id, meth = nil) {|event| ... } ⇒ Object

The item has been deselected. get_index may be -1 with virtual lists. Processes a Wx::EVT_LIST_ITEM_DESELECTED event.

Parameters:

Yield Parameters:



788
# File 'lib/wx/doc/gen/event_list.rb', line 788

def evt_list_item_deselected(id, meth = nil, &block) end

#evt_list_item_focused(id, meth = nil) {|event| ... } ⇒ Object

The currently focused item has changed. Processes a Wx::EVT_LIST_ITEM_FOCUSED event.

Parameters:

Yield Parameters:



802
# File 'lib/wx/doc/gen/event_list.rb', line 802

def evt_list_item_focused(id, meth = nil, &block) end

#evt_list_item_middle_click(id, meth = nil) {|event| ... } ⇒ Object

The middle mouse button has been clicked on an item. Processes a Wx::EVT_LIST_ITEM_MIDDLE_CLICK event.

Parameters:

Yield Parameters:



809
# File 'lib/wx/doc/gen/event_list.rb', line 809

def evt_list_item_middle_click(id, meth = nil, &block) end

#evt_list_item_right_click(id, meth = nil) {|event| ... } ⇒ Object

The right mouse button has been clicked on an item. Processes a Wx::EVT_LIST_ITEM_RIGHT_CLICK event.

Parameters:

Yield Parameters:



816
# File 'lib/wx/doc/gen/event_list.rb', line 816

def evt_list_item_right_click(id, meth = nil, &block) end

#evt_list_item_selected(id, meth = nil) {|event| ... } ⇒ Object

The item has been selected. Notice that the mouse is captured by the control itself when this event is generated, see event handling overview. Processes a Wx::EVT_LIST_ITEM_SELECTED event.

Parameters:

Yield Parameters:



781
# File 'lib/wx/doc/gen/event_list.rb', line 781

def evt_list_item_selected(id, meth = nil, &block) end

#evt_list_item_unchecked(id, meth = nil) {|event| ... } ⇒ Object

The item has been unchecked (new since wxWidgets 3.1.0). Processes a Wx::EVT_LIST_ITEM_UNCHECKED event.

Parameters:

Yield Parameters:



886
# File 'lib/wx/doc/gen/event_list.rb', line 886

def evt_list_item_unchecked(id, meth = nil, &block) end

#evt_list_key_down(id, meth = nil) {|event| ... } ⇒ Object

A key has been pressed. get_index may be -1 if no item is selected. Processes a Wx::EVT_LIST_KEY_DOWN event.

Parameters:

Yield Parameters:



823
# File 'lib/wx/doc/gen/event_list.rb', line 823

def evt_list_key_down(id, meth = nil, &block) end

#evt_listbook_page_changed(id, meth = nil) {|event| ... } ⇒ Object

The page selection was changed. Processes a Wx::EVT_LISTBOOK_PAGE_CHANGED event.

Parameters:

Yield Parameters:



1425
# File 'lib/wx/doc/gen/event_list.rb', line 1425

def evt_listbook_page_changed(id, meth = nil, &block) end

#evt_listbook_page_changing(id, meth = nil) {|event| ... } ⇒ Object

The page selection is about to be changed. Processes a Wx::EVT_LISTBOOK_PAGE_CHANGING event. This event can be vetoed.

Parameters:

Yield Parameters:



1431
# File 'lib/wx/doc/gen/event_list.rb', line 1431

def evt_listbook_page_changing(id, meth = nil, &block) end

#evt_listbox(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_LISTBOX event, when an item on the list is selected. See CommandEvent.

Parameters:

Yield Parameters:



1181
# File 'lib/wx/doc/gen/event_list.rb', line 1181

def evt_listbox(id, meth = nil, &block) end

#evt_listbox_dclick(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_LISTBOX_DCLICK event, when the listbox is double-clicked. See CommandEvent.

Parameters:

Yield Parameters:



1187
# File 'lib/wx/doc/gen/event_list.rb', line 1187

def evt_listbox_dclick(id, meth = nil, &block) end

#evt_long_press(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_LONG_PRESS. Processes a Wx::EVT_LONG_PRESS event.

Parameters:

Yield Parameters:



316
# File 'lib/wx/doc/gen/event_list.rb', line 316

def evt_long_press(id, meth = nil, &block) end

#evt_magnify(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MAGNIFY event (new since wxWidgets 3.1.0).

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



276
# File 'lib/wx/doc/gen/event_list.rb', line 276

def evt_magnify(meth = nil, &block) end

#evt_maximize(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MAXIMIZE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



464
# File 'lib/wx/doc/gen/event_list.rb', line 464

def evt_maximize(meth = nil, &block) end

#evt_media_finished(id, meth = nil) {|event| ... } ⇒ Object

Sent when a media has finished playing in a MediaCtrl. Processes a Wx::EVT_MEDIA_FINISHED event type.

Parameters:

Yield Parameters:



1126
# File 'lib/wx/doc/gen/event_list.rb', line 1126

def evt_media_finished(id, meth = nil, &block) end

#evt_media_loaded(id, meth = nil) {|event| ... } ⇒ Object

Sent when a media has loaded enough data that it can start playing. Processes a Wx::EVT_MEDIA_LOADED event type.

Parameters:

Yield Parameters:



1114
# File 'lib/wx/doc/gen/event_list.rb', line 1114

def evt_media_loaded(id, meth = nil, &block) end

#evt_media_pause(id, meth = nil) {|event| ... } ⇒ Object

Sent when a media has switched to the MediaState::MEDIASTATE_PAUSED state. Processes a Wx::EVT_MEDIA_PAUSE event type.

Parameters:

Yield Parameters:



1144
# File 'lib/wx/doc/gen/event_list.rb', line 1144

def evt_media_pause(id, meth = nil, &block) end

#evt_media_play(id, meth = nil) {|event| ... } ⇒ Object

Sent when a media has switched to the MediaState::MEDIASTATE_PLAYING state. Processes a Wx::EVT_MEDIA_PLAY event type.

Parameters:

Yield Parameters:



1138
# File 'lib/wx/doc/gen/event_list.rb', line 1138

def evt_media_play(id, meth = nil, &block) end

#evt_media_statechanged(id, meth = nil) {|event| ... } ⇒ Object

Sent when a media has switched its state (from any media state). Processes a Wx::EVT_MEDIA_STATECHANGED event type.

Parameters:

Yield Parameters:



1132
# File 'lib/wx/doc/gen/event_list.rb', line 1132

def evt_media_statechanged(id, meth = nil, &block) end

#evt_media_stop(id, meth = nil) {|event| ... } ⇒ Object

Sent when a media has switched to the MediaState::MEDIASTATE_STOPPED state. You may be able to Veto this event to prevent it from stopping, causing it to continue playing - even if it has reached that end of the media (note that this may not have the desired effect - if you want to loop the media, for example, catch the EVT_MEDIA_FINISHED and play there instead). Processes a Wx::EVT_MEDIA_STOP event type.

Parameters:

Yield Parameters:



1120
# File 'lib/wx/doc/gen/event_list.rb', line 1120

def evt_media_stop(id, meth = nil, &block) end

#evt_menu(id, meth = nil) {|event| ... } ⇒ Object

The same as EVT_TOOL(). Processes a Wx::EVT_MENU event.

Parameters:

Yield Parameters:



1200
# File 'lib/wx/doc/gen/event_list.rb', line 1200

def evt_menu(id, meth = nil, &block) end

#evt_menu_close(meth = nil) {|event| ... } ⇒ Object

A menu has been just closed. This type of event is sent as MenuEvent. Processes a Wx::EVT_MENU_CLOSE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



420
# File 'lib/wx/doc/gen/event_list.rb', line 420

def evt_menu_close(meth = nil, &block) end

#evt_menu_highlight(id, meth = nil) {|event| ... } ⇒ Object

The menu item with the specified id has been highlighted. If the id is StandardID::ID_NONE, highlighting has been removed from the previously highlighted menu item and there is no highlighted item any more. This is used by Frame to show help prompts in the status bar. This type of event is sent as MenuEvent. Processes a Wx::EVT_MENU_HIGHLIGHT event.

Parameters:

Yield Parameters:



427
# File 'lib/wx/doc/gen/event_list.rb', line 427

def evt_menu_highlight(id, meth = nil, &block) end

#evt_menu_highlight_all(meth = nil) {|event| ... } ⇒ Object

A menu item has been highlighted, i.e. the currently selected menu item has changed. This type of event is sent as MenuEvent. Processes a Wx::EVT_MENU_HIGHLIGHT_ALL event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



433
# File 'lib/wx/doc/gen/event_list.rb', line 433

def evt_menu_highlight_all(meth = nil, &block) end

#evt_menu_open(meth = nil) {|event| ... } ⇒ Object

A menu is about to be opened. On Windows, this is only sent once for each navigation of the menubar (up until all menus have closed). This type of event is sent as MenuEvent. Processes a Wx::EVT_MENU_OPEN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



414
# File 'lib/wx/doc/gen/event_list.rb', line 414

def evt_menu_open(meth = nil, &block) end

#evt_menu_range(id1, id2, meth = nil) {|event| ... } ⇒ Object

The same as EVT_TOOL_RANGE(). Processes a Wx::EVT_MENU event.

Parameters:

Yield Parameters:



1208
# File 'lib/wx/doc/gen/event_list.rb', line 1208

def evt_menu_range(id1,  id2, meth = nil, &block) end

#evt_middle_dclick(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MIDDLE_DCLICK event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



201
# File 'lib/wx/doc/gen/event_list.rb', line 201

def evt_middle_dclick(meth = nil, &block) end

#evt_middle_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MIDDLE_DOWN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



191
# File 'lib/wx/doc/gen/event_list.rb', line 191

def evt_middle_down(meth = nil, &block) end

#evt_middle_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MIDDLE_UP event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



196
# File 'lib/wx/doc/gen/event_list.rb', line 196

def evt_middle_up(meth = nil, &block) end

#evt_motion(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MOTION event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



251
# File 'lib/wx/doc/gen/event_list.rb', line 251

def evt_motion(meth = nil, &block) end

#evt_mouse_aux1_dclick(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_AUX1_DCLICK event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



231
# File 'lib/wx/doc/gen/event_list.rb', line 231

def evt_mouse_aux1_dclick(meth = nil, &block) end

#evt_mouse_aux1_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_AUX1_DOWN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



221
# File 'lib/wx/doc/gen/event_list.rb', line 221

def evt_mouse_aux1_down(meth = nil, &block) end

#evt_mouse_aux1_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_AUX1_UP event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



226
# File 'lib/wx/doc/gen/event_list.rb', line 226

def evt_mouse_aux1_up(meth = nil, &block) end

#evt_mouse_aux2_dclick(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_AUX2_DCLICK event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



246
# File 'lib/wx/doc/gen/event_list.rb', line 246

def evt_mouse_aux2_dclick(meth = nil, &block) end

#evt_mouse_aux2_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_AUX2_DOWN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



236
# File 'lib/wx/doc/gen/event_list.rb', line 236

def evt_mouse_aux2_down(meth = nil, &block) end

#evt_mouse_aux2_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_AUX2_UP event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



241
# File 'lib/wx/doc/gen/event_list.rb', line 241

def evt_mouse_aux2_up(meth = nil, &block) end

#evt_mouse_capture_changed(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MOUSE_CAPTURE_CHANGED event. See MouseCaptureChangedEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



522
# File 'lib/wx/doc/gen/event_list.rb', line 522

def evt_mouse_capture_changed(meth = nil, &block) end

#evt_mouse_capture_lost(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MOUSE_CAPTURE_LOST event. See MouseCaptureLostEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



527
# File 'lib/wx/doc/gen/event_list.rb', line 527

def evt_mouse_capture_lost(meth = nil, &block) end

#evt_mouse_events(meth = nil) {|event| ... } ⇒ Object

Process all mouse events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



104
# File 'lib/wx/doc/evthandler.rb', line 104

def evt_mouse_events(*args, &block) end

#evt_mousewheel(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MOUSEWHEEL event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



266
# File 'lib/wx/doc/gen/event_list.rb', line 266

def evt_mousewheel(meth = nil, &block) end

#evt_move(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MOVE event, which is generated when a window is moved. See MoveEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



353
# File 'lib/wx/doc/gen/event_list.rb', line 353

def evt_move(meth = nil, &block) end

#evt_move_end(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MOVE_END event, which is generated when the user stops moving or sizing a window. WXMSW only. See MoveEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



368
# File 'lib/wx/doc/gen/event_list.rb', line 368

def evt_move_end(meth = nil, &block) end

#evt_move_start(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MOVE_START event, which is generated when the user starts to move or size a window. WXMSW only. See MoveEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



358
# File 'lib/wx/doc/gen/event_list.rb', line 358

def evt_move_start(meth = nil, &block) end

#evt_moving(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_MOVING event, which is generated while the user is moving the window. WXMSW only.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



363
# File 'lib/wx/doc/gen/event_list.rb', line 363

def evt_moving(meth = nil, &block) end

#evt_navigation_key(meth = nil) {|event| ... } ⇒ Object

Process a navigation key event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



542
# File 'lib/wx/doc/gen/event_list.rb', line 542

def evt_navigation_key(meth = nil, &block) end

#evt_notebook_page_changed(id, meth = nil) {|event| ... } ⇒ Object

The page selection was changed. Processes a Wx::EVT_NOTEBOOK_PAGE_CHANGED event.

Parameters:

Yield Parameters:



1363
# File 'lib/wx/doc/gen/event_list.rb', line 1363

def evt_notebook_page_changed(id, meth = nil, &block) end

#evt_notebook_page_changing(id, meth = nil) {|event| ... } ⇒ Object

The page selection is about to be changed. Processes a Wx::EVT_NOTEBOOK_PAGE_CHANGING event. This event can be vetoed.

Parameters:

Yield Parameters:



1369
# File 'lib/wx/doc/gen/event_list.rb', line 1369

def evt_notebook_page_changing(id, meth = nil, &block) end

#evt_paint(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_PAINT event. See PaintEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



373
# File 'lib/wx/doc/gen/event_list.rb', line 373

def evt_paint(meth = nil, &block) end

#evt_pg_changed(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_CHANGED event, generated when property value has been changed by the user. Processes a PG::EVT_PG_CHANGED event.

Parameters:

Yield Parameters:



24
# File 'lib/wx/doc/gen/pg/event_list.rb', line 24

def evt_pg_changed(id, meth = nil, &block) end

#evt_pg_changing(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_CHANGING event, generated when property value is about to be changed by user. Use PG::PropertyGridEvent#get_value to take a peek at the pending value, and PG::PropertyGridEvent#veto to prevent change from taking place, if necessary. Processes a PG::EVT_PG_CHANGING event.

Parameters:

Yield Parameters:



31
# File 'lib/wx/doc/gen/pg/event_list.rb', line 31

def evt_pg_changing(id, meth = nil, &block) end

#evt_pg_col_begin_drag(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_COL_BEGIN_DRAG event, generated when user starts resizing a column - can be vetoed. Processes a PG::EVT_PG_COL_BEGIN_DRAG event.

Parameters:

Yield Parameters:



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

def evt_pg_col_begin_drag(id, meth = nil, &block) end

#evt_pg_col_dragging(id, meth = nil) {|event| ... } ⇒ Object

Processes a PG::EVT_PG_COL_DRAGGING event.

Parameters:

Yield Parameters:



93
# File 'lib/wx/doc/gen/pg/event_list.rb', line 93

def evt_pg_col_dragging(id, meth = nil, &block) end

#evt_pg_col_end_drag(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_COL_END_DRAG event, generated after column resize by user has finished. Processes a PG::EVT_PG_COL_END_DRAG event.

Parameters:

Yield Parameters:



100
# File 'lib/wx/doc/gen/pg/event_list.rb', line 100

def evt_pg_col_end_drag(id, meth = nil, &block) end

#evt_pg_double_click(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_DOUBLE_CLICK event, which occurs when property is double-clicked on with left mouse button. Processes a PG::EVT_PG_DOUBLE_CLICK event.

Parameters:

Yield Parameters:



52
# File 'lib/wx/doc/gen/pg/event_list.rb', line 52

def evt_pg_double_click(id, meth = nil, &block) end

#evt_pg_highlighted(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_HIGHLIGHTED event, which occurs when mouse moves over a property. Event’s property is NULL if hovered area does not belong to any property. Processes a PG::EVT_PG_HIGHLIGHTED event.

Parameters:

Yield Parameters:



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

def evt_pg_highlighted(id, meth = nil, &block) end

#evt_pg_item_collapsed(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_ITEM_COLLAPSED event, generated when user collapses a property or category. Processes a PG::EVT_PG_ITEM_COLLAPSED event.

Parameters:

Yield Parameters:



59
# File 'lib/wx/doc/gen/pg/event_list.rb', line 59

def evt_pg_item_collapsed(id, meth = nil, &block) end

#evt_pg_item_expanded(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_ITEM_EXPANDED event, generated when user expands a property or category. Processes a PG::EVT_PG_ITEM_EXPANDED event.

Parameters:

Yield Parameters:



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

def evt_pg_item_expanded(id, meth = nil, &block) end

#evt_pg_label_edit_begin(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_LABEL_EDIT_BEGIN event, generated when user is about to begin editing a property label. You can veto this event to prevent the action. Processes a PG::EVT_PG_LABEL_EDIT_BEGIN event.

Parameters:

Yield Parameters:



73
# File 'lib/wx/doc/gen/pg/event_list.rb', line 73

def evt_pg_label_edit_begin(id, meth = nil, &block) end

#evt_pg_label_edit_ending(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_LABEL_EDIT_ENDING event, generated when user is about to end editing of a property label. You can veto this event to prevent the action. Processes a PG::EVT_PG_LABEL_EDIT_ENDING event.

Parameters:

Yield Parameters:



80
# File 'lib/wx/doc/gen/pg/event_list.rb', line 80

def evt_pg_label_edit_ending(id, meth = nil, &block) end

#evt_pg_page_changed(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_PAGE_CHANGED event, generated when selected property page has been changed by the user. Processes a PG::EVT_PG_PAGE_CHANGED event.

Parameters:

Yield Parameters:



19
# File 'lib/wx/doc/pg/events.rb', line 19

def evt_pg_page_changed(id, meth = nil, &block) end

#evt_pg_right_click(id, meth = nil) {|event| ... } ⇒ Object

Respond to PG::EVT_PG_RIGHT_CLICK event, which occurs when property is clicked on with right mouse button. Processes a PG::EVT_PG_RIGHT_CLICK event.

Parameters:

Yield Parameters:



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

def evt_pg_right_click(id, meth = nil, &block) end

#evt_pg_selected(id, meth = nil) {|event| ... } ⇒ Object

Processes a PG::EVT_PG_SELECTED event.

Parameters:

Yield Parameters:



17
# File 'lib/wx/doc/gen/pg/event_list.rb', line 17

def evt_pg_selected(id, meth = nil, &block) end

#evt_press_and_tap(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_PRESS_AND_TAP. Processes a Wx::EVT_PRESS_AND_TAP event.

Parameters:

Yield Parameters:



323
# File 'lib/wx/doc/gen/event_list.rb', line 323

def evt_press_and_tap(id, meth = nil, &block) end

#evt_query_end_session(meth = nil) {|event| ... } ⇒ Object

Process a query end session event, supplying the member function. See CloseEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



444
# File 'lib/wx/doc/gen/event_list.rb', line 444

def evt_query_end_session(meth = nil, &block) end

#evt_query_layout_info(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_QUERY_LAYOUT_INFO event, to get size, orientation and alignment from a window.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1054
# File 'lib/wx/doc/gen/event_list.rb', line 1054

def evt_query_layout_info(meth = nil, &block) end

#evt_radiobox(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_RADIOBOX event, when a radiobutton is clicked.

Parameters:

Yield Parameters:



1214
# File 'lib/wx/doc/gen/event_list.rb', line 1214

def evt_radiobox(id, meth = nil, &block) end

#evt_radiobutton(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_RADIOBUTTON event, when the radiobutton is clicked.

Parameters:

Yield Parameters:



1220
# File 'lib/wx/doc/gen/event_list.rb', line 1220

def evt_radiobutton(id, meth = nil, &block) end

#evt_ribbonbar_help_click(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the help button is clicked. This even is new since wxWidgets 2.9.5. Processes a RBN::EVT_RIBBONBAR_HELP_CLICK event.

Parameters:

Yield Parameters:



74
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 74

def evt_ribbonbar_help_click(id, meth = nil, &block) end

#evt_ribbonbar_page_changed(id, meth = nil) {|event| ... } ⇒ Object

Triggered after the transition from one page being active to a different page being active. Processes a RBN::EVT_RIBBONBAR_PAGE_CHANGED event.

Parameters:

Yield Parameters:



18
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 18

def evt_ribbonbar_page_changed(id, meth = nil, &block) end

#evt_ribbonbar_page_changing(id, meth = nil) {|event| ... } ⇒ Object

Triggered prior to the transition from one page being active to a different page being active, and can veto the change. Processes a RBN::EVT_RIBBONBAR_PAGE_CHANGING event.

Parameters:

Yield Parameters:



25
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 25

def evt_ribbonbar_page_changing(id, meth = nil, &block) end

#evt_ribbonbar_tab_left_dclick(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the left mouse button is double clicked on a tab. Processes a RBN::EVT_RIBBONBAR_TAB_LEFT_DCLICK event.

Parameters:

Yield Parameters:



60
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 60

def evt_ribbonbar_tab_left_dclick(id, meth = nil, &block) end

#evt_ribbonbar_tab_middle_down(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the middle mouse button is pressed on a tab. Processes a RBN::EVT_RIBBONBAR_TAB_MIDDLE_DOWN event.

Parameters:

Yield Parameters:



32
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 32

def evt_ribbonbar_tab_middle_down(id, meth = nil, &block) end

#evt_ribbonbar_tab_middle_up(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the middle mouse button is released on a tab. Processes a RBN::EVT_RIBBONBAR_TAB_MIDDLE_UP event.

Parameters:

Yield Parameters:



39
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 39

def evt_ribbonbar_tab_middle_up(id, meth = nil, &block) end

#evt_ribbonbar_tab_right_down(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the right mouse button is pressed on a tab. Processes a RBN::EVT_RIBBONBAR_TAB_RIGHT_DOWN event.

Parameters:

Yield Parameters:



46
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 46

def evt_ribbonbar_tab_right_down(id, meth = nil, &block) end

#evt_ribbonbar_tab_right_up(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the right mouse button is released on a tab. Processes a RBN::EVT_RIBBONBAR_TAB_RIGHT_UP event.

Parameters:

Yield Parameters:



53
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 53

def evt_ribbonbar_tab_right_up(id, meth = nil, &block) end

#evt_ribbonbar_toggled(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the button triggering the ribbon bar is clicked. This event is new since wxWidgets 2.9.5. Processes a RBN::EVT_RIBBONBAR_TOGGLED event.

Parameters:

Yield Parameters:



67
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 67

def evt_ribbonbar_toggled(id, meth = nil, &block) end

#evt_ribbonbuttonbar_clicked(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the normal (non-dropdown) region of a button on the button bar is clicked. Processes a RBN::EVT_RIBBONBUTTONBAR_CLICKED event.

Parameters:

Yield Parameters:



123
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 123

def evt_ribbonbuttonbar_clicked(id, meth = nil, &block) end

#evt_ribbonbuttonbar_dropdown_clicked(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the dropdown region of a button on the button bar is clicked. RBN::RibbonButtonBarEvent#popup_menu should be called by the event handler if it wants to display a popup menu (which is what most dropdown buttons should be doing). Processes a RBN::EVT_RIBBONBUTTONBAR_DROPDOWN_CLICKED event.

Parameters:

Yield Parameters:



130
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 130

def evt_ribbonbuttonbar_dropdown_clicked(id, meth = nil, &block) end

#evt_ribbongallery_clicked(id, meth = nil) {|event| ... } ⇒ Object

Similar to EVT_RIBBONGALLERY_SELECTED but triggered every time a gallery item is clicked, even if it is already selected. Note that the ID of the event is that of the gallery, not of the item, just as above. This event is available since wxWidgets 2.9.2. Processes a RBN::EVT_RIBBONGALLERY_CLICKED event.

Parameters:

Yield Parameters:



88
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 88

def evt_ribbongallery_clicked(id, meth = nil, &block) end

#evt_ribbongallery_hover_changed(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the item being hovered over by the user changes. The item in the event will be the new item being hovered, or NULL if there is no longer an item being hovered. Note that the ID is that of the gallery, not of the item. Processes a RBN::EVT_RIBBONGALLERY_HOVER_CHANGED event.

Parameters:

Yield Parameters:



95
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 95

def evt_ribbongallery_hover_changed(id, meth = nil, &block) end

#evt_ribbongallery_selected(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the user selects an item from the gallery. Note that the ID is that of the gallery, not of the item. Processes a RBN::EVT_RIBBONGALLERY_SELECTED event.

Parameters:

Yield Parameters:



81
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 81

def evt_ribbongallery_selected(id, meth = nil, &block) end

#evt_ribbonpanel_extbutton_activated(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the user activate the panel extension button. Processes a RBN::EVT_RIBBONPANEL_EXTBUTTON_ACTIVATED event.

Parameters:

Yield Parameters:



102
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 102

def evt_ribbonpanel_extbutton_activated(id, meth = nil, &block) end

#evt_ribbontoolbar_clicked(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the normal (non-dropdown) region of a tool on the tool bar is clicked. Processes a RBN::EVT_RIBBONTOOLBAR_CLICKED event.

Parameters:

Yield Parameters:



109
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 109

def evt_ribbontoolbar_clicked(id, meth = nil, &block) end

#evt_ribbontoolbar_dropdown_clicked(id, meth = nil) {|event| ... } ⇒ Object

Triggered when the dropdown region of a tool on the tool bar is clicked. RBN::RibbonToolBarEvent#popup_menu should be called by the event handler if it wants to display a popup menu (which is what most dropdown tools should be doing). Processes a RBN::EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED event.

Parameters:

Yield Parameters:



116
# File 'lib/wx/doc/gen/rbn/event_list.rb', line 116

def evt_ribbontoolbar_dropdown_clicked(id, meth = nil, &block) end

#evt_richtext_buffer_reset(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_BUFFER_RESET event, generated when the buffer has been reset by deleting all content. You can use this to set a default style for the first new paragraph.

Parameters:

Yield Parameters:



107
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 107

def evt_richtext_buffer_reset(id, meth = nil, &block) end

#evt_richtext_character(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_CHARACTER event, generated when the user presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter.

Parameters:

Yield Parameters:



47
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 47

def evt_richtext_character(id, meth = nil, &block) end

#evt_richtext_consuming_character(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_CONSUMING_CHARACTER event, generated when the user presses a character key but before it is processed and inserted into the control. Call Veto to prevent normal processing. Valid event functions: GetFlags, GetPosition, GetCharacter, Veto.

Parameters:

Yield Parameters:



53
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 53

def evt_richtext_consuming_character(id, meth = nil, &block) end

#evt_richtext_content_deleted(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_CONTENT_DELETED event, generated when content has been deleted from the control. Valid event functions: GetPosition, GetRange.

Parameters:

Yield Parameters:



101
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 101

def evt_richtext_content_deleted(id, meth = nil, &block) end

#evt_richtext_content_inserted(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_CONTENT_INSERTED event, generated when content has been inserted into the control. Valid event functions: GetPosition, GetRange.

Parameters:

Yield Parameters:



95
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 95

def evt_richtext_content_inserted(id, meth = nil, &block) end

#evt_richtext_delete(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_DELETE event, generated when the user presses the backspace or delete key. Valid event functions: GetFlags, GetPosition.

Parameters:

Yield Parameters:



59
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 59

def evt_richtext_delete(id, meth = nil, &block) end

#evt_richtext_focus_object_changed(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_FOCUS_OBJECT_CHANGED event, generated when the current focus object has changed.

Parameters:

Yield Parameters:



119
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 119

def evt_richtext_focus_object_changed(id, meth = nil, &block) end

#evt_richtext_left_click(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_LEFT_CLICK event, generated when the user releases the left mouse button over an object.

Parameters:

Yield Parameters:



17
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 17

def evt_richtext_left_click(id, meth = nil, &block) end

#evt_richtext_left_dclick(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_LEFT_DCLICK event, generated when the user double-clicks an object.

Parameters:

Yield Parameters:



35
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 35

def evt_richtext_left_dclick(id, meth = nil, &block) end

#evt_richtext_middle_click(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_MIDDLE_CLICK event, generated when the user releases the middle mouse button over an object.

Parameters:

Yield Parameters:



29
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 29

def evt_richtext_middle_click(id, meth = nil, &block) end

#evt_richtext_properties_changed(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_PROPERTIES_CHANGED event, generated when properties have been applied to the control. Valid event functions: GetPosition, GetRange.

Parameters:

Yield Parameters:



89
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 89

def evt_richtext_properties_changed(id, meth = nil, &block) end

#evt_richtext_return(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_RETURN event, generated when the user presses the return key. Valid event functions: GetFlags, GetPosition.

Parameters:

Yield Parameters:



41
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 41

def evt_richtext_return(id, meth = nil, &block) end

#evt_richtext_right_click(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_RIGHT_CLICK event, generated when the user releases the right mouse button over an object.

Parameters:

Yield Parameters:



23
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 23

def evt_richtext_right_click(id, meth = nil, &block) end

#evt_richtext_selection_changed(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_SELECTION_CHANGED event, generated when the selection range has changed.

Parameters:

Yield Parameters:



113
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 113

def evt_richtext_selection_changed(id, meth = nil, &block) end

#evt_richtext_style_changed(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_STYLE_CHANGED event, generated when styling has been applied to the control. Valid event functions: GetPosition, GetRange.

Parameters:

Yield Parameters:



65
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 65

def evt_richtext_style_changed(id, meth = nil, &block) end

#evt_richtext_stylesheet_changed(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_STYLESHEET_CHANGING event, generated when the control’s stylesheet has changed, for example the user added, edited or deleted a style. Valid event functions: GetRange, GetPosition.

Parameters:

Yield Parameters:



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

def evt_richtext_stylesheet_changed(id, meth = nil, &block) end

#evt_richtext_stylesheet_replaced(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_STYLESHEET_REPLACED event, generated when the control’s stylesheet has been replaced, for example when a file is loaded into the control. Valid event functions: GetOldStyleSheet, GetNewStyleSheet.

Parameters:

Yield Parameters:



83
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 83

def evt_richtext_stylesheet_replaced(id, meth = nil, &block) end

#evt_richtext_stylesheet_replacing(id, meth = nil) {|event| ... } ⇒ Object

Process a RTC::EVT_RICHTEXT_STYLESHEET_REPLACING event, generated when the control’s stylesheet is about to be replaced, for example when a file is loaded into the control. Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet.

Parameters:

Yield Parameters:



77
# File 'lib/wx/doc/gen/rtc/event_list.rb', line 77

def evt_richtext_stylesheet_replacing(id, meth = nil, &block) end

#evt_right_dclick(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_RIGHT_DCLICK event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



216
# File 'lib/wx/doc/gen/event_list.rb', line 216

def evt_right_dclick(meth = nil, &block) end

#evt_right_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_RIGHT_DOWN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



206
# File 'lib/wx/doc/gen/event_list.rb', line 206

def evt_right_down(meth = nil, &block) end

#evt_right_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_RIGHT_UP event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



211
# File 'lib/wx/doc/gen/event_list.rb', line 211

def evt_right_up(meth = nil, &block) end

#evt_sash_dragged(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_SASH_DRAGGED event, when the user has finished dragging a sash.

Parameters:

Yield Parameters:



1042
# File 'lib/wx/doc/gen/event_list.rb', line 1042

def evt_sash_dragged(id, meth = nil, &block) end

#evt_sash_dragged_range(id1, id2, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_SASH_DRAGGED_RANGE event, when the user has finished dragging a sash. The event handler is called when windows with ids in the given range have their sashes dragged.

Parameters:

Yield Parameters:



1049
# File 'lib/wx/doc/gen/event_list.rb', line 1049

def evt_sash_dragged_range(id1,  id2, meth = nil, &block) end

#evt_scroll(meth = nil) {|event| ... } ⇒ Object

Process all scroll events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



116
# File 'lib/wx/doc/evthandler.rb', line 116

def evt_scroll(meth = nil, &block) end

#evt_scroll_bottom(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_BOTTOM scroll to bottom or rightmost (maximum) position events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



31
# File 'lib/wx/doc/gen/event_list.rb', line 31

def evt_scroll_bottom(meth = nil, &block) end

#evt_scroll_changed(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_CHANGED end of scrolling events (MSW only).

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



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

def evt_scroll_changed(meth = nil, &block) end

#evt_scroll_command(id, meth = nil) {|event| ... } ⇒ Object

Convenience evt handler to listen to all scroll events (from Wx::Slider and Wx::ScrollBar) with an id.

Parameters:

  • id (Integer)

    window identifier

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or event handling proc

Yield Parameters:



123
# File 'lib/wx/doc/evthandler.rb', line 123

def evt_scroll_command(id, meth = nil, &block) end

#evt_scroll_linedown(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_LINEDOWN line down or right events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



41
# File 'lib/wx/doc/gen/event_list.rb', line 41

def evt_scroll_linedown(meth = nil, &block) end

#evt_scroll_lineup(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_LINEUP line up or left events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



36
# File 'lib/wx/doc/gen/event_list.rb', line 36

def evt_scroll_lineup(meth = nil, &block) end

#evt_scroll_pagedown(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_PAGEDOWN page down or right events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



51
# File 'lib/wx/doc/gen/event_list.rb', line 51

def evt_scroll_pagedown(meth = nil, &block) end

#evt_scroll_pageup(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_PAGEUP page up or left events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



46
# File 'lib/wx/doc/gen/event_list.rb', line 46

def evt_scroll_pageup(meth = nil, &block) end

#evt_scroll_thumbrelease(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_THUMBRELEASE thumb release events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



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

def evt_scroll_thumbrelease(meth = nil, &block) end

#evt_scroll_thumbtrack(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the user drags the thumbtrack).

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



56
# File 'lib/wx/doc/gen/event_list.rb', line 56

def evt_scroll_thumbtrack(meth = nil, &block) end

#evt_scroll_top(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLL_TOP scroll to top or leftmost (minimum) position events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



26
# File 'lib/wx/doc/gen/event_list.rb', line 26

def evt_scroll_top(meth = nil, &block) end

#evt_scrollbar(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_SCROLLBAR command, which is generated by a ScrollBar control. This is provided for compatibility only; more specific scrollbar event macros should be used instead (see ScrollEvent).

Parameters:

Yield Parameters:



1226
# File 'lib/wx/doc/gen/event_list.rb', line 1226

def evt_scrollbar(id, meth = nil, &block) end

#evt_scrollwin(meth = nil) {|event| ... } ⇒ Object

Process all scroll events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



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

def evt_scrollwin(meth = nil, &block) end

#evt_scrollwin_bottom(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLLWIN_BOTTOM scroll-to-bottom events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



141
# File 'lib/wx/doc/gen/event_list.rb', line 141

def evt_scrollwin_bottom(meth = nil, &block) end

#evt_scrollwin_linedown(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLLWIN_LINEDOWN line down events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



151
# File 'lib/wx/doc/gen/event_list.rb', line 151

def evt_scrollwin_linedown(meth = nil, &block) end

#evt_scrollwin_lineup(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLLWIN_LINEUP line up events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



146
# File 'lib/wx/doc/gen/event_list.rb', line 146

def evt_scrollwin_lineup(meth = nil, &block) end

#evt_scrollwin_pagedown(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLLWIN_PAGEDOWN page down events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



161
# File 'lib/wx/doc/gen/event_list.rb', line 161

def evt_scrollwin_pagedown(meth = nil, &block) end

#evt_scrollwin_pageup(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLLWIN_PAGEUP page up events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



156
# File 'lib/wx/doc/gen/event_list.rb', line 156

def evt_scrollwin_pageup(meth = nil, &block) end

#evt_scrollwin_thumbrelease(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLLWIN_THUMBRELEASE thumb release events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



171
# File 'lib/wx/doc/gen/event_list.rb', line 171

def evt_scrollwin_thumbrelease(meth = nil, &block) end

#evt_scrollwin_thumbtrack(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLLWIN_THUMBTRACK thumbtrack events (frequent events sent as the user drags the thumbtrack).

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



166
# File 'lib/wx/doc/gen/event_list.rb', line 166

def evt_scrollwin_thumbtrack(meth = nil, &block) end

#evt_scrollwin_top(meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SCROLLWIN_TOP scroll-to-top events.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



136
# File 'lib/wx/doc/gen/event_list.rb', line 136

def evt_scrollwin_top(meth = nil, &block) end

#evt_search(id, meth = nil) {|event| ... } ⇒ Object

Respond to a Wx::EVT_SEARCH event, generated when the search button is clicked. Note that this does not initiate a search on its own, you need to perform the appropriate action in your event handler. You may use Processes a Wx::EVT_SEARCH event.

Parameters:

Yield Parameters:



1376
# File 'lib/wx/doc/gen/event_list.rb', line 1376

def evt_search(id, meth = nil, &block) end

#evt_search_cancel(id, meth = nil) {|event| ... } ⇒ Object

Respond to a Wx::EVT_SEARCH_CANCEL event, generated when the cancel button is clicked. Processes a Wx::EVT_SEARCH_CANCEL event.

Parameters:

Yield Parameters:



1383
# File 'lib/wx/doc/gen/event_list.rb', line 1383

def evt_search_cancel(id, meth = nil, &block) end

#evt_set_cursor(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_SET_CURSOR event. See SetCursorEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



281
# File 'lib/wx/doc/gen/event_list.rb', line 281

def evt_set_cursor(meth = nil, &block) end

#evt_set_focus(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_SET_FOCUS event. See FocusEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



383
# File 'lib/wx/doc/gen/event_list.rb', line 383

def evt_set_focus(meth = nil, &block) end

#evt_show(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_SHOW event. See ShowEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



454
# File 'lib/wx/doc/gen/event_list.rb', line 454

def evt_show(meth = nil, &block) end

#evt_size(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_SIZE event. See SizeEvent.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



348
# File 'lib/wx/doc/gen/event_list.rb', line 348

def evt_size(meth = nil, &block) end

#evt_slider(id, meth = nil) {|event| ... } ⇒ Object

Process Wx::EVT_SLIDER which is generated after any change of Slider position in addition to one of the events above. Notice that the handler of this event receives a CommandEvent as argument and not ScrollEvent, as all the other handlers.

Parameters:

Yield Parameters:



1232
# File 'lib/wx/doc/gen/event_list.rb', line 1232

def evt_slider(id, meth = nil, &block) end

#evt_spin(id, meth = nil) {|event| ... } ⇒ Object

Generated whenever an arrow is pressed. Processes a Wx::EVT_SPIN event.

Parameters:

Yield Parameters:



606
# File 'lib/wx/doc/gen/event_list.rb', line 606

def evt_spin(id, meth = nil, &block) end

#evt_spin_down(id, meth = nil) {|event| ... } ⇒ Object

Generated when right/down arrow is pressed. Processes a Wx::EVT_SPIN_DOWN event.

Parameters:

Yield Parameters:



620
# File 'lib/wx/doc/gen/event_list.rb', line 620

def evt_spin_down(id, meth = nil, &block) end

#evt_spin_up(id, meth = nil) {|event| ... } ⇒ Object

Generated when left/up arrow is pressed. Processes a Wx::EVT_SPIN_UP event.

Parameters:

Yield Parameters:



613
# File 'lib/wx/doc/gen/event_list.rb', line 613

def evt_spin_up(id, meth = nil, &block) end

#evt_spinctrl(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_SPINCTRL event, which is generated whenever the numeric value of the spin control is updated.

Parameters:

Yield Parameters:



1389
# File 'lib/wx/doc/gen/event_list.rb', line 1389

def evt_spinctrl(id, meth = nil, &block) end

#evt_spinctrldouble(id, meth = nil) {|event| ... } ⇒ Object

Generated whenever the numeric value of the spin control is changed, that is, when the up/down spin button is clicked or when the control loses focus and the new value is different from the last one. See SpinDoubleEvent. Processes a Wx::EVT_SPINCTRLDOUBLE event.

Parameters:

Yield Parameters:



627
# File 'lib/wx/doc/gen/event_list.rb', line 627

def evt_spinctrldouble(id, meth = nil, &block) end

#evt_splitter_dclick(id, meth = nil) {|event| ... } ⇒ Object

The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). Processes a Wx::EVT_SPLITTER_DOUBLECLICKED event.

Parameters:

Yield Parameters:



910
# File 'lib/wx/doc/gen/event_list.rb', line 910

def evt_splitter_dclick(id, meth = nil, &block) end

#evt_splitter_sash_pos_changed(id, meth = nil) {|event| ... } ⇒ Object

The sash position was changed. May be used to modify the sash position before it is set, or to prevent the change from taking place. Processes a Wx::EVT_SPLITTER_SASH_POS_CHANGED event.

Parameters:

Yield Parameters:



898
# File 'lib/wx/doc/gen/event_list.rb', line 898

def evt_splitter_sash_pos_changed(id, meth = nil, &block) end

#evt_splitter_sash_pos_changing(id, meth = nil) {|event| ... } ⇒ Object

The sash position is in the process of being changed. May be used to modify the position of the tracking bar to properly reflect the position that would be set if the drag were to be completed at this point. Processes a Wx::EVT_SPLITTER_SASH_POS_CHANGING event.

Parameters:

Yield Parameters:



892
# File 'lib/wx/doc/gen/event_list.rb', line 892

def evt_splitter_sash_pos_changing(id, meth = nil, &block) end

#evt_splitter_sash_pos_resize(id, meth = nil) {|event| ... } ⇒ Object

The sash position is in the process of being updated. May be used to modify the position of the tracking bar to properly reflect the position that would be set if the update were to be completed. This can happen e.g. when the window is resized and the sash is moved according to the gravity setting. This event is sent when the window is resized and allows the application to select the desired new sash position. If it doesn’t process the event, the position is determined by the gravity setting. Processes a Wx::EVT_SPLITTER_SASH_POS_RESIZE event and is only available in wxWidgets 3.1.6 or newer.

Parameters:

Yield Parameters:



1552
# File 'lib/wx/doc/gen/event_list.rb', line 1552

def evt_splitter_sash_pos_resize(id, meth = nil, &block) end

#evt_splitter_unsplit(id, meth = nil) {|event| ... } ⇒ Object

The splitter has been just unsplit. Processes a Wx::EVT_SPLITTER_UNSPLIT event.

Parameters:

Yield Parameters:



904
# File 'lib/wx/doc/gen/event_list.rb', line 904

def evt_splitter_unsplit(id, meth = nil, &block) end

#evt_stc_autocomp_cancelled(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



17
# File 'lib/wx/doc/gen/stc/event_list.rb', line 17

def evt_stc_autocomp_cancelled(id, meth = nil, &block) end

#evt_stc_autocomp_char_deleted(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



23
# File 'lib/wx/doc/gen/stc/event_list.rb', line 23

def evt_stc_autocomp_char_deleted(id, meth = nil, &block) end

#evt_stc_autocomp_completed(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



29
# File 'lib/wx/doc/gen/stc/event_list.rb', line 29

def evt_stc_autocomp_completed(id, meth = nil, &block) end

#evt_stc_autocomp_selection(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



35
# File 'lib/wx/doc/gen/stc/event_list.rb', line 35

def evt_stc_autocomp_selection(id, meth = nil, &block) end

#evt_stc_autocomp_selection_change(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



41
# File 'lib/wx/doc/gen/stc/event_list.rb', line 41

def evt_stc_autocomp_selection_change(id, meth = nil, &block) end

#evt_stc_calltip_click(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_CALLTIP_CLICK event.

Parameters:

Yield Parameters:



47
# File 'lib/wx/doc/gen/stc/event_list.rb', line 47

def evt_stc_calltip_click(id, meth = nil, &block) end

#evt_stc_change(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_CHANGE event.

Parameters:

Yield Parameters:



53
# File 'lib/wx/doc/gen/stc/event_list.rb', line 53

def evt_stc_change(id, meth = nil, &block) end

#evt_stc_charadded(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_CHARADDED event.

Parameters:

Yield Parameters:



59
# File 'lib/wx/doc/gen/stc/event_list.rb', line 59

def evt_stc_charadded(id, meth = nil, &block) end

#evt_stc_clipboard_copy(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_CLIPBOARD_COPY event.

Parameters:

Yield Parameters:



65
# File 'lib/wx/doc/gen/stc/event_list.rb', line 65

def evt_stc_clipboard_copy(id, meth = nil, &block) end

#evt_stc_clipboard_paste(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_CLIPBOARD_PASTE event.

Parameters:

Yield Parameters:



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

def evt_stc_clipboard_paste(id, meth = nil, &block) end

#evt_stc_do_drop(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_DO_DROP event.

Parameters:

Yield Parameters:



77
# File 'lib/wx/doc/gen/stc/event_list.rb', line 77

def evt_stc_do_drop(id, meth = nil, &block) end

#evt_stc_doubleclick(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_DOUBLECLICK event.

Parameters:

Yield Parameters:



83
# File 'lib/wx/doc/gen/stc/event_list.rb', line 83

def evt_stc_doubleclick(id, meth = nil, &block) end

#evt_stc_drag_over(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_DRAG_OVER event.

Parameters:

Yield Parameters:



89
# File 'lib/wx/doc/gen/stc/event_list.rb', line 89

def evt_stc_drag_over(id, meth = nil, &block) end

#evt_stc_dwellend(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_DWELLEND event.

Parameters:

Yield Parameters:



95
# File 'lib/wx/doc/gen/stc/event_list.rb', line 95

def evt_stc_dwellend(id, meth = nil, &block) end

#evt_stc_dwellstart(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_DWELLSTART event.

Parameters:

Yield Parameters:



101
# File 'lib/wx/doc/gen/stc/event_list.rb', line 101

def evt_stc_dwellstart(id, meth = nil, &block) end

#evt_stc_hotspot_click(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_HOTSPOT_CLICK event.

Parameters:

Yield Parameters:



107
# File 'lib/wx/doc/gen/stc/event_list.rb', line 107

def evt_stc_hotspot_click(id, meth = nil, &block) end

#evt_stc_hotspot_dclick(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_HOTSPOT_DCLICK event.

Parameters:

Yield Parameters:



113
# File 'lib/wx/doc/gen/stc/event_list.rb', line 113

def evt_stc_hotspot_dclick(id, meth = nil, &block) end

#evt_stc_hotspot_release_click(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



119
# File 'lib/wx/doc/gen/stc/event_list.rb', line 119

def evt_stc_hotspot_release_click(id, meth = nil, &block) end

#evt_stc_indicator_click(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_INDICATOR_CLICK event.

Parameters:

Yield Parameters:



125
# File 'lib/wx/doc/gen/stc/event_list.rb', line 125

def evt_stc_indicator_click(id, meth = nil, &block) end

#evt_stc_indicator_release(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



131
# File 'lib/wx/doc/gen/stc/event_list.rb', line 131

def evt_stc_indicator_release(id, meth = nil, &block) end

#evt_stc_macrorecord(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_MACRORECORD event.

Parameters:

Yield Parameters:



137
# File 'lib/wx/doc/gen/stc/event_list.rb', line 137

def evt_stc_macrorecord(id, meth = nil, &block) end

#evt_stc_margin_right_click(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



143
# File 'lib/wx/doc/gen/stc/event_list.rb', line 143

def evt_stc_margin_right_click(id, meth = nil, &block) end

#evt_stc_marginclick(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_MARGINCLICK event.

Parameters:

Yield Parameters:



149
# File 'lib/wx/doc/gen/stc/event_list.rb', line 149

def evt_stc_marginclick(id, meth = nil, &block) end

#evt_stc_modified(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_MODIFIED event.

Parameters:

Yield Parameters:



155
# File 'lib/wx/doc/gen/stc/event_list.rb', line 155

def evt_stc_modified(id, meth = nil, &block) end

#evt_stc_needshown(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_NEEDSHOWN event.

Parameters:

Yield Parameters:



161
# File 'lib/wx/doc/gen/stc/event_list.rb', line 161

def evt_stc_needshown(id, meth = nil, &block) end

#evt_stc_painted(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_PAINTED event.

Parameters:

Yield Parameters:



167
# File 'lib/wx/doc/gen/stc/event_list.rb', line 167

def evt_stc_painted(id, meth = nil, &block) end

#evt_stc_romodifyattempt(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_ROMODIFYATTEMPT event.

Parameters:

Yield Parameters:



173
# File 'lib/wx/doc/gen/stc/event_list.rb', line 173

def evt_stc_romodifyattempt(id, meth = nil, &block) end

#evt_stc_savepointleft(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_SAVEPOINTLEFT event.

Parameters:

Yield Parameters:



179
# File 'lib/wx/doc/gen/stc/event_list.rb', line 179

def evt_stc_savepointleft(id, meth = nil, &block) end

#evt_stc_savepointreached(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



185
# File 'lib/wx/doc/gen/stc/event_list.rb', line 185

def evt_stc_savepointreached(id, meth = nil, &block) end

#evt_stc_start_drag(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_START_DRAG event.

Parameters:

Yield Parameters:



191
# File 'lib/wx/doc/gen/stc/event_list.rb', line 191

def evt_stc_start_drag(id, meth = nil, &block) end

#evt_stc_styleneeded(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_STYLENEEDED event.

Parameters:

Yield Parameters:



197
# File 'lib/wx/doc/gen/stc/event_list.rb', line 197

def evt_stc_styleneeded(id, meth = nil, &block) end

#evt_stc_updateui(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_UPDATEUI event.

Parameters:

Yield Parameters:



203
# File 'lib/wx/doc/gen/stc/event_list.rb', line 203

def evt_stc_updateui(id, meth = nil, &block) end

#evt_stc_userlistselection(id, meth = nil) {|event| ... } ⇒ Object

Parameters:

Yield Parameters:



209
# File 'lib/wx/doc/gen/stc/event_list.rb', line 209

def evt_stc_userlistselection(id, meth = nil, &block) end

#evt_stc_zoom(id, meth = nil) {|event| ... } ⇒ Object

Process a STC::EVT_STC_ZOOM event.

Parameters:

Yield Parameters:



215
# File 'lib/wx/doc/gen/stc/event_list.rb', line 215

def evt_stc_zoom(id, meth = nil, &block) end

#evt_sys_colour_changed(meth = nil) {|event| ... } ⇒ Object

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



517
# File 'lib/wx/doc/gen/event_list.rb', line 517

def evt_sys_colour_changed(meth = nil, &block) end

#evt_taskbar_click(meth = nil) {|event| ... } ⇒ Object

This is a synonym for either EVT_TASKBAR_RIGHT_DOWN or UP depending on the platform, use this event macro to catch the event which should result in the menu being displayed on the current platform. Processes a Wx::EVT_TASKBAR_CLICK event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1640
# File 'lib/wx/doc/gen/event_list.rb', line 1640

def evt_taskbar_click(meth = nil, &block) end

#evt_taskbar_left_dclick(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TASKBAR_LEFT_DCLICK event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1629
# File 'lib/wx/doc/gen/event_list.rb', line 1629

def evt_taskbar_left_dclick(meth = nil, &block) end

#evt_taskbar_left_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TASKBAR_LEFT_DOWN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1609
# File 'lib/wx/doc/gen/event_list.rb', line 1609

def evt_taskbar_left_down(meth = nil, &block) end

#evt_taskbar_left_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TASKBAR_LEFT_UP event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1614
# File 'lib/wx/doc/gen/event_list.rb', line 1614

def evt_taskbar_left_up(meth = nil, &block) end

#evt_taskbar_move(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TASKBAR_MOVE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1604
# File 'lib/wx/doc/gen/event_list.rb', line 1604

def evt_taskbar_move(meth = nil, &block) end

#evt_taskbar_right_dclick(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TASKBAR_RIGHT_DCLICK event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1634
# File 'lib/wx/doc/gen/event_list.rb', line 1634

def evt_taskbar_right_dclick(meth = nil, &block) end

#evt_taskbar_right_down(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TASKBAR_RIGHT_DOWN event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1619
# File 'lib/wx/doc/gen/event_list.rb', line 1619

def evt_taskbar_right_down(meth = nil, &block) end

#evt_taskbar_right_up(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TASKBAR_RIGHT_UP event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



1624
# File 'lib/wx/doc/gen/event_list.rb', line 1624

def evt_taskbar_right_up(meth = nil, &block) end

#evt_text(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TEXT event, when the text changes.

Parameters:

Yield Parameters:



1238
# File 'lib/wx/doc/gen/event_list.rb', line 1238

def evt_text(id, meth = nil, &block) end

#evt_text_copy(id, meth = nil) {|event| ... } ⇒ Object

Some or all of the controls content was copied to the clipboard. Processes a Wx::EVT_TEXT_COPY event.

Parameters:

Yield Parameters:



567
# File 'lib/wx/doc/gen/event_list.rb', line 567

def evt_text_copy(id, meth = nil, &block) end

#evt_text_cut(id, meth = nil) {|event| ... } ⇒ Object

Some or all of the controls content was cut (i.e. copied and deleted). Processes a Wx::EVT_TEXT_CUT event.

Parameters:

Yield Parameters:



574
# File 'lib/wx/doc/gen/event_list.rb', line 574

def evt_text_cut(id, meth = nil, &block) end

#evt_text_enter(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TEXT_ENTER event, when RETURN is pressed in the combo control.

Parameters:

Yield Parameters:



1244
# File 'lib/wx/doc/gen/event_list.rb', line 1244

def evt_text_enter(id, meth = nil, &block) end

#evt_text_maxlen(id, meth = nil) {|event| ... } ⇒ Object

This event is generated when the user tries to enter more text into the control than the limit set by TextCtrl#set_max_length, see its description. Processes a Wx::EVT_TEXT_MAXLEN event.

Parameters:

Yield Parameters:



1251
# File 'lib/wx/doc/gen/event_list.rb', line 1251

def evt_text_maxlen(id, meth = nil, &block) end

#evt_text_paste(id, meth = nil) {|event| ... } ⇒ Object

Clipboard content was pasted into the control. Processes a Wx::EVT_TEXT_PASTE event.

Parameters:

Yield Parameters:



581
# File 'lib/wx/doc/gen/event_list.rb', line 581

def evt_text_paste(id, meth = nil, &block) end

#evt_text_url(id, meth = nil) {|event| ... } ⇒ Object

A mouse event occurred over an URL in the text control. Processes a Wx::EVT_TEXT_URL event.

Parameters:

Yield Parameters:



1345
# File 'lib/wx/doc/gen/event_list.rb', line 1345

def evt_text_url(id, meth = nil, &block) end

#evt_time_changed(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TIME_CHANGED event, which fires when the user changes the current selection in the control.

Parameters:

Yield Parameters:



1599
# File 'lib/wx/doc/gen/event_list.rb', line 1599

def evt_time_changed(id, meth = nil, &block) end

#evt_timer(id, meth = nil) {|event| ... } ⇒ Object

Processes Wx::EVT_TIMER events. See TimerEvent.

Parameters:

  • id (Integer, Wx::Enum, Wx::Timer)

    timer id

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or event handling proc

Yield Parameters:



136
# File 'lib/wx/doc/evthandler.rb', line 136

def evt_timer(id, meth = nil, &block) end

#evt_togglebutton(id, meth = nil) {|event| ... } ⇒ Object

Handles a Wx::EVT_TOGGLEBUTTON event. Processes a Wx::EVT_TOGGLEBUTTON event.

Parameters:

Yield Parameters:



1258
# File 'lib/wx/doc/gen/event_list.rb', line 1258

def evt_togglebutton(id, meth = nil, &block) end

#evt_tool(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TOOL event (a synonym for Wx::EVT_MENU). Pass the id of the tool.

Parameters:

Yield Parameters:



1264
# File 'lib/wx/doc/gen/event_list.rb', line 1264

def evt_tool(id, meth = nil, &block) end

#evt_tool_dropdown(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TOOL_DROPDOWN event. If unhandled, displays the default dropdown menu set using ToolBar#set_dropdown_menu.

Parameters:

Yield Parameters:



1395
# File 'lib/wx/doc/gen/event_list.rb', line 1395

def evt_tool_dropdown(id, meth = nil, &block) end

#evt_tool_enter(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TOOL_ENTER event. Pass the id of the toolbar itself. The value of CommandEvent#get_selection is the tool id, or -1 if the mouse cursor has moved off a tool. (Not available on WXOSX.)

Parameters:

Yield Parameters:



1290
# File 'lib/wx/doc/gen/event_list.rb', line 1290

def evt_tool_enter(id, meth = nil, &block) end

#evt_tool_range(id1, id2, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TOOL event for a range of identifiers. Pass the ids of the tools.

Parameters:

Yield Parameters:



1271
# File 'lib/wx/doc/gen/event_list.rb', line 1271

def evt_tool_range(id1,  id2, meth = nil, &block) end

#evt_tool_rclicked(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TOOL_RCLICKED event. Pass the id of the tool. (Not available on WXOSX.)

Parameters:

Yield Parameters:



1277
# File 'lib/wx/doc/gen/event_list.rb', line 1277

def evt_tool_rclicked(id, meth = nil, &block) end

#evt_tool_rclicked_range(id1, id2, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on WXOSX.)

Parameters:

Yield Parameters:



1284
# File 'lib/wx/doc/gen/event_list.rb', line 1284

def evt_tool_rclicked_range(id1,  id2, meth = nil, &block) end

#evt_toolbook_page_changed(id, meth = nil) {|event| ... } ⇒ Object

The page selection was changed. Processes a Wx::EVT_TOOLBOOK_PAGE_CHANGED event.

Parameters:

Yield Parameters:



1401
# File 'lib/wx/doc/gen/event_list.rb', line 1401

def evt_toolbook_page_changed(id, meth = nil, &block) end

#evt_toolbook_page_changing(id, meth = nil) {|event| ... } ⇒ Object

The page selection is about to be changed. Processes a Wx::EVT_TOOLBOOK_PAGE_CHANGING event. This event can be vetoed (using NotifyEvent#veto).

Parameters:

Yield Parameters:



1407
# File 'lib/wx/doc/gen/event_list.rb', line 1407

def evt_toolbook_page_changing(id, meth = nil, &block) end

#evt_tree_begin_drag(id, meth = nil) {|event| ... } ⇒ Object

Begin dragging with the left mouse button. If you want to enable left-dragging you need to intercept this event and explicitly call TreeEvent#allow, as it’s vetoed by default. Processes a Wx::EVT_TREE_BEGIN_DRAG event type.

Parameters:

Yield Parameters:



916
# File 'lib/wx/doc/gen/event_list.rb', line 916

def evt_tree_begin_drag(id, meth = nil, &block) end

#evt_tree_begin_label_edit(id, meth = nil) {|event| ... } ⇒ Object

Begin editing a label. This can be prevented by calling Veto(). Processes a Wx::EVT_TREE_BEGIN_LABEL_EDIT event type.

Parameters:

Yield Parameters:



934
# File 'lib/wx/doc/gen/event_list.rb', line 934

def evt_tree_begin_label_edit(id, meth = nil, &block) end

#evt_tree_begin_rdrag(id, meth = nil) {|event| ... } ⇒ Object

Begin dragging with the right mouse button. If you want to enable right-dragging you need to intercept this event and explicitly call TreeEvent#allow, as it’s vetoed by default. Processes a Wx::EVT_TREE_BEGIN_RDRAG event type.

Parameters:

Yield Parameters:



922
# File 'lib/wx/doc/gen/event_list.rb', line 922

def evt_tree_begin_rdrag(id, meth = nil, &block) end

#evt_tree_delete_item(id, meth = nil) {|event| ... } ⇒ Object

An item was deleted. Processes a Wx::EVT_TREE_DELETE_ITEM event type.

Parameters:

Yield Parameters:



946
# File 'lib/wx/doc/gen/event_list.rb', line 946

def evt_tree_delete_item(id, meth = nil, &block) end

#evt_tree_end_drag(id, meth = nil) {|event| ... } ⇒ Object

End dragging with the left or right mouse button. Processes a Wx::EVT_TREE_END_DRAG event type.

Parameters:

Yield Parameters:



928
# File 'lib/wx/doc/gen/event_list.rb', line 928

def evt_tree_end_drag(id, meth = nil, &block) end

#evt_tree_end_label_edit(id, meth = nil) {|event| ... } ⇒ Object

Finish editing a label. This can be prevented by calling Veto(). Processes a Wx::EVT_TREE_END_LABEL_EDIT event type.

Parameters:

Yield Parameters:



940
# File 'lib/wx/doc/gen/event_list.rb', line 940

def evt_tree_end_label_edit(id, meth = nil, &block) end

#evt_tree_get_info(id, meth = nil) {|event| ... } ⇒ Object

Request information from the application. Processes a Wx::EVT_TREE_GET_INFO event type.

Parameters:

Yield Parameters:



952
# File 'lib/wx/doc/gen/event_list.rb', line 952

def evt_tree_get_info(id, meth = nil, &block) end

#evt_tree_item_activated(id, meth = nil) {|event| ... } ⇒ Object

The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard. Processes a Wx::EVT_TREE_ITEM_ACTIVATED event type.

Parameters:

Yield Parameters:



964
# File 'lib/wx/doc/gen/event_list.rb', line 964

def evt_tree_item_activated(id, meth = nil, &block) end

#evt_tree_item_collapsed(id, meth = nil) {|event| ... } ⇒ Object

The item has been collapsed. Processes a Wx::EVT_TREE_ITEM_COLLAPSED event type.

Parameters:

Yield Parameters:



970
# File 'lib/wx/doc/gen/event_list.rb', line 970

def evt_tree_item_collapsed(id, meth = nil, &block) end

#evt_tree_item_collapsing(id, meth = nil) {|event| ... } ⇒ Object

The item is being collapsed. This can be prevented by calling Veto(). Processes a Wx::EVT_TREE_ITEM_COLLAPSING event type.

Parameters:

Yield Parameters:



976
# File 'lib/wx/doc/gen/event_list.rb', line 976

def evt_tree_item_collapsing(id, meth = nil, &block) end

#evt_tree_item_expanded(id, meth = nil) {|event| ... } ⇒ Object

The item has been expanded. Processes a Wx::EVT_TREE_ITEM_EXPANDED event type.

Parameters:

Yield Parameters:



982
# File 'lib/wx/doc/gen/event_list.rb', line 982

def evt_tree_item_expanded(id, meth = nil, &block) end

#evt_tree_item_expanding(id, meth = nil) {|event| ... } ⇒ Object

The item is being expanded. This can be prevented by calling Veto(). Processes a Wx::EVT_TREE_ITEM_EXPANDING event type.

Parameters:

Yield Parameters:



988
# File 'lib/wx/doc/gen/event_list.rb', line 988

def evt_tree_item_expanding(id, meth = nil, &block) end

#evt_tree_item_gettooltip(id, meth = nil) {|event| ... } ⇒ Object

The opportunity to set the item tooltip is being given to the application (call TreeEvent#set_tool_tip). Windows only. Processes a Wx::EVT_TREE_ITEM_GETTOOLTIP event type.

Parameters:

Yield Parameters:



1024
# File 'lib/wx/doc/gen/event_list.rb', line 1024

def evt_tree_item_gettooltip(id, meth = nil, &block) end

#evt_tree_item_menu(id, meth = nil) {|event| ... } ⇒ Object

The context menu for the selected item has been requested, either by a right click or by using the menu key. Notice that these events always carry a valid tree item and so are not generated when (right) clicking outside of the items area. If you need to handle such events, consider using Wx::EVT_CONTEXT_MENU instead. Processes a Wx::EVT_TREE_ITEM_MENU event type.

Parameters:

Yield Parameters:



1030
# File 'lib/wx/doc/gen/event_list.rb', line 1030

def evt_tree_item_menu(id, meth = nil, &block) end

#evt_tree_item_middle_click(id, meth = nil) {|event| ... } ⇒ Object

The user has clicked the item with the middle mouse button. This is only supported by the generic control. Processes a Wx::EVT_TREE_ITEM_MIDDLE_CLICK event type.

Parameters:

Yield Parameters:



1000
# File 'lib/wx/doc/gen/event_list.rb', line 1000

def evt_tree_item_middle_click(id, meth = nil, &block) end

#evt_tree_item_right_click(id, meth = nil) {|event| ... } ⇒ Object

The user has clicked the item with the right mouse button. Processes a Wx::EVT_TREE_ITEM_RIGHT_CLICK event type.

Parameters:

Yield Parameters:



994
# File 'lib/wx/doc/gen/event_list.rb', line 994

def evt_tree_item_right_click(id, meth = nil, &block) end

#evt_tree_key_down(id, meth = nil) {|event| ... } ⇒ Object

A key has been pressed. Processes a Wx::EVT_TREE_KEY_DOWN event type.

Parameters:

Yield Parameters:



1018
# File 'lib/wx/doc/gen/event_list.rb', line 1018

def evt_tree_key_down(id, meth = nil, &block) end

#evt_tree_sel_changed(id, meth = nil) {|event| ... } ⇒ Object

Selection has changed. Processes a Wx::EVT_TREE_SEL_CHANGED event type.

Parameters:

Yield Parameters:



1006
# File 'lib/wx/doc/gen/event_list.rb', line 1006

def evt_tree_sel_changed(id, meth = nil, &block) end

#evt_tree_sel_changing(id, meth = nil) {|event| ... } ⇒ Object

Selection is changing. This can be prevented by calling Veto(). Processes a Wx::EVT_TREE_SEL_CHANGING event type.

Parameters:

Yield Parameters:



1012
# File 'lib/wx/doc/gen/event_list.rb', line 1012

def evt_tree_sel_changing(id, meth = nil, &block) end

#evt_tree_set_info(id, meth = nil) {|event| ... } ⇒ Object

Information is being supplied. Processes a Wx::EVT_TREE_SET_INFO event type.

Parameters:

Yield Parameters:



958
# File 'lib/wx/doc/gen/event_list.rb', line 958

def evt_tree_set_info(id, meth = nil, &block) end

#evt_tree_state_image_click(id, meth = nil) {|event| ... } ⇒ Object

The state image has been clicked. Processes a Wx::EVT_TREE_STATE_IMAGE_CLICK event type.

Parameters:

Yield Parameters:



1036
# File 'lib/wx/doc/gen/event_list.rb', line 1036

def evt_tree_state_image_click(id, meth = nil, &block) end

#evt_treebook_node_collapsed(id, meth = nil) {|event| ... } ⇒ Object

The page node is going to be collapsed. Processes a Wx::EVT_TREEBOOK_NODE_COLLAPSED event.

Parameters:

Yield Parameters:



1449
# File 'lib/wx/doc/gen/event_list.rb', line 1449

def evt_treebook_node_collapsed(id, meth = nil, &block) end

#evt_treebook_node_expanded(id, meth = nil) {|event| ... } ⇒ Object

The page node is going to be expanded. Processes a Wx::EVT_TREEBOOK_NODE_EXPANDED event.

Parameters:

Yield Parameters:



1455
# File 'lib/wx/doc/gen/event_list.rb', line 1455

def evt_treebook_node_expanded(id, meth = nil, &block) end

#evt_treebook_page_changed(id, meth = nil) {|event| ... } ⇒ Object

The page selection was changed. Processes a Wx::EVT_TREEBOOK_PAGE_CHANGED event.

Parameters:

Yield Parameters:



1437
# File 'lib/wx/doc/gen/event_list.rb', line 1437

def evt_treebook_page_changed(id, meth = nil, &block) end

#evt_treebook_page_changing(id, meth = nil) {|event| ... } ⇒ Object

The page selection is about to be changed. Processes a Wx::EVT_TREEBOOK_PAGE_CHANGING event. This event can be vetoed.

Parameters:

Yield Parameters:



1443
# File 'lib/wx/doc/gen/event_list.rb', line 1443

def evt_treebook_page_changing(id, meth = nil, &block) end

#evt_two_finger_tap(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_TWO_FINGER_TAP. Processes a Wx::EVT_TWO_FINGER_TAP event.

Parameters:

Yield Parameters:



309
# File 'lib/wx/doc/gen/event_list.rb', line 309

def evt_two_finger_tap(id, meth = nil, &block) end

#evt_update_ui(id, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_UPDATE_UI event for the command with the given id.

Parameters:

Yield Parameters:



505
# File 'lib/wx/doc/gen/event_list.rb', line 505

def evt_update_ui(id, meth = nil, &block) end

#evt_update_ui_range(id1, id2, meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_UPDATE_UI event for any command with id included in the given range.

Parameters:

Yield Parameters:



512
# File 'lib/wx/doc/gen/event_list.rb', line 512

def evt_update_ui_range(id1,  id2, meth = nil, &block) end

#evt_window_create(meth = nil) {|event| ... } ⇒ Object

Process a Wx::EVT_CREATE event.

Parameters:

  • meth (String, Symbol, Method, Proc) (defaults to: nil)

    (name of) method or handler proc

Yield Parameters:



547
# File 'lib/wx/doc/gen/event_list.rb', line 547

def evt_window_create(meth = nil, &block) end

#evt_window_destroy {|event| ... } ⇒ Object

Processes Wx::WindowDestroyEvent events. In wxRuby Wx::Event#skipped will be forced to true after the provided handler has finished to make sure the event is propagated as it is required that Wx::App gets to handle the event in the end.

Yield Parameters:



130
# File 'lib/wx/doc/evthandler.rb', line 130

def evt_window_destroy(&block) end

#evt_wizard_before_page_changed(id, meth = nil) {|event| ... } ⇒ Object

Called after Next is clicked but before GetNext is called. Unlike EVT_WIZARD_CHANGING, the handler for this function can change state that might affect the return value of GetNext. This event can be vetoed. Processes a Wx::EVT_WIZARD_BEFORE_PAGE_CHANGED event.

Parameters:

Yield Parameters:



1080
# File 'lib/wx/doc/gen/event_list.rb', line 1080

def evt_wizard_before_page_changed(id, meth = nil, &block) end

#evt_wizard_cancel(id, meth = nil) {|event| ... } ⇒ Object

The user attempted to cancel the wizard (this event may also be vetoed). Processes a Wx::EVT_WIZARD_CANCEL event.

Parameters:

Yield Parameters:



1094
# File 'lib/wx/doc/gen/event_list.rb', line 1094

def evt_wizard_cancel(id, meth = nil, &block) end

#evt_wizard_finished(id, meth = nil) {|event| ... } ⇒ Object

The wizard finished button was pressed. Processes a Wx::EVT_WIZARD_FINISHED event.

Parameters:

Yield Parameters:



1108
# File 'lib/wx/doc/gen/event_list.rb', line 1108

def evt_wizard_finished(id, meth = nil, &block) end

#evt_wizard_help(id, meth = nil) {|event| ... } ⇒ Object

The wizard help button was pressed. Processes a Wx::EVT_WIZARD_HELP event.

Parameters:

Yield Parameters:



1101
# File 'lib/wx/doc/gen/event_list.rb', line 1101

def evt_wizard_help(id, meth = nil, &block) end

#evt_wizard_page_changed(id, meth = nil) {|event| ... } ⇒ Object

The page has just been changed (this event cannot be vetoed). Processes a Wx::EVT_WIZARD_PAGE_CHANGED event.

Parameters:

Yield Parameters:



1066
# File 'lib/wx/doc/gen/event_list.rb', line 1066

def evt_wizard_page_changed(id, meth = nil, &block) end

#evt_wizard_page_changing(id, meth = nil) {|event| ... } ⇒ Object

The page is being changed (this event can be vetoed). Processes a Wx::EVT_WIZARD_PAGE_CHANGING event.

Parameters:

Yield Parameters:



1073
# File 'lib/wx/doc/gen/event_list.rb', line 1073

def evt_wizard_page_changing(id, meth = nil, &block) end

#evt_wizard_page_shown(id, meth = nil) {|event| ... } ⇒ Object

The page was shown and laid out (this event cannot be vetoed). Processes a Wx::EVT_WIZARD_PAGE_SHOWN event.

Parameters:

Yield Parameters:



1087
# File 'lib/wx/doc/gen/event_list.rb', line 1087

def evt_wizard_page_shown(id, meth = nil, &block) end

#get_client_objectObject Also known as: client_object

Returns a pointer to the user-supplied client data object.

Returns:

See Also:



80
# File 'lib/wx/doc/gen/evt_handler.rb', line 80

def get_client_object; end

#get_evt_handler_enabledBoolean Also known as: evt_handler_enabled

Returns true if the event handler is enabled, false otherwise.

Returns:

  • (Boolean)

See Also:



98
# File 'lib/wx/doc/gen/evt_handler.rb', line 98

def get_evt_handler_enabled; end

#get_next_handlerWx::EvtHandler Also known as: next_handler

Returns the pointer to the next handler in the chain.



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

def get_next_handler; end

#get_previous_handlerWx::EvtHandler Also known as: previous_handler

Returns the pointer to the previous handler in the chain.



122
# File 'lib/wx/doc/gen/evt_handler.rb', line 122

def get_previous_handler; end

#is_unlinkedBoolean Also known as: unlinked?

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

Returns:

  • (Boolean)

See Also:



178
# File 'lib/wx/doc/gen/evt_handler.rb', line 178

def is_unlinked; end

#process_event(event) ⇒ true, false

Processes an event, searching event tables and calling zero or more suitable event handler function(s).

Normally, your application would not call this function: it is called in the wxWidgets implementation to dispatch incoming user interface events to the framework (and application).

However, you might need to call it if implementing new functionality (such as a new control) where you define new event types, as opposed to allowing the user to override virtual functions.

In wxRuby this method can not be effectively overridden. In order to override default event processing define a try_before(event) or try_after(event) method as member of a derived EvtHandler class.

The normal order of event table searching is as follows:

  1. App#filter_event is called. If it returns anything but -1 (default) the processing stops here.

  2. try_before (if it exists, otherwise the C++ default implementation) is called (this is where Validator are taken into account for Window objects). If this returns true, the function exits.

  3. If the object is disabled (via a call to #set_evt_handler_enabled) the function skips to step (7).

  4. Dynamic event table of the handlers bound using Bind<>() is searched in the most-recently-bound to the most-early-bound order. If a handler is found, it is executed and the function returns true unless the handler used Wx::Event#skip to indicate that it didn’t handle the event in which case the search continues.

  5. Static events table of the handlers bound using event table macros is searched for this event handler in the order of appearance of event table macros in the source code. If this fails, the base class event table is tried, and so on until no more tables exist or an appropriate function was found. If a handler is found, the same logic as in the previous step applies.

  6. The search is applied down the entire chain of event handlers (usually the chain has a length of one). This chain can be formed using #set_next_handler Note that in the case of Wx::Window you can build a stack of event handlers (see Window#push_event_handler for more info). If any of the handlers of the chain return true, the function exits.

  7. try_after (if it exists, otherwise the C++ default implementation) is called: for the Window object this may propagate the event to the window parent (recursively). If the event is still not processed, #process_event on the THE_APP object is called as the last step.

Notice that steps (2)-(6) are performed in #process_event_locally which is called by this function.

Parameters:

Returns:

  • (true, false)

    true if event has been processed



85
# File 'lib/wx/doc/evthandler.rb', line 85

def process_event(event) end

#process_event_locally(event) ⇒ Boolean

Try to process the event in this handler and all those chained to it.

As explained in #process_event documentation, the event handlers may be chained in a doubly-linked list. This function tries to process the event in this handler (including performing any pre-processing done in #try_before, e.g. applying validators) and all those following it in the chain until the event is processed or the chain is exhausted. This function is called from #process_event and, in turn, calls #try_before and #try_after. It is not virtual and so cannot be overridden but can, and should, be called to forward an event to another handler instead of #process_event which would result in a duplicate call to #try_after, e.g. resulting in all unprocessed events being sent to the application object multiple times.

true if this handler of one of those chained to it processed the event.

Parameters:

Returns:

  • (Boolean)


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

def process_event_locally(event) end

#process_pending_eventsvoid

This method returns an undefined value.

Processes the pending events previously queued using #queue_event or #add_pending_event; you must call this function only if you are sure there are pending events for this handler, otherwise a CHECK will fail.

The real processing still happens in #process_event which is called by this function. Note that this function needs a valid application object (see Wx::AppConsole#get_instance) because App holds the list of the event handlers with pending events and this function manipulates that list.



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

def process_pending_events; end

#queue_event(event) ⇒ void

This method returns an undefined value.

Queue event for a later processing.

This method is similar to #process_event but while the latter is synchronous, i.e. the event is processed immediately, before the function returns, this one is asynchronous and returns immediately while the event will be processed at some later time (usually during the next event loop iteration). Another important difference is that this method takes ownership of the event parameter, i.e. it will delete it itself. This implies that the pointer can’t be used any more after the function returns (as it can be deleted at any moment). #queue_event can be used for inter-thread communication from the worker threads to the main thread, it is safe in the sense that it uses locking internally and avoids the problem mentioned in #add_pending_event documentation by ensuring that the event object is not used by the calling thread any more. Care should still be taken to avoid that some fields of this object are used by it, notably any String members of the event object must not be shallow copies of another String object as this would result in them still using the same string buffer behind the scenes. For example:

Finally notice that this method automatically wakes up the event loop if it is currently idle by calling wake_up_idle so there is no need to do it manually when using it.

Parameters:

  • event (Wx::Event)

    A heap-allocated event to be queued, #queue_event takes ownership of it. This parameter shouldn’t be NULL.



31
# File 'lib/wx/doc/gen/evt_handler.rb', line 31

def queue_event(event) end

#safely_process_event(event) ⇒ Boolean

Processes an event by calling #process_event and handles any exceptions that occur in the process.

If an exception is thrown in event handler, App::OnExceptionInMainLoop is called.

true if the event was processed, false if no handler was found or an exception was thrown.

Parameters:

Returns:

  • (Boolean)

See Also:



59
# File 'lib/wx/doc/gen/evt_handler.rb', line 59

def safely_process_event(event) end

#set_client_object(data) ⇒ void Also known as: client_object=

This method returns an undefined value.

Set the client data object.

Any previous object will be deleted.

Parameters:

See Also:



90
# File 'lib/wx/doc/gen/evt_handler.rb', line 90

def set_client_object(data) end

#set_evt_handler_enabled(enabled) ⇒ void Also known as: evt_handler_enabled=

This method returns an undefined value.

Enables or disables the event handler.

Remark:

You can use this function to avoid having to remove the event handler from the chain, for example when implementing a dialog editor and changing from edit to test mode.

Parameters:

  • enabled (Boolean)

    true if the event handler is to be enabled, false if it is to be disabled.

See Also:



135
# File 'lib/wx/doc/gen/evt_handler.rb', line 135

def set_evt_handler_enabled(enabled) end

#set_next_handler(handler) ⇒ void Also known as: next_handler=

This method returns an undefined value.

Sets the pointer to the next handler.

Remark:

See #process_event for more info about how the chains of event handlers are internally used. Also remember that Wx::EvtHandler uses double-linked lists and thus if you use this function, you should also call #set_previous_handler on the argument passed to this function: ```ruby handlerA.set_next_handler(handlerB) handlerB.set_previous_handler(handlerA) ```

Parameters:

  • handler (Wx::EvtHandler)

    The event handler to be set as the next handler. Cannot be NULL.

See Also:

  • Events are Processed


153
# File 'lib/wx/doc/gen/evt_handler.rb', line 153

def set_next_handler(handler) end

#set_previous_handler(handler) ⇒ void Also known as: previous_handler=

This method returns an undefined value.

Sets the pointer to the previous handler.

All remarks about #set_next_handler apply to this function as well.

Parameters:

  • handler (Wx::EvtHandler)

    The event handler to be set as the previous handler. Cannot be NULL.

See Also:

  • Events are Processed


162
# File 'lib/wx/doc/gen/evt_handler.rb', line 162

def set_previous_handler(handler) end

#try_after(event) ⇒ Boolean (protected)

Method called by #process_event as last resort.

This method can be overridden to implement post-processing for the events which were not processed anywhere else. The base class version handles forwarding the unprocessed events to App at Wx::EvtHandler level and propagating them upwards the window child-parent chain at Window level and so should usually be called when overriding this method:

class MyClass < BaseClass # inheriting from Wx::EvtHandler
  ...
  protected
    def try_after(event)
      if super
        return true

      my_post_process(event)
    end
  end

Parameters:

Returns:

  • (Boolean)

See Also:



242
# File 'lib/wx/doc/gen/evt_handler.rb', line 242

def try_after(event) end

#try_before(event) ⇒ Boolean (protected)

Method called by #process_event before examining this object event tables.

This method can be overridden to hook into the event processing logic as early as possible. You should usually call the base class version when overriding this method, even if Wx::EvtHandler itself does nothing here, some derived classes do use this method, e.g. Window implements support for Validator in it. Example:

class MyClass < BaseClass # inheriting from Wx::EvtHandler
  ...
  protected
    def try_before(event)
      if my_pre_process(event)
        return true
  
      super
    end
  end

Parameters:

Returns:

  • (Boolean)

See Also:



221
# File 'lib/wx/doc/gen/evt_handler.rb', line 221

def try_before(event) end

This method returns an undefined value.

Unlinks this event handler from the chain it’s part of (if any); then links the “previous” event handler to the “next” one (so that the chain won’t be interrupted).

E.g. if before calling #unlink you have the following chain: then after calling B->unlink you’ll have:



170
# File 'lib/wx/doc/gen/evt_handler.rb', line 170

def unlink; end