wxsizer

wxsizer is the abstract base class used for laying out subwindows in a window. you cannot use wxsizer directly; instead, you will have to use one of the sizer classes derived from it. currently there are wxboxsizer, wxstaticboxsizer, wxgridsizer wxflexgridsizer and wxgridbagsizer.

the layout algorithm used by sizers in wxwidgets is closely related to layout in other gui toolkits, such as java's awt, the gtk toolkit or the qt toolkit. it is based upon the idea of the individual subwindows reporting their minimal required size and their ability to get stretched if the size of the parent window has changed. this will most often mean that the programmer does not set the original size of a dialog in the beginning, rather the dialog will be assigned a sizer and this sizer will be queried about the recommended size. the sizer in turn will query its children, which can be normal windows, empty space or other sizers, so that a hierarchy of sizers can be constructed. note that wxsizer does not derive from wxwindow and thus does not interfere with tab ordering and requires very little resources compared to a real window on screen.

what makes sizers so well fitted for use in wxwidgets is the fact that every control reports its own minimal size and the algorithm can handle differences in font sizes or different window (dialog item) sizes on different platforms without problems. if e.g. the standard font as well as the overall design of motif widgets requires more space than on windows, the initial dialog size will automatically be bigger on motif than on windows.

sizers may also be used to control the layout of custom drawn items on the window. the add, insert, and prepend functions return a pointer to the newly added wxsizeritem. just add empty space of the desired size and attributes, and then use the wxsizeritem::getrect method to determine where the drawing operations should take place.

please notice that sizers, like child windows, are owned by the library and will be deleted by it which implies that they must be allocated on the heap. however if you create a sizer and do not add it to another sizer or window, the library wouldn't be able to delete such an orphan sizer and in this, and only this, case it should be deleted explicitly.

wxpython note: if you wish to create a sizer class in wxpython you should derive the class from wxpysizer in order to get python-aware capabilities for the various virtual methods.

derived from

wxobject
wxclientdatacontainer

include files

<wx/sizer.h>

see also

sizer overview

members

wxsizer::wxsizer
wxsizer::~wxsizer
wxsizer::add
wxsizer::addspacer
wxsizer::addstretchspacer
wxsizer::calcmin
wxsizer::clear
wxsizer::detach
wxsizer::fit
wxsizer::fitinside
wxsizer::getchildren
wxsizer::getcontainingwindow
wxsizer::getitem
wxsizer::getsize
wxsizer::getposition
wxsizer::getminsize
wxsizer::hide
wxsizer::insert
wxsizer::insertspacer
wxsizer::insertstretchspacer
wxsizer::isshown
wxsizer::layout
wxsizer::prepend
wxsizer::prependspacer
wxsizer::prependstretchspacer
wxsizer::recalcsizes
wxsizer::remove
wxsizer::replace
wxsizer::setdimension
wxsizer::setminsize
wxsizer::setitemminsize
wxsizer::setsizehints
wxsizer::setvirtualsizehints
wxsizer::show

wxsizer::wxsizer

wxsizer()

the constructor. note that wxsizer is an abstract base class and may not be instantiated.

wxsizer::~wxsizer

~wxsizer()

the destructor.

wxsizer::add

wxsizeritem* add(wxwindow* window, const wxsizerflags& flags)

wxsizeritem* add(wxwindow* window, int proportion = 0,int flag = 0, int border = 0, wxobject* userdata = null)

wxsizeritem* add(wxsizer* sizer, const wxsizerflags& flags)

wxsizeritem* add(wxsizer* sizer, int proportion = 0, int flag = 0, int border = 0, wxobject* userdata = null)

wxsizeritem* add(int width, int height, int proportion = 0, int flag = 0, int border = 0, wxobject* userdata = null)

appends a child to the sizer. wxsizer itself is an abstract class, but the parameters are equivalent in the derived classes that you will instantiate to use it so they are described here:

window

