X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/56eee37fc87921c9de3396cbfac78c58a42b2033..3694bb76c11d1ed1518f20a42f8907c948e190bd:/docs/latex/wx/sizeritem.tex diff --git a/docs/latex/wx/sizeritem.tex b/docs/latex/wx/sizeritem.tex index 28c427efb4..6573448b8c 100644 --- a/docs/latex/wx/sizeritem.tex +++ b/docs/latex/wx/sizeritem.tex @@ -2,9 +2,10 @@ \section{\class{wxSizerItem}}\label{wxsizeritem} The wxSizerItem class is used to track the position, size and other -attributes of each item managed by a \helpref{wxSizer}{wxsizer}. In -normal usage user code should never need to deal directly with a -wxSizerItem, but derived sizer classes will. +attributes of each item managed by a \helpref{wxSizer}{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. \wxheading{Derived from} @@ -15,6 +16,10 @@ wxSizerItem, but derived sizer classes will. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} @@ -26,11 +31,15 @@ wxSizerItem, but derived sizer classes will. Construct a sizer item for tracking a spacer. +\func{}{wxSizerItem}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}} + \func{}{wxSizerItem}{\param{wxWindow* }{window}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}} Construct a sizer item for tracking a window. +\func{}{wxSizerItem}{\param{wxSizer* }{window}, \param{const wxSizerFlags\& }{flags}} + \func{}{wxSizerItem}{\param{wxSizer* }{sizer}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}} Construct a sizer item for tracking a subsizer. @@ -79,6 +88,13 @@ Return the border attribute. Return the flags attribute. +\membersection{wxSizerItem::GetId}\label{wxsizeritemgetid} + +\constfunc{int}{GetId}{\void} + +Return the numeric id of wxSizerItem, or \texttt{wxID\_NONE} if the id has +not been set. + \membersection{wxSizerItem::GetMinSize}\label{wxsizeritemgetminsize} @@ -108,7 +124,7 @@ Get the ration item attribute. \func{wxRect}{GetRect}{\void} -Get the rectangle of the item on the parent window. +Get the rectangle of the item on the parent window, excluding borders. \membersection{wxSizerItem::GetSize}\label{wxsizeritemgetsize} @@ -141,13 +157,7 @@ Get the userData item attribute. \constfunc{wxWindow*}{GetWindow}{\void} -If this item is trackign a window then return it. NULL otherwise. - -\membersection{wxSizerItem::IsShown}\label{wxsizeritemisshown} - -\constfunc{bool}{IsShown}{\void} - -Is this item shown? +If this item is tracking a window then return it. NULL otherwise. \membersection{wxSizerItem::IsSizer}\label{wxsizeritemissizer} @@ -157,6 +167,16 @@ Is this item shown? Is this item a sizer? +\membersection{wxSizerItem::IsShown}\label{wxsizeritemisshown} + +\constfunc{bool}{IsShown}{\void} + +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. + + \membersection{wxSizerItem::IsSpacer}\label{wxsizeritemisspacer} \constfunc{bool}{IsSpacer}{\void} @@ -179,7 +199,7 @@ Set the border item attribute. \membersection{wxSizerItem::SetDimension}\label{wxsizeritemsetdimension} -\func{void}{SetDimension}{\param{wxPoint }{pos}, \param{wxSize }{size}} +\func{void}{SetDimension}{\param{const wxPoint\& }{pos}, \param{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 @@ -192,6 +212,12 @@ taking alignment and borders into account. Set the flag item attribute. +\membersection{wxSizerItem::SetId}\label{wxsizeritemSetId} + +\func{void}{SetId}{\param{int}{id}} + +Sets the numeric id of the wxSizerItem to \arg{id}. + \membersection{wxSizerItem::SetInitSize}\label{wxsizeritemsetinitsize}