fix LaTeX error (escape underscores); don't abuse bold face

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

diff --git a/docs/latex/wx/sizeritem.tex b/docs/latex/wx/sizeritem.tex
index 745b5964eabd52d345c8d8812770f92fc3e49eb7..6573448b8cc22d78a774368ebcaceba9f35fd7fe 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
-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.
 
 <wx/sizer.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -83,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}
 
@@ -147,12 +159,6 @@ Get the userData item attribute.
 
 If this item is tracking a window then return it.  NULL otherwise.
 
-\membersection{wxSizerItem::IsShown}\label{wxsizeritemisshown}
-
-\constfunc{bool}{IsShown}{\void}
-
-Is this item shown?
-
 
 \membersection{wxSizerItem::IsSizer}\label{wxsizeritemissizer}
 
@@ -161,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}
@@ -183,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
@@ -196,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}