]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/sizer.tex
Patch #581167
[wxWidgets.git] / docs / latex / wx / sizer.tex
index 9d552ff52c5a845d5b1746f14eac96eeafee114f..e052026c43329ca275ad7f9312abfedabc553cfe 100644 (file)
@@ -1,8 +1,11 @@
 \section{\class{wxSizer}}\label{wxsizer}
 
 wxSizer is the abstract base class used for laying out subwindows in a window. You
-cannot use wxSizer directly; instead, you will have to use \helpref{wxBoxSizer}{wxboxsizer}, 
-\helpref{wxStaticBoxSizer}{wxstaticboxsizer} or \helpref{wxNotebookSizer}{wxnotebooksizer}.
+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}.
 
 The layout algorithm used by sizers in wxWindows is closely related to layout
 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
@@ -30,6 +33,10 @@ capabilities for the various virtual methods.}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{See also}
+
+\helpref{Sizer overview}{sizeroverview}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
@@ -67,7 +74,7 @@ sizer and thus to create hierarchies of sizers (typically a vertical box as the
 horizontal boxes on the level beneath).}
 
 \docparam{width and height}{The dimension of a spacer to be added to the sizer. Adding spacers to sizers
-gives more flexilibilty in the design of dialogs; imagine for example a horizontal box with two buttons at the
+gives more flexibility in the design of dialogs; imagine for example a horizontal box with two buttons at the
 bottom of a dialog: you might want to insert a space between the two buttons and make that space stretchable
 using the {\it option} flag and the result will be that the left button will be aligned with the left
 side of the dialog and the right button with the right side - the space in between will shrink and grow with
@@ -75,7 +82,7 @@ the dialog.}
 
 \docparam{option}{Although the meaning of this parameter is undefined in wxSizer, it is used in wxBoxSizer
 to indicate if a child of a sizer can change its size in the main orientation of the wxBoxSizer - where
-0 stands for not changable and a value of more than zero is interpreted relative to the value of other
+0 stands for not changeable and a value of more than zero is interpreted relative to the value of other
 children of the same wxBoxSizer. For example, you might have a horizontal wxBoxSizer with three children, two
 of which are supposed to change their size with the sizer. Then the two stretchable windows would get a
 value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.}
@@ -118,11 +125,25 @@ Here, the sizer will do the actual calculation of its children minimal sizes.
 
 \membersection{wxSizer::Fit}\label{wxsizerfit}
 
-\func{void}{Fit}{\param{wxWindow* }{window}}
+\func{wxSize}{Fit}{\param{wxWindow* }{window}}
 
 Tell the sizer to resize the {\it window} to match the sizer's minimal size. This
 is commonly done in the constructor of the window itself, see sample in the description
-of \helpref{wxBoxSizer}{wxboxsizer}.
+of \helpref{wxBoxSizer}{wxboxsizer}. Returns the new size.
+
+\membersection{wxSizer::FitInside}\label{wxsizerfitinside}
+
+\func{void}{FitInside}{\param{wxWindow* }{window}}
+
+Tell the sizer to resize the virtual size of the {\it window} to match the sizer's
+minimal size.  This will not alter the on screen size of the window, but may cause
+the addition/removal/alteration of scrollbars required to view the virtual area in
+windows which manage it.
+
+\wxheading{See also}
+
+\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
+\helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints}
 
 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
 
@@ -183,7 +204,7 @@ Removes a child from the sizer. {\it window} is the window to be removed, {\it s
 equivalent sizer and {\it nth} is the position of the child in the sizer, typically 0 for
 the first item. This method does not cause any layout or resizing to take place and does
 not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} to update
-the layout "on screen" after removing a child fom the sizer.
+the layout "on screen" after removing a child from the sizer.
 
 Returns TRUE if the child item was found and removed, FALSE otherwise.
 
@@ -192,7 +213,7 @@ Returns TRUE if the child item was found and removed, FALSE otherwise.
 \func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
 
 Call this to force the sizer to take the given dimension and thus force the items owned
-by the sizer to resize themselves according to the rules defined by the paramater in the 
+by the sizer to resize themselves according to the rules defined by the parameter in the 
 \helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
 
 \membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}
@@ -223,8 +244,19 @@ after initial creation.
 
 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
 
-Tell the sizer to set the minimal size of the {\it window} to match the sizer's minimal size.
-This is commonly done in the constructor of the window itself, see sample in the description
-of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable (as are many dialogs under Unix and
-frames on probably all platforms).
+Tell the sizer to set (and \helpref{Fit}{wxsizerfit}) the minimal size of the {\it window} to
+match the sizer's minimal size.  This is commonly done in the constructor of the window itself,
+see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable
+(as are many dialogs under Unix and frames on probably all platforms).
+
+\membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints}
+
+\func{void}{SetVirtualSizeHints}{\param{wxWindow* }{window}}
+
+Tell the sizer to set the minimal size of the {\it window} virtual area to match the sizer's
+minimal size.  For windows with managed scrollbars this will set them appropriately.
+
+\wxheading{See also}
+
+\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}