the window to be added to the sizer. its initial size (either set explicitly by the user or calculated internally when using wxdefaultsize) is interpreted as the minimal and in many cases also the initial size.

sizer

the (child-)sizer to be added to the sizer. this allows placing a child sizer in a sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several horizontal boxes on the level beneath).

width and height

the dimension of a spacer to be added to the sizer. adding spacers to sizers gives more flexibility in the design of dialogs; imagine for example a horizontal box with two buttons at the bottom of a dialog: you might want to insert a space between the two buttons and make that space stretchable using the proportion flag and the result will be that the left button will be aligned with the left side of the dialog and the right button with the right side - the space in between will shrink and grow with the dialog.

proportion

although the meaning of this parameter is undefined in wxsizer, it is used in wxboxsizer to indicate if a child of a sizer can change its size in the main orientation of the wxboxsizer - where 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other children of the same wxboxsizer. for example, you might have a horizontal wxboxsizer with three children, two of which are supposed to change their size with the sizer. then the two stretchable windows would get a value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.

flag

this parameter can be used to set a number of flags which can be combined using the binary or operator |. two main behaviours are defined using these flags. one is the border around a window: the border parameter determines the border width whereas the flags given here determine which side(s) of the item that the border will be added. the other flags determine how the sizer item behaves when the space allotted to the sizer changes, and is somewhat dependent on the specific kind of sizer used.

wxtop wxbottom wxleft wxright wxall	these flags are used to specify which side(s) of the sizer item the border width will apply to.
wxexpand	the item will be expanded to fill the space assigned to the item.
wxshaped	the item will be expanded as much as possible while also maintaining its aspect ratio
wxfixed_minsize	normally wxsizers will use getadjustedbestsize to determine what the minimal size of window items should be, and will use that size to calculate the layout. this allows layouts to adjust when an item changes and its best size becomes different. if you would rather have a window item stay the size it started with then use wxfixed_minsize.
wxalign_center wxalign_centre wxalign_left wxalign_right wxalign_top wxalign_bottom wxalign_center_vertical wxalign_centre_vertical wxalign_center_horizontal wxalign_centre_horizontal	the wxalign flags allow you to specify the alignment of the item within the space allotted to it by the sizer, adjusted for the border if any.

border

determines the border width, if the flag parameter is set to include any border flag.

userdata

allows an extra object to be attached to the sizer item, for use in derived classes when sizing information is more complex than the proportion and flag will allow for.

flags

a wxsizerflags object that enables you to specify most of the above parameters more conveniently.

wxsizer::addspacer

wxsizeritem* addspacer(int size)

adds non-stretchable space to the sizer. more readable way of calling add(size, size, 0).

wxsizer::addstretchspacer

wxsizeritem* addstretchspacer(int prop = 1)

adds stretchable space to the sizer. more readable way of calling add(0, 0, prop).

wxsizer::calcmin

wxsize calcmin()

this method is abstract and has to be overwritten by any derived class. here, the sizer will do the actual calculation of its children minimal sizes.

wxsizer::clear

void clear(bool delete_windows = false)

detaches all children from the sizer. if delete_windows is true then child windows will also be deleted.

wxsizer::detach

bool detach(wxwindow* window)

bool detach(wxsizer* sizer)

bool detach(size_t index)

detach a child from the sizer without destroying it. window is the window to be detached, sizer is the equivalent sizer and index is the position of the child in the sizer, typically 0 for the first item. this method does not cause any layout or resizing to take place, call wxsizer::layout to update the layout "on screen" after detaching a child from the sizer.

returns true if the child item was found and detached, false otherwise.

see also

wxsizer::remove

wxsizer::fit

wxsize fit(wxwindow* window)

tell the sizer to resize the window to match the sizer's minimal size. this is commonly done in the constructor of the window itself, see sample in the description of wxboxsizer. returns the new size.

for a top level window this is the total window size, not client size.

wxsizer::fitinside

void fitinside(wxwindow* window)

