wxsplitterevent

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

wxnotifyevent
wxcommandevent
wxevent
wxobject

include files

event table macros

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

evt_splitter_sash_pos_changing(id, func)	the sash position is in the process of being changed. you may prevent this change from happening by calling veto or you may also 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 wxevt_command_splitter_sash_pos_changing event.
evt_splitter_sash_pos_changed(id, func)	the sash position was changed. this event is generated after the user releases the mouse after dragging the splitter. processes a wxevt_command_splitter_sash_pos_changed event.
evt_splitter_unsplit(id, func)	the splitter has been just unsplit. processes a wxevt_command_splitter_unsplit event. this event can't be vetoed.
evt_splitter_dclick(id, func)	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). this won't happen if you veto this event. processes a wxevt_command_splitter_doubleclicked event.

members

wxsplitterevent::wxsplitterevent
wxsplitterevent::getsashposition
wxsplitterevent::getx
wxsplitterevent::gety
wxsplitterevent::getwindowbeingremoved
wxsplitterevent::setsashposition

wxsplitterevent::wxsplitterevent

wxsplitterevent(wxeventtype eventtype = wxevt_null, wxsplitterwindow * splitter = null)

constructor. used internally by wxwidgets only.

wxsplitterevent::getsashposition

int getsashposition() const

returns the new sash position.

may only be called while processing wxevt_command_splitter_sash_pos_changing and wxevt_command_splitter_sash_pos_changed events.

wxsplitterevent::getx

int getx() const

returns the x coordinate of the double-click point.

may only be called while processing wxevt_command_splitter_doubleclicked events.

wxsplitterevent::gety

int gety() const

returns the y coordinate of the double-click point.

may only be called while processing wxevt_command_splitter_doubleclicked events.

wxsplitterevent::getwindowbeingremoved

wxwindow* getwindowbeingremoved() const

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

may only be called while processing wxevt_command_splitter_unsplit events.

wxsplitterevent::setsashposition

void setsashposition(int pos)

in the case of wxevt_command_splitter_sash_pos_changed events, sets the new sash position. in the case of wxevt_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 wxevt_command_splitter_sash_pos_changing and wxevt_command_splitter_sash_pos_changed events.

parameters

pos

new sash position.