]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/sizeritem.tex
document missing default parameters in ctor (patch 1458151)
[wxWidgets.git] / docs / latex / wx / sizeritem.tex
index 28c427efb4091fe3a78d6dc5cb919b77fb746f5d..988cf2f198f728c9c66ccdce365a358e329d8869 100644 (file)
@@ -26,11 +26,15 @@ wxSizerItem, but derived sizer classes will.
 Construct a sizer item for tracking a spacer.
 
 
 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{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.
 \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.
@@ -108,7 +112,7 @@ Get the ration item attribute.
 
 \func{wxRect}{GetRect}{\void}
 
 
 \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}
 
 
 \membersection{wxSizerItem::GetSize}\label{wxsizeritemgetsize}
 
@@ -141,13 +145,7 @@ Get the userData item attribute.
 
 \constfunc{wxWindow*}{GetWindow}{\void}
 
 
 \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}
 
 
 \membersection{wxSizerItem::IsSizer}\label{wxsizeritemissizer}
@@ -157,6 +155,16 @@ Is this item shown?
 Is this item a sizer?
 
 
 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}
 \membersection{wxSizerItem::IsSpacer}\label{wxsizeritemisspacer}
 
 \constfunc{bool}{IsSpacer}{\void}
@@ -179,7 +187,7 @@ Set the border item attribute.
 
 \membersection{wxSizerItem::SetDimension}\label{wxsizeritemsetdimension}
 
 
 \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
 
 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