tell the sizer to resize the virtual size of the window to match the sizer's minimal size. this will not alter the on screen size of the window, but may cause the addition/removal/alteration of scrollbars required to view the virtual area in windows which manage it.

see also

wxscrolledwindow::setscrollbars, wxsizer::setvirtualsizehints

wxsizer::getchildren

wxsizeritemlist& getchildren()

returns the list of the items in this sizer. the elements of type-safe wxlist wxsizeritemlist are objects of type wxsizeritem *.

wxsizer::getcontainingwindow

wxwindow * getcontainingwindow() const

returns the window this sizer is used in or null if none.

wxsizer::getitem

wxsizeritem * getitem(wxwindow* window, bool recursive = false)

wxsizeritem * getitem(wxsizer* sizer, bool recursive = false)

wxsizeritem * getitem(size_t index)

finds item of the sizer which holds given window, sizer or is located in sizer at position index. use parameter recursive to search in subsizers too.

returns pointer to item or null.

wxsizer::getsize

wxsize getsize()

returns the current size of the sizer.

wxsizer::getposition

wxpoint getposition()

returns the current position of the sizer.

wxsizer::getminsize

wxsize getminsize()

returns the minimal size of the sizer. this is either the combined minimal size of all the children and their borders or the minimal size set by setminsize, depending on which is bigger.

wxsizer::hide

bool hide(wxwindow* window, bool recursive = false)

bool hide(wxsizer* sizer, bool recursive = false)

bool hide(size_t index)

hides the window, sizer, or item at index. to make a sizer item disappear, use hide() followed by layout(). use parameter recursive to hide elements found in subsizers.

returns true if the child item was found, false otherwise.

see also

wxsizer::isshown, wxsizer::show

wxsizer::insert

wxsizeritem* insert(size_t index, wxwindow* window, const wxsizerflags& flags)

wxsizeritem* insert(size_t index, wxwindow* window, int proportion = 0,int flag = 0, int border = 0, wxobject* userdata = null)

wxsizeritem* insert(size_t index, wxsizer* sizer, const wxsizerflags& flags)

wxsizeritem* insert(size_t index, wxsizer* sizer, int proportion = 0, int flag = 0, int border = 0, wxobject* userdata = null)

wxsizeritem* insert(size_t index, int width, int height, int proportion = 0, int flag = 0, int border = 0, wxobject* userdata = null)

insert a child into the sizer before any existing item at index.

index

the position this child should assume in the sizer.

see wxsizer::add for the meaning of the other parameters.

wxsizer::insertspacer

wxsizeritem* insertspacer(size_t index, int size)

inserts non-stretchable space to the sizer. more readable way of calling insert(size, size, 0).

wxsizer::insertstretchspacer

wxsizeritem* insertstretchspacer(size_t index, int prop = 1)

inserts stretchable space to the sizer. more readable way of calling insert(0, 0, prop).

wxsizer::isshown

bool isshown(wxwindow* window) const

bool isshown(wxsizer* sizer) const

bool isshown(size_t index) const

returns true if the window, sizer, or item at index is shown.

see also

wxsizer::hide, wxsizer::show

wxsizer::layout

void layout()

call this to force layout of the children anew, e.g. after having added a child to or removed a child (window, other sizer or space) from the sizer while keeping the current dimension.

wxsizer::prepend

wxsizeritem* prepend(wxwindow* window, const wxsizerflags& flags)

wxsizeritem* prepend(wxwindow* window, int proportion = 0, int flag = 0, int border = 0, wxobject* userdata = null)

wxsizeritem* prepend(wxsizer* sizer, const wxsizerflags& flags)

wxsizeritem* prepend(wxsizer* sizer, int proportion = 0, int flag = 0, int border = 0, wxobject* userdata = null)

wxsizeritem* prepend(int width, int height, int proportion = 0, int flag = 0, int border= 0, wxobject* userdata = null)

same as wxsizer::add, but prepends the items to the beginning of the list of items (windows, subsizers or spaces) owned by this sizer.

wxsizer::prependspacer

wxsizeritem* prependspacer(int size)

