]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/sizer.tex
First step in background erase optimization
[wxWidgets.git] / docs / latex / wx / sizer.tex
index 984889707be1e1ee3ff9328e1820b84a85506b2d..4c0c69cf1a1d3781a4c90f935bcb47f7540ae09c 100644 (file)
@@ -4,22 +4,22 @@ wxSizer is the abstract base class used for laying out subwindows in a window. Y
 cannot use wxSizer directly; instead, you will have to use one of the sizer
 classes derived from it. Currently there are \helpref{wxBoxSizer}{wxboxsizer}, 
 \helpref{wxStaticBoxSizer}{wxstaticboxsizer},
-\helpref{wxNotebookSizer}{wxnotebooksizer}, \helpref{wxGridSizer}{wxgridsizer} 
-and \helpref{wxFlexGridSizer}{wxflexgridsizer}.
+\helpref{wxGridSizer}{wxgridsizer} 
+\helpref{wxFlexGridSizer}{wxflexgridsizer} and \helpref{wxGridBagSizer}{wxgridbagsizer}.
 
-The layout algorithm used by sizers in wxWindows is closely related to layout
+The layout algorithm used by sizers in wxWidgets is closely related to layout
 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
 based upon the idea of the individual subwindows reporting their minimal required
 size and their ability to get stretched if the size of the parent window has changed.
-This will most often mean, that the programmer does not set the original size of
-a dialog in the beginning, rather the dialog will assigned a sizer and this sizer
+This will most often mean that the programmer does not set the original size of
+a dialog in the beginning, rather the dialog will be assigned a sizer and this sizer
 will be queried about the recommended size. The sizer in turn will query its
 children, which can be normal windows, empty space or other sizers, so that
 a hierarchy of sizers can be constructed. Note that wxSizer does not derive from wxWindow
-and thus do not interfere with tab ordering and requires very little resources compared
+and thus does not interfere with tab ordering and requires very little resources compared
 to a real window on screen.
 
-What makes sizers so well fitted for use in wxWindows is the fact that every control
+What makes sizers so well fitted for use in wxWidgets is the fact that every control
 reports its own minimal size and the algorithm can handle differences in font sizes
 or different window (dialog item) sizes on different platforms without problems. If e.g.
 the standard font as well as the overall design of Motif widgets requires more space than
@@ -31,7 +31,8 @@ capabilities for the various virtual methods.}
 
 \wxheading{Derived from}
 
-\helpref{wxObject}{wxobject}
+\helpref{wxObject}{wxobject}\\
+\helpref{wxClientDataContainer}{wxclientdatacontainer}
 
 \wxheading{See also}
 
@@ -107,17 +108,17 @@ dependent on the specific kind of sizer used.
 \windowstyle{wxALL}}{These flags are used to specify which side(s) of
   the sizer item the {\it border} width will apply to. }
 
-\twocolitem{\windowstyle{wxEXAPAND}}{The item will be expanded to fill
-the space allotted to the item.}
+\twocolitem{\windowstyle{wxEXPAND}}{The item will be expanded to fill
+the space assigned to the item.}
 \twocolitem{\windowstyle{wxSHAPED}}{The item will be expanded as much
 as possible while also maintaining its aspect ratio}
-\twocolitem{\windowstyle{wxFIXED\_MINSIZE}}{Normally wxSizers will use
-  \helpref{GetAdjustedBestSize}{wxwindowgetadjustedbestsize} to
-  determin what the minimal size of window items should be, and will
-  use that size to calculate the layout.  This allows layouts to
-  adjust when an item changes and it's {\it best size} becomes
-  different.  If you would rather have a window item stay the size it
-  started with then use wxFIXED\_MINSIZE.}
+\twocolitem{\windowstyle{wxFIXED\_MINSIZE}}{Normally wxSizers will use 
+\helpref{GetAdjustedBestSize}{wxwindowgetadjustedbestsize} to
+determine what the minimal size of window items should be, and will
+use that size to calculate the layout. This allows layouts to
+adjust when an item changes and its {\it best size} becomes
+different. If you would rather have a window item stay the size it
+started with then use wxFIXED\_MINSIZE.}
 \twocolitem{\windowstyle{wxALIGN\_CENTER}\\
 \windowstyle{wxALIGN\_LEFT}\\
 \windowstyle{wxALIGN\_RIGHT}\\
@@ -125,8 +126,8 @@ as possible while also maintaining its aspect ratio}
 \windowstyle{wxALIGN\_BOTTOM}\\
 \windowstyle{wxALIGN\_CENTER\_VERTICAL}\\
 \windowstyle{wxALIGN\_CENTER\_HORIZONTAL}}{The wxALIGN flags allow you to
-  specify the alignment of the item within the space allotted to it by
-  the sizer, ajusted for the border if any.}
+specify the alignment of the item within the space allotted to it by
+the sizer, adjusted for the border if any.}
 \end{twocollist}
 }
 
@@ -138,6 +139,22 @@ item, for use in derived classes when sizing information is more
 complex than the {\it proportion} and {\it flag} will allow for.}
 
 
+\membersection{wxSizer::AddSpacer}\label{wxsizeraddspacer}
+
+\func{void}{AddSpacer}{\param{int }{size}}
+
+Adds non-stretchable space to the sizer. More readable way of calling
+\helpref{Add}{wxsizeradd}(size, size, 0).
+
+
+\membersection{wxSizer::AddStretchSpacer}\label{wxsizeraddstretchspacer}
+
+\func{void}{AddStretchSpacer}{\param{int }{prop = 1}}
+
+Adds stretchable space to the sizer. More readable way of calling
+\helpref{Add}{wxsizeradd}(0, 0, prop).
+
+
 \membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
 
 \func{wxSize}{CalcMin}{\void}
@@ -231,6 +248,22 @@ Insert a child into the sizer before any existing item at {\it index}.
 See \helpref{wxSizer::Add}{wxsizeradd} for the meaning of the other parameters.
 
 
+\membersection{wxSizer::InsertSpacer}\label{wxsizerinsertspacer}
+
+\func{void}{InsertSpacer}{\param{size\_t }{index}, \param{int }{size}}
+
+Inserts non-stretchable space to the sizer. More readable way of calling
+\helpref{Insert}{wxsizerinsert}(size, size, 0).
+
+
+\membersection{wxSizer::InsertStretchSpacer}\label{wxsizerinsertstretchspacer}
+
+\func{void}{InsertStretchSpacer}{\param{size\_t }{index}, \param{int }{prop = 1}}
+
+Inserts stretchable space to the sizer. More readable way of calling
+\helpref{Insert}{wxsizerinsert}(0, 0, prop).
+
+
 \membersection{wxSizer::Layout}\label{wxsizerlayout}
 
 \func{void}{Layout}{\void}
@@ -252,6 +285,22 @@ Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginn
 list of items (windows, subsizers or spaces) owned by this sizer.
 
 
+\membersection{wxSizer::PrependSpacer}\label{wxsizerprependspacer}
+
+\func{void}{PrependSpacer}{\param{int }{size}}
+
+Prepends non-stretchable space to the sizer. More readable way of calling
+\helpref{Prepend}{wxsizerprepend}(size, size, 0).
+
+
+\membersection{wxSizer::PrependStretchSpacer}\label{wxsizerprependstretchspacer}
+
+\func{void}{PrepentStretchSpacer}{\param{int }{prop = 1}}
+
+Prepends stretchable space to the sizer. More readable way of calling
+\helpref{Prepend}{wxsizerprepend}(0, 0, prop).
+
+
 \membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
 
 \func{void}{RecalcSizes}{\void}