wx.SplitterWindow Class Reference

Inheritance diagram for wx.SplitterWindow:

wx.Window wx.EvtHandler wx.Object

List of all members.

Public Member Functions

void Initialize (Window window)
virtual void OnDoubleClickSash (int x, int y)
virtual bool OnSashPositionChange (int newSashPosition)
virtual void OnUnsplit (Window removed)
bool ReplaceWindow (Window winOld, Window winNew)
void SetSashPosition (int position, bool redraw)
bool SplitHorizontally (Window wnd1, Window wnd2, int sashPos)
bool SplitHorizontally (Window wnd1, Window wnd2)
 SplitterWindow (Window parent, Point pos, Size size, wx.WindowStyles style, string name)
 SplitterWindow (Window parent, Point pos, Size size, wx.WindowStyles style)
 SplitterWindow (Window parent, Point pos, Size size)
 SplitterWindow (Window parent, Point pos)
 SplitterWindow (Window parent, int id, Point pos, Size size, wx.WindowStyles style, wxString name)
 SplitterWindow (Window parent, int id, Point pos, Size size, wx.WindowStyles style, string name)
 SplitterWindow (Window parent, int id, Point pos, Size size, wx.WindowStyles style)
 SplitterWindow (Window parent, int id, Point pos, Size size)
 SplitterWindow (Window parent, int id, Point pos)
 SplitterWindow (Window parent, int id)
 SplitterWindow (Window parent)
bool SplitVertically (Window wnd1, Window wnd2, int sashPos)
bool SplitVertically (Window wnd1, Window wnd2)
bool Unsplit (Window toRemove)
bool Unsplit ()
void UpdateSize ()

Properties

bool IsSplit [get]
int MinimumPaneSize [get, set]
double SashGravity [get, set]
int SashPosition [get, set]
SplitMode SplitMode [get, set]
Window Window1 [get]
Window Window2 [get]


Detailed Description

This class manages up to two subwindows. The current view can be split into two programmatically (perhaps from a menu command), and unsplit either programmatically or via the wx.SplitterWindow user interface.

The following screenshot shows the appearance of a splitter window with a horizontal split.

splitter.png

The style wx.WindowStyles.SP_3D has been used to show a 3D border and 3D sash.


Constructor & Destructor Documentation

wx.SplitterWindow.SplitterWindow ( Window  parent  ) 

wx.SplitterWindow.SplitterWindow ( Window  parent,
int  id 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
int  id,
Point  pos 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
int  id,
Point  pos,
Size  size 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
int  id,
Point  pos,
Size  size,
wx.WindowStyles  style 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
int  id,
Point  pos,
Size  size,
wx.WindowStyles  style,
string  name 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
int  id,
Point  pos,
Size  size,
wx.WindowStyles  style,
wxString  name 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
Point  pos 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
Point  pos,
Size  size 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
Point  pos,
Size  size,
wx.WindowStyles  style 
)

wx.SplitterWindow.SplitterWindow ( Window  parent,
Point  pos,
Size  size,
wx.WindowStyles  style,
string  name 
)


Member Function Documentation

void wx.SplitterWindow.Initialize ( Window  window  ) 

virtual void wx.SplitterWindow.OnDoubleClickSash ( int  x,
int  y 
) [virtual]

virtual bool wx.SplitterWindow.OnSashPositionChange ( int  newSashPosition  )  [virtual]

virtual void wx.SplitterWindow.OnUnsplit ( Window  removed  )  [virtual]

bool wx.SplitterWindow.ReplaceWindow ( Window  winOld,
Window  winNew 
)

void wx.SplitterWindow.SetSashPosition ( int  position,
bool  redraw 
)

Set the sash position.

M:wx.SplitterWindow.SashPosition

bool wx.SplitterWindow.SplitHorizontally ( Window  wnd1,
Window  wnd2,
int  sashPos 
)

Initializes the top and bottom panes of the splitter window. The child windows are shown if they are currently hidden.

This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using IsSplit.

Parameters:
wnd1 The left pane
wnd2 The right pane
sashPos The initial position of the sash. If this value is positive, it specifies the size of the top pane. If it is negative, it is absolute value gives the size of the bottom pane. Finally, specify 0 (default) to choose the default position (half of the total window width).
Returns:
true if successful, false otherwise (the window was already split).

bool wx.SplitterWindow.SplitHorizontally ( Window  wnd1,
Window  wnd2 
)

Initializes the top and bottom panes of the splitter window. The child windows are shown if they are currently hidden.

Initially, the sash divides the control into two halfs.

This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using IsSplit.

Parameters:
wnd1 The left pane
wnd2 The right pane
Returns:
true if successful, false otherwise (the window was already split).

bool wx.SplitterWindow.SplitVertically ( Window  wnd1,
Window  wnd2,
int  sashPos 
)

Initializes the left and right panes of the splitter window. The child windows are shown if they are currently hidden.

This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using IsSplit.

Parameters:
wnd1 The left pane
wnd2 The right pane
sashPos The initial position of the sash. If this value is positive, it specifies the size of the left pane. If it is negative, it is absolute value gives the size of the right pane. Finally, specify 0 (default) to choose the default position (half of the total window width).
Returns:
true if successful, false otherwise (the window was already split).

bool wx.SplitterWindow.SplitVertically ( Window  wnd1,
Window  wnd2 
)

Initializes the left and right panes of the splitter window. The child windows are shown if they are currently hidden.

Sash divides the pane initially in the half.

This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using IsSplit.

Parameters:
wnd1 The left pane
wnd2 The right pane
Returns:
true if successful, false otherwise (the window was already split).

bool wx.SplitterWindow.Unsplit ( Window  toRemove  ) 

Unsplits the window. This call will not actually delete the pane being removed; it calls OnUnsplit() which can be overridden for the desired behaviour. By default, the pane being removed is hidden.

Parameters:
toRemove The pane to remove, or null to remove the right or bottom pane.
Returns:
true if successful, false otherwise (the window was not split).

bool wx.SplitterWindow.Unsplit (  ) 

Unsplits the window. This call will not actually delete the pane being removed; it calls OnUnsplit() which can be overridden for the desired behaviour. By default, the pane being removed is hidden.

This will remove the right or bottom pane.

Returns:
true if successful, false otherwise (the window was not split).

void wx.SplitterWindow.UpdateSize (  ) 


Property Documentation

bool wx.SplitterWindow.IsSplit [get]

True iff the control is currently split. this shall be tested before using SplitHorizontally() or SplitVertically().

int wx.SplitterWindow.MinimumPaneSize [get, set]

Gets or sets the minimum pane size. The default minimum pane size is zero, which means that either pane can be reduced to zero by dragging the sash, thus removing one of the panes. To prevent this behaviour (and veto out-of-range sash dragging), set a minimum size, for example 20 pixels. If the wxSP_PERMIT_UNSPLIT style is used when a splitter window is created, the window may be unsplit even if minimum size is non-zero.

double wx.SplitterWindow.SashGravity [get, set]

int wx.SplitterWindow.SashPosition [get, set]

Get or set the sash position.

SplitMode wx.SplitterWindow.SplitMode [get, set]

Window wx.SplitterWindow.Window1 [get]

Window wx.SplitterWindow.Window2 [get]


Manual of the wx.NET   (c) 2003-2011 the wx.NET project at   Get wx.NET at SourceForge.net. Fast, secure and Free Open Source software downloads