]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/sizer.tex
Do -> Redo
[wxWidgets.git] / docs / latex / wx / sizer.tex
index 0c5586bf068731481701d811f429f9bf841aafa2..b7d1b8ee4ee898bb89314874d99f6968f65944cc 100644 (file)
@@ -54,11 +54,11 @@ The destructor.
 
 \membersection{wxSizer::Add}\label{wxsizeradd}
 
-\func{void}{Add}{\param{wxWindow* }{window}, \param{int }{option = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+\func{void}{Add}{\param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Add}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+\func{void}{Add}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+\func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
 Adds the {\it window} to the sizer. As wxSizer itself is an abstract class, the parameters
 have no meaning in the wxSizer class itself, but as there currently is only one class
@@ -76,11 +76,11 @@ 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 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
+using the {\it proportion} 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
 the dialog.}
 
-\docparam{option}{Although the meaning of this parameter is undefined in wxSizer, it is used in wxBoxSizer
+\docparam{proportion}{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 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
@@ -93,7 +93,7 @@ using these flags. One is the border around a window: the {\it border}
 parameter determines the border width whereas the flags given here determine
 where the border may be (wxTOP, wxBOTTOM, wxLEFT, wxRIGHT or wxALL). The other
 flags determine the child window's behaviour if the size of the sizer changes.
-However this is not - in contrast to the {\it option} flag - in the main
+However this is not - in contrast to the {\it proportion} flag - in the main
 orientation, but in the respectively other orientation. So if you created a
 wxBoxSizer with the wxVERTICAL option, these flags will be relevant if the
 sizer changes its horizontal size. A child may get resized to completely fill
@@ -106,7 +106,7 @@ in the main orientation using wxALIGN\_CENTER\_VERTICAL (same as
 wxALIGN\_CENTRE\_VERTICAL) and wxALIGN\_CENTER\_HORIZONTAL (same as
 wxALIGN\_CENTRE\_HORIZONTAL) flags. Finally, you can also specify
 wxADJUST\_MINSIZE flag to make the minimal size of the control dynamically adjust
-to the value returned by its \helpref{GetBestSize()}{wxwindowgetbestsize}
+to the value returned by its \helpref{GetAdjustedBestSize()}{wxwindowgetadjustedbestsize}
 method - this allows, for example, for correct relayouting of a static text
 control even if its text is changed during run-time.}
 
@@ -114,7 +114,7 @@ control even if its text is changed during run-time.}
 
 \docparam{userData}{Allows an extra object to be attached to the sizer
 item, for use in derived classes when sizing information is more
-complex than the {\it option} and {\it flag} will allow for.}
+complex than the {\it proportion} and {\it flag} will allow for.}
 
 \membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
 
@@ -125,11 +125,11 @@ 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}
 
@@ -175,11 +175,11 @@ the current dimension.
 
 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
 
-\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+\func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
 
-\func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border= 0}, \param{wxObject* }{userData = NULL}}
+\func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border= 0}, \param{wxObject* }{userData = NULL}}
 
 Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
 list of items (windows, subsizers or spaces) owned by this sizer.
@@ -254,9 +254,18 @@ see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window
 \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.
+minimal size. For windows with managed scrollbars this will set them appropriately.
 
 \wxheading{See also}
 
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
 
+\membersection{wxSizer::Show}\label{wxsizershow}
+
+\func{void}{Show}{\param{wxWindow* }{window}, \param{bool }{show = TRUE}}
+
+\func{void}{Show}{\param{wxSizer* }{sizer}, \param{bool }{show = TRUE}}
+
+Shows or hides a window or sizer. To make a sizer item disappear or 
+reappear, use Show() followed by Layout().
+