prepends non-stretchable space to the sizer. more readable way of calling prepend(size, size, 0).

wxsizer::prependstretchspacer

wxsizeritem* prependstretchspacer(int prop = 1)

prepends stretchable space to the sizer. more readable way of calling prepend(0, 0, prop).

wxsizer::recalcsizes

void recalcsizes()

this method is abstract and has to be overwritten by any derived class. here, the sizer will do the actual calculation of its children's positions and sizes.

wxsizer::remove

bool remove(wxwindow* window)

bool remove(wxsizer* sizer)

bool remove(size_t index)

removes a child from the sizer and destroys it if it is a sizer or a spacer, but not if it is a window (because windows are owned by their parent window, not the sizer). sizer is the wxsizer to be removed, index is the position of the child in the sizer, e.g. 0 for the first item. this method does not cause any layout or resizing to take place, call wxsizer::layout to update the layout "on screen" after removing a child from the sizer.

nb: the method taking a wxwindow* parameter is deprecated as it does not destroy the window as would usually be expected from remove. you should use wxsizer::detach in new code instead. there is currently no wxsizer method that will both detach and destroy a wxwindow item.

returns true if the child item was found and removed, false otherwise.

wxsizer::replace

bool replace(wxwindow* oldwin, wxwindow* newwin, bool recursive = false)

bool replace(wxsizer* oldsz, wxsizer* newsz, bool recursive = false)

bool remove(size_t oldindex, wxsizeritem* newitem)

detaches the given oldwin, oldsz child from the sizer and replaces it with the given window, sizer, or wxsizeritem.

the detached child is removed only if it is a sizer or a spacer (because windows are owned by their parent window, not the sizer).

use parameter recursive to search the given element recursively in subsizers.

this method does not cause any layout or resizing to take place, call wxsizer::layout to update the layout "on screen" after replacing a child from the sizer.

returns true if the child item was found and removed, false otherwise.

wxsizer::setdimension

void setdimension(int x, int y, int width, int height)

call this to force the sizer to take the given dimension and thus force the items owned by the sizer to resize themselves according to the rules defined by the parameter in the add and prepend methods.

wxsizer::setminsize

void setminsize(int width, int height)

void setminsize(const wxsize& size)

call this to give the sizer a minimal size. normally, the sizer will calculate its minimal size based purely on how much space its children need. after calling this method getminsize will return either the minimal size as requested by its children or the minimal size set here, depending on which is bigger.

wxsizer::setitemminsize

void setitemminsize(wxwindow* window, int width, int height)

void setitemminsize(wxsizer* sizer, int width, int height)

void setitemminsize(size_t index, int width, int height)

set an item's minimum size by window, sizer, or position. the item will be found recursively in the sizer's descendants. this function enables an application to set the size of an item after initial creation.

wxsizer::setsizehints

void setsizehints(wxwindow* window)

this method first calls wxsizer::fit and then setsizehints on the window passed to it. this only makes sense when window is actually a wxtoplevelwindow such as a wxframe or a wxdialog, since setsizehints only has any effect in these classes. it does nothing in normal windows or controls.

this method is commonly invoked in the constructor of a toplevel window itself (see the sample in the description of wxboxsizer) if the toplevel window is resizable.

wxsizer::setvirtualsizehints

void setvirtualsizehints(wxwindow* window)

tell the sizer to set the minimal size of the window virtual area to match the sizer's minimal size. for windows with managed scrollbars this will set them appropriately.

see also

wxscrolledwindow::setscrollbars

wxsizer::show

bool show(wxwindow* window, bool show = true, bool recursive = false)

bool show(wxsizer* sizer, bool show = true, bool recursive = false)

bool show(size_t index, bool show = true)

shows or hides the window, sizer, or item at index. to make a sizer item disappear or reappear, use show() followed by layout(). use parameter recursive to show or hide elements found in subsizers.

returns true if the child item was found, false otherwise.

see also

wxsizer::hide, wxsizer::isshown