wxRuby Documentation Home

# Wx::SplitterEvent

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.

## Derived from

NotifyEvent

CommandEvent

Event

Object

## Event table macros

To process a splitter event, use these event handler macros to direct input to member
functions that take a SplitterEvent argument.

evt_splitter_sash_pos_changing(id) { | event | … } | The sashposition is in the process of being changed. You may prevent this changefrom happening by calling Veto or you may alsomodify the position of the tracking bar to properly reflect the position thatwould be set if the drag were to be completed at this point. Processes aEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
evt_splitter_sash_pos_changed(id) { | event | … } | The sashposition was changed. This event is generated after the user releases the mouseafter dragging the splitter.Processes a EVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
evt_splitter_unsplit(id) { | event | … } | The splitter has been justunsplit. Processes a EVT_COMMAND_SPLITTER_UNSPLIT event. This event can’tbe vetoed.
evt_splitter_dclick(id) { | event | … } | The sash was doubleclicked. 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). Thiswon’t happen if you veto this event. Processes aEVT_COMMAND_SPLITTER_DOUBLECLICKED event.

## See also

SplitterWindow, Event handling overview

## Methods

- SplitterEvent.new
- SplitterEvent#get_sash_position
- SplitterEvent#get_x
- SplitterEvent#get_y
- SplitterEvent#get_window_being_removed
- SplitterEvent#set_sash_position

### SplitterEvent.new

SplitterEvent.new(%(arg-type)EventType% eventType = EVT_NULL, SplitterWindow splitter = nil)

Constructor. Used internally by Widgets only.

### SplitterEvent#get_sash_position

Integer get_sash_position()

Returns the new sash position.

May only be called while processing
EVT_COMMAND_SPLITTER_SASH_POS_CHANGING and
EVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.

### SplitterEvent#get_x

Integer get_x()

Returns the x coordinate of the double-click point.

May only be called while processing
EVT_COMMAND_SPLITTER_DOUBLECLICKED events.

### SplitterEvent#get_y

Integer get_y()

Returns the y coordinate of the double-click point.

May only be called while processing
EVT_COMMAND_SPLITTER_DOUBLECLICKED events.

### SplitterEvent#get_window_being_removed

Window get_window_being_removed()

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

May only be called while processing
EVT_COMMAND_SPLITTER_UNSPLIT events.

### SplitterEvent#set_sash_position

set_sash_position(%(arg-type)Integer% pos)

In the case of EVT_COMMAND_SPLITTER_SASH_POS_CHANGED events,
sets the new sash position. In the case of
EVT_COMMAND_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_COMMAND_SPLITTER_SASH_POS_CHANGING and
EVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.

#### Parameters

- pos New sash position.

[This page automatically generated from the Textile source at 2023-06-09 00:45:36 +0000]