Use const

[wxWidgets.git] / docs / latex / wx / sizeritem.tex

diff --git a/docs/latex/wx/sizeritem.tex b/docs/latex/wx/sizeritem.tex
index 725d4694c695ef237bd7afdbbcea41394752869b..f72d03ba39aa09d0474056cb4f7be027ce39acf8 100644 (file)
--- 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
 \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}
 
 
 \wxheading{Derived from}


@@ -15,6 +16,10 @@ wxSizerItem, but derived sizer classes will.
 
 <wx/sizer.h>
 
 
 <wx/sizer.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -26,11 +31,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.


@@ -104,6 +113,12 @@ Get the proportion item attribute.
 
 Get the ration item attribute.
 
 
 Get the ration item attribute.
 

+\membersection{wxSizerItem::GetRect}\label{wxsizeritemgetrect}
+
+\func{wxRect}{GetRect}{\void}
+
+Get the rectangle of the item on the parent window, excluding borders.
+

 \membersection{wxSizerItem::GetSize}\label{wxsizeritemgetsize}
 
 \constfunc{wxSize}{GetSize}{\void}
 \membersection{wxSizerItem::GetSize}\label{wxsizeritemgetsize}
 
 \constfunc{wxSize}{GetSize}{\void}


@@ -135,13 +150,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}


@@ -151,6 +160,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}


@@ -173,7 +192,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