wxsashwindow

wxsashwindow allows any of its edges to have a sash which can be dragged to resize the window. the actual content window will be created by the application as a child of wxsashwindow. the window (or an ancestor) will be notified of a drag via a wxsashevent notification.

derived from

wxwindow
wxevthandler
wxobject

include files

<wx/sashwin.h>

window styles

the following styles apply in addition to the normal wxwindow styles.

wxsw_3d	draws a 3d effect sash and border.
wxsw_3dsash	draws a 3d effect sash.
wxsw_3dborder	draws a 3d effect border.
wxsw_border	draws a thin black border.

see also window styles overview.

event handling

evt_sash_dragged(id, func)	process a wxevt_sash_dragged event, when the user has finished dragging a sash.
evt_sash_dragged_range(id1, id2, func)	process a wxevt_sash_dragged_range event, when the user has finished dragging a sash. the event handler is called when windows with ids in the given range have their sashes dragged.

data types

enum wxsashedgeposition {
    wxsash_top = 0,
    wxsash_right,
    wxsash_bottom,
    wxsash_left,
    wxsash_none = 100
};

see also

wxsashevent, wxsashlayoutwindow, event handling overview

members

wxsashwindow::wxsashwindow
wxsashwindow::~wxsashwindow
wxsashwindow::getsashvisible
wxsashwindow::getmaximumsizex
wxsashwindow::getmaximumsizey
wxsashwindow::getminimumsizex
wxsashwindow::getminimumsizey
wxsashwindow::hasborder
wxsashwindow::setmaximumsizex
wxsashwindow::setmaximumsizey
wxsashwindow::setminimumsizex
wxsashwindow::setminimumsizey
wxsashwindow::setsashvisible
wxsashwindow::setsashborder

wxsashwindow::wxsashwindow

wxsashwindow()

default constructor.

wxsashwindow(wxwindow* parent, wxwindowid id, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxclip_children | wxsw_3d, const wxstring& name = "sashwindow")

constructs a sash window, which can be a child of a frame, dialog or any other non-control window.

parameters

parent

pointer to a parent window.

id

window identifier. if -1, will automatically create an identifier.

pos

window position. wxdefaultposition is (-1, -1) which indicates that wxsashwindows should generate a default position for the window. if using the wxsashwindow class directly, supply an actual position.

size

window size. wxdefaultsize is (-1, -1) which indicates that wxsashwindows should generate a default size for the window.

style

window style. for window styles, please see wxsashwindow.

name

window name.

wxsashwindow::~wxsashwindow

~wxsashwindow()

destructor.

wxsashwindow::getsashvisible

bool getsashvisible(wxsashedgeposition edge) const

returns true if a sash is visible on the given edge, false otherwise.

parameters

edge

edge. one of wxsash_top, wxsash_right, wxsash_bottom, wxsash_left.

see also

wxsashwindow::setsashvisible

wxsashwindow::getmaximumsizex

int getmaximumsizex() const

gets the maximum window size in the x direction.

wxsashwindow::getmaximumsizey

int getmaximumsizey() const

gets the maximum window size in the y direction.

wxsashwindow::getminimumsizex

int getminimumsizex()

gets the minimum window size in the x direction.

wxsashwindow::getminimumsizey

int getminimumsizey() const

gets the minimum window size in the y direction.

wxsashwindow::hasborder

bool hasborder(wxsashedgeposition edge) const

returns true if the sash has a border, false otherwise. this function is obsolete since the sash border property is unused.

parameters

edge

edge. one of wxsash_top, wxsash_right, wxsash_bottom, wxsash_left.

see also

wxsashwindow::setsashborder

wxsashwindow::setmaximumsizex

void setmaximumsizex(int min)

sets the maximum window size in the x direction.

wxsashwindow::setmaximumsizey

void setmaximumsizey(int min)

sets the maximum window size in the y direction.

wxsashwindow::setminimumsizex

void setminimumsizex(int min)

sets the minimum window size in the x direction.

wxsashwindow::setminimumsizey

void setminimumsizey(int min)

sets the minimum window size in the y direction.

wxsashwindow::setsashvisible

void setsashvisible(wxsashedgeposition edge, bool visible)

call this function to make a sash visible or invisible on a particular edge.

parameters

edge

edge to change. one of wxsash_top, wxsash_right, wxsash_bottom, wxsash_left.

visible

true to make the sash visible, false to make it invisible.

see also

wxsashwindow::getsashvisible

wxsashwindow::setsashborder

void setsashborder(wxsashedgeposition edge, bool hasborder)

call this function to give the sash a border, or remove the border. this function is obsolete since the sash border property is unused.

parameters

edge

edge to change. one of wxsash_top, wxsash_right, wxsash_bottom, wxsash_left.

hasborder

true to give the sash a border visible, false to remove it.

see also

wxsashwindow::hasborder