wxsizeritem

the wxsizeritem class is used to track the position, size and other attributes of each item managed by a wxsizer. it is not usually necessary to use this class because the sizer elements can also be identified by their positions or window or sizer pointers but sometimes it may be more convenient to use it directly.

derived from

wxobject

include files

<wx/sizer.h>

members

wxsizeritem::wxsizeritem
wxsizeritem::~wxsizeritem
wxsizeritem::calcmin
wxsizeritem::deletewindows
wxsizeritem::detachsizer
wxsizeritem::getborder
wxsizeritem::getflag
wxsizeritem::getminsize
wxsizeritem::getposition
wxsizeritem::getproportion
wxsizeritem::getratio
wxsizeritem::getrect
wxsizeritem::getsize
wxsizeritem::getsizer
wxsizeritem::getspacer
wxsizeritem::getuserdata
wxsizeritem::getwindow
wxsizeritem::issizer
wxsizeritem::isshown
wxsizeritem::isspacer
wxsizeritem::iswindow
wxsizeritem::setborder
wxsizeritem::setdimension
wxsizeritem::setflag
wxsizeritem::setinitsize
wxsizeritem::setproportion
wxsizeritem::setratio
wxsizeritem::setsizer
wxsizeritem::setspacer
wxsizeritem::setwindow
wxsizeritem::show

wxsizeritem::wxsizeritem

wxsizeritem(int width, int height, int proportion, int flag, int border, wxobject* userdata)

construct a sizer item for tracking a spacer.

wxsizeritem(wxwindow* window, const wxsizerflags& flags)

wxsizeritem(wxwindow* window, int proportion, int flag, int border, wxobject* userdata)

construct a sizer item for tracking a window.

wxsizeritem(wxsizer* window, const wxsizerflags& flags)

wxsizeritem(wxsizer* sizer, int proportion, int flag, int border, wxobject* userdata)

construct a sizer item for tracking a subsizer.

wxsizeritem::~wxsizeritem

~wxsizeritem()

deletes the user data and subsizer, if any.

wxsizeritem::calcmin

wxsize calcmin()

calculates the minimum desired size for the item, including any space needed by borders.

wxsizeritem::deletewindows

void deletewindows()

destroy the window or the windows in a subsizer, depending on the type of item.

wxsizeritem::detachsizer

void detachsizer()

enable deleting the sizeritem without destroying the contained sizer.

wxsizeritem::getborder

int getborder() const

return the border attribute.

wxsizeritem::getflag

int getflag() const

return the flags attribute.

wxsizeritem::getminsize

wxsize getminsize() const

get the minimum size needed for the item.

wxsizeritem::getposition

wxpoint getposition() const

what is the current position of the item, as set in the last layout.

wxsizeritem::getproportion

int getproportion() const

get the proportion item attribute.

wxsizeritem::getratio

float getratio() const

get the ration item attribute.

wxsizeritem::getrect

wxrect getrect()

get the rectangle of the item on the parent window, excluding borders.

wxsizeritem::getsize

wxsize getsize() const

get the current size of the item, as set in the last layout.

wxsizeritem::getsizer

wxsizer* getsizer() const

if this item is tracking a sizer, return it. null otherwise.

wxsizeritem::getspacer

const wxsize& getspacer() const

if this item is tracking a spacer, return its size.

wxsizeritem::getuserdata

wxobject* getuserdata() const

get the userdata item attribute.

wxsizeritem::getwindow

wxwindow* getwindow() const

if this item is tracking a window then return it. null otherwise.

wxsizeritem::issizer

bool issizer() const

is this item a sizer?

wxsizeritem::isshown

bool isshown() const

returns true if this item is a window or a spacer and it is shown or if this item is a sizer and not all its elements are hidden. in other words, for sizer items, all of the child elements must be hidden for the sizer itself to be considered hidden.

wxsizeritem::isspacer

bool isspacer() const

is this item a spacer?

wxsizeritem::iswindow

bool iswindow() const

is this item a window?

wxsizeritem::setborder

void setborder(int border)

set the border item attribute.

wxsizeritem::setdimension

void setdimension(const wxpoint& pos, const wxsize& size)

set the position and size of the space allocated to the sizer, and adjust the position and size of the item to be within that space taking alignment and borders into account.

wxsizeritem::setflag

void setflag(int flag)

set the flag item attribute.

wxsizeritem::setinitsize

void setinitsize(int x, int y)

wxsizeritem::setproportion

void setproportion(int proportion)

set the proportion item attribute.

wxsizeritem::setratio

void setratio(int width, int height)

void setratio(wxsize size)

void setratio(float ratio)

set the ratio item attribute.

wxsizeritem::setsizer

void setsizer(wxsizer* sizer)

set the sizer tracked by this item.

wxsizeritem::setspacer

void setspacer(const wxsize& size)

set the size of the spacer tracked by this item.

wxsizeritem::setwindow

void setwindow(wxwindow* window)

set the window to be tracked by thsi item.

wxsizeritem::show

void show(bool show)

set the show item attribute, which sizers use to determine if the item is to be made part of the layout or not. if the item is tracking a window then it is shown or hidden as needed.