wxSplitterEvent Class Reference
[Events]

#include <wx/splitter.h>

Inheritance diagram for wxSplitterEvent:

List of all members.

---

Detailed Description

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.

Library:  wxCore

Category:  Events

See also:

wxSplitterWindow, overview_eventhandlingoverview

Public Member Functions
	wxSplitterEvent (wxEventType eventType=wxEVT_NULL, wxSplitterWindow *splitter=NULL)
int	GetSashPosition () const
wxWindow *	GetWindowBeingRemoved () const
int	GetX () const
int	GetY () const
void	SetSashPosition (int pos)

---

Constructor & Destructor Documentation

wxSplitterEvent::wxSplitterEvent	(	wxEventType	eventType = wxEVT_NULL,
		wxSplitterWindow *	splitter = NULL
	)

Constructor. Used internally by wxWidgets only.

---

Member Function Documentation

int wxSplitterEvent::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.

wxWindow* wxSplitterEvent::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.

int wxSplitterEvent::GetX

(

)

const

Returns the x coordinate of the double-click point. May only be called while processing wxEVT_COMMAND_SPLITTER_DOUBLECLICKED events.

int wxSplitterEvent::GetY

(

)

const

Returns the y coordinate of the double-click point. May only be called while processing wxEVT_COMMAND_SPLITTER_DOUBLECLICKED events.

void wxSplitterEvent::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.