wxSplitterEvent — wx v2.4.3.1

Search documentation of wx

# wxSplitterEvent (wx v2.4.3.1)

View Source

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.

See:

- `wxSplitterWindow`

- Overview events

This class is derived, and can use functions, from:

- `wxNotifyEvent`

- `wxCommandEvent`

- `wxEvent`

wxWidgets docs: wxSplitterEvent

## Events

Use `wxEvtHandler:connect/3` with `wxSplitterEventType` to subscribe to events of this type.

# Summary

## Types

wxSplitter()
wxSplitterEvent()
wxSplitterEventType()

## Functions

getSashPosition(This)

Returns the new sash position.

getWindowBeingRemoved(This)

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

getX(This)

Returns the x coordinate of the double-click point.

getY(This)

Returns the y coordinate of the double-click point.

setSashPosition(This, Pos)

In the case of `wxEVT\_SPLITTER\_SASH\_POS\_CHANGED` events, sets the new sash position.

# Types

# wxSplitter()

    -type wxSplitter() :: #wxSplitter{type :: wxSplitterEvent:wxSplitterEventType()}.

# wxSplitterEvent()

    -type wxSplitterEvent() :: wx:wx_object().

# wxSplitterEventType()

    -type wxSplitterEventType() ::
              command_splitter_sash_pos_changed | command_splitter_sash_pos_changing |
              command_splitter_doubleclicked | command_splitter_unsplit.

# Functions

# getSashPosition(This)

    -spec getSashPosition(This) -> integer() when This :: wxSplitterEvent().

Returns the new sash position.

May only be called while processing `wxEVT_SPLITTER_SASH_POS_CHANGING` and `wxEVT_SPLITTER_SASH_POS_CHANGED` events.

# getWindowBeingRemoved(This)

    -spec getWindowBeingRemoved(This) -> wxWindow:wxWindow() when This :: wxSplitterEvent().

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

May only be called while processing `wxEVT_SPLITTER_UNSPLIT` events.

# getX(This)

    -spec getX(This) -> integer() when This :: wxSplitterEvent().

Returns the x coordinate of the double-click point.

May only be called while processing `wxEVT_SPLITTER_DOUBLECLICKED` events.

# getY(This)

    -spec getY(This) -> integer() when This :: wxSplitterEvent().

Returns the y coordinate of the double-click point.

May only be called while processing `wxEVT_SPLITTER_DOUBLECLICKED` events.

# setSashPosition(This, Pos)

    -spec setSashPosition(This, Pos) -> ok when This :: wxSplitterEvent(), Pos :: integer().

In the case of `wxEVT\_SPLITTER\_SASH\_POS\_CHANGED` events, sets the new sash position.

In the case of `wxEVT_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 `wxEVT_SPLITTER_SASH_POS_CHANGING` and `wxEVT_SPLITTER_SASH_POS_CHANGED` events.