wx.lib.splitter.MultiSplitterEvent

This event class is almost the same as wx.SplitterEvent except it adds an accessor for the sash index that is being changed. The same event type IDs and event binders are used as with wx.SplitterEvent.

Class Hierarchy

Inheritance diagram for class MultiSplitterEvent:

Known Superclasses

wx.PyCommandEvent

Methods Summary

__init__	Constructor.
Allow	This is the opposite of Veto : it explicitly allows the
GetSashIdx	Returns the new sash index.
GetSashPosition	Returns the new sash position.
IsAllowed	Returns True if the change is allowed ( Veto hasn’t been
SetSashIdx	In the case of wxEVT_SPLITTER_SASH_POS_CHANGED events, sets the
SetSashPosition	In the case of wxEVT_SPLITTER_SASH_POS_CHANGED events, sets the
Veto	Prevents the change announced by this event from happening.

Class API

class MultiSplitterEvent(wx.PyCommandEvent)

This event class is almost the same as wx.SplitterEvent except it adds an accessor for the sash index that is being changed. The same event type IDs and event binders are used as with wx.SplitterEvent.

Methods

__init__(self, type=wx.wxEVT_NULL, splitter=None)

Constructor.

Used internally by wxWidgets only.

Parameters:

• eventType (EventType) –

• splitter (SplitterWindow) –

---

Allow(self)

This is the opposite of Veto : it explicitly allows the event to be processed.

For most events it is not necessary to call this method as the events are allowed anyhow but some are forbidden by default (this will be mentioned in the corresponding event description).

---

GetSashIdx(self)

Returns the new sash index.

May only be called while processing wxEVT_SPLITTER_SASH_POS_CHANGING and wxEVT_SPLITTER_SASH_POS_CHANGED events.

Return type:

int

---

GetSashPosition(self)

Returns the new sash position.

May only be called while processing wxEVT_SPLITTER_SASH_POS_CHANGING and wxEVT_SPLITTER_SASH_POS_CHANGED events.

Return type:

int

---

IsAllowed(self)

Returns True if the change is allowed ( Veto hasn’t been called) or False otherwise (if it was).

Return type:

bool

---

SetSashIdx(self, idx)

In the case of wxEVT_SPLITTER_SASH_POS_CHANGED events, sets the new sash index.

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 reindexing.

May only be called while processing wxEVT_SPLITTER_SASH_POS_CHANGING and wxEVT_SPLITTER_SASH_POS_CHANGED events.

Parameters:

pos (int) – New sash index.

---

SetSashPosition(self, pos)

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.

Parameters:

pos (int) – New sash position.

---

Veto(self)

Prevents the change announced by this event from happening.

It is in general a good idea to notify the user about the reasons for vetoing the change because otherwise the applications behaviour (which just refuses to do what the user wants) might be quite surprising.