wx.lib.agw.fourwaysplitter.FourWaySplitterEvent

This event class is almost the same as 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 SplitterEvent.

Class Hierarchy

Inheritance diagram for class FourWaySplitterEvent:

Known Superclasses

wx.CommandEvent

Methods Summary

__init__	Default class constructor.
Allow	This is the opposite of Veto: it explicitly allows the event to be processed.
GetSashIdx	Returns the index of the sash currently involved in the event.
GetSashPosition	Returns the new sash position.
IsAllowed	Returns True if the change is allowed ( Veto hasn’t been called) or
SetSashIdx	Sets the index of the sash currently involved in the event.
SetSashPosition	In the case of EVT_SPLITTER_SASH_POS_CHANGED events, sets the new sash
Veto	Prevents the change announced by this event from happening.

Class API

class FourWaySplitterEvent(wx.CommandEvent)

This event class is almost the same as 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 SplitterEvent.

Methods

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

Default class constructor.

Parameters

• evtType – the event type;

• splitter – the associated FourWaySplitter window.

---

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 index of the sash currently involved in the event.

---

GetSashPosition(self)

Returns the new sash position.

Note

May only be called while processing EVT_SPLITTER_SASH_POS_CHANGING and EVT_SPLITTER_SASH_POS_CHANGED events.

---

IsAllowed(self)

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

---

SetSashIdx(self, idx)

Sets the index of the sash currently involved in the event.

Parameters

idx – an integer between 0 and 3, representing the index of the sash involved in the event.

---

SetSashPosition(self, pos)

In the case of EVT_SPLITTER_SASH_POS_CHANGED events, sets the new sash position. In the case of EVT_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.

Parameters

pos – the new sash position.

Note

May only be called while processing EVT_SPLITTER_SASH_POS_CHANGING and EVT_SPLITTER_SASH_POS_CHANGED events.

---

Veto(self)

Prevents the change announced by this event from happening.

Note

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.