Class: Wx::SplitterEvent

Inherits:

NotifyEvent

• Object
• Object
• Event
• CommandEvent
• NotifyEvent
• Wx::SplitterEvent

Defined in:

lib/wx/doc/gen/splitter_event.rb

Overview

This class represents the events generated by a splitter control.

Also there is only one event class, the data associated to the different events is not the same and so not all accessor functions may be called for each event. The documentation mentions the kind of event(s) for which the given accessor function makes sense: calling it for other types of events will result in assert failure (in debug mode) and will return meaningless results.

Events using this class

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

• EvtHandler#evt_splitter_sash_pos_changing(id, meth = nil, &block): 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 EVT_SPLITTER_SASH_POS_CHANGING event.

• EvtHandler#evt_splitter_sash_pos_changed(id, meth = nil, &block): 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 EVT_SPLITTER_SASH_POS_CHANGED event.

• EvtHandler#evt_splitter_unsplit(id, meth = nil, &block): The splitter has been just unsplit. Processes a EVT_SPLITTER_UNSPLIT event.

• EvtHandler#evt_splitter_dclick(id, meth = nil, &block): 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 EVT_SPLITTER_DOUBLECLICKED event.

Category: Events

See Also:

• SplitterWindow
• and Event Handling

Requires:

• USE_SPLITTER

Instance Method Summary

• #get_old_size ⇒ Integer (also: #old_size)

  Returns the old size before the update.

• #get_sash_position ⇒ Integer (also: #sash_position)

  Returns the new sash position.

• #get_window_being_removed ⇒ Wx::Window (also: #window_being_removed)

  Returns a pointer to the window being removed when a splitter window is unsplit.

• #get_x ⇒ Integer (also: #x)

  Returns the x coordinate of the double-click point.

• #get_y ⇒ Integer (also: #y)

  Returns the y coordinate of the double-click point.

• #initialize(eventType = Wx::EVT_NULL, splitter = nil) ⇒ Wx::SplitterEvent constructor

  Constructor.

• #set_sash_position(pos) ⇒ void (also: #sash_position=)

  In the case of EVT_SPLITTER_SASH_POS_CHANGED events, sets the new sash position.

• #set_size(oldSize, newSize) ⇒ void

  Sets the size values of the window size.

Methods inherited from NotifyEvent

#allow, #is_allowed, #veto

Methods inherited from CommandEvent

#client_data, #client_data=, #get_client_data, #get_client_object, #get_int, #get_selection, #get_string, #is_checked, #is_selection, #set_client_data, #set_client_object, #set_extra_long, #set_int, #set_string

Methods inherited from Event

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

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(eventType = Wx::EVT_NULL, splitter = nil) ⇒ Wx::SplitterEvent

Constructor.

Used internally by wxWidgets only.

Parameters:

• eventType (Wx::GenericCollapsiblePane::EventType) (defaults to: Wx::EVT_NULL)
• splitter (Wx::SplitterWindow) (defaults to: nil)

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

def initialize(eventType=Wx::EVT_NULL, splitter=nil) end

Instance Method Details

#get_old_size ⇒ Integer Also known as: old_size

Returns the old size before the update.

The size value is already adjusted to the orientation of the sash. So for a vertical sash it’s the width and for a horizontal sash it’s the height. May only be called while processing EVT_SPLITTER_SASH_POS_CHANGING, EVT_SPLITTER_SASH_POS_RESIZE and EVT_SPLITTER_SASH_POS_CHANGED events. May only be called while processing EVT_SPLITTER_SASH_POS_CHANGING, EVT_SPLITTER_SASH_POS_RESIZE and EVT_SPLITTER_SASH_POS_CHANGED events.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/splitter_event.rb', line 93

def get_old_size; end

#get_sash_position ⇒ Integer Also known as: sash_position

Returns the new sash position.

May only be called while processing EVT_SPLITTER_SASH_POS_CHANGING, EVT_SPLITTER_SASH_POS_RESIZE and EVT_SPLITTER_SASH_POS_CHANGED events.

Returns:

• (Integer)

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

def get_sash_position; end

#get_window_being_removed ⇒ Wx::Window Also known as: window_being_removed

Returns a pointer to the window being removed when a splitter window is unsplit.

May only be called while processing EVT_SPLITTER_UNSPLIT events.

Returns:

• (Wx::Window)

# File 'lib/wx/doc/gen/splitter_event.rb', line 52

def get_window_being_removed; end

#get_x ⇒ Integer Also known as: x

Returns the x coordinate of the double-click point.

May only be called while processing EVT_SPLITTER_DOUBLECLICKED events.

Returns:

• (Integer)

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

def get_x; end

#get_y ⇒ Integer Also known as: y

Returns the y coordinate of the double-click point.

May only be called while processing EVT_SPLITTER_DOUBLECLICKED events.

Returns:

• (Integer)

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

def get_y; end

#set_sash_position(pos) ⇒ void Also known as: sash_position=

This method returns an undefined value.

In the case of EVT_SPLITTER_SASH_POS_CHANGED events, sets the new sash position.

In the case of EVT_SPLITTER_SASH_POS_CHANGING events, sets the new tracking bar position so visual feedback during dragging will represent that change that will actually take place. Set to -1 from the event handler code to prevent repositioning. May only be called while processing EVT_SPLITTER_SASH_POS_CHANGING, EVT_SPLITTER_SASH_POS_RESIZE and EVT_SPLITTER_SASH_POS_CHANGED events.

Parameters:

• pos (Integer) —

  New sash position.

# File 'lib/wx/doc/gen/splitter_event.rb', line 75

def set_sash_position(pos) end

#set_size(oldSize, newSize) ⇒ void

This method returns an undefined value.

Sets the size values of the window size.

This size is adjusted to the sash orientation. For a vertical sash it should be the width and for a horizontal sash it’s the height. May only be called while processing EVT_SPLITTER_SASH_POS_CHANGING, EVT_SPLITTER_SASH_POS_RESIZE and EVT_SPLITTER_SASH_POS_CHANGED events.

Parameters:

• oldSize (Integer)
• newSize (Integer)

# File 'lib/wx/doc/gen/splitter_event.rb', line 85

def set_size(oldSize, newSize) end