Added a couple of wxPerl notes.

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

diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex
index f39b4aeabc30ee747b12f8927b567725269d62ae..74951d8f52cb92f513a5951e573b8d84e8af9f7d 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -54,16 +54,15 @@ The destructor.
 
 \membersection{wxSizer::Add}\label{wxsizeradd}
 
 
 \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
-deriving directly from wxSizer and this class does not override these methods, the meaning
-of the parameters is described here:
+Appends a child to the sizer.  wxSizer itself is an abstract class, but the parameters are
+equivalent in the derived classes that you will instantiate to use it so they are described
+here:

 
 \docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the
 user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many
 
 \docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the
 user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many


@@ -74,15 +73,15 @@ 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
 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
 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.}
 
 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
 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.}
 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.}


@@ -93,7 +92,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.
 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
 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 +105,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
 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.}
 
 method - this allows, for example, for correct relayouting of a static text
 control even if its text is changed during run-time.}
 


@@ -114,7 +113,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
 
 \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}
 
 
 \membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
 


@@ -123,13 +122,47 @@ complex than the {\it option} and {\it flag} will allow for.}
 This method is abstract and has to be overwritten by any derived class.
 Here, the sizer will do the actual calculation of its children minimal sizes.
 
 This method is abstract and has to be overwritten by any derived class.
 Here, the sizer will do the actual calculation of its children minimal sizes.
 

+\membersection{wxSizer::Detach}\label{wxsizerdetach}
+
+\func{bool}{Detach}{\param{wxWindow* }{window}}
+
+\func{bool}{Detach}{\param{wxSizer* }{sizer}}
+
+\func{bool}{Detach}{\param{size\_t }{index}}
+
+Detach a child from the sizer without destroying it. {\it window} is the window to be
+detached, {\it sizer} is the equivalent sizer and {\it index} 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, call \helpref{wxSizer::Layout}{wxsizerlayout}
+to update the layout "on screen" after detaching a child from the sizer.
+
+Returns true if the child item was found and detached, false otherwise.
+
+\wxheading{See also}
+
+\helpref{wxSizer::Remove}{wxsizerremove}
+

 \membersection{wxSizer::Fit}\label{wxsizerfit}
 
 \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
 
 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}
 
 
 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
 


@@ -151,6 +184,20 @@ Returns the minimal size of the sizer. This is either the combined minimal
 size of all the children and their borders or the minimal size set by 
 \helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger.
 
 size of all the children and their borders or the minimal size set by 
 \helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger.
 

+\membersection{wxSizer::Insert}\label{wxsizerinsert}
+
+\func{void}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+
+\func{void}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+
+\func{void}{Insert}{\param{size\_t }{index}, \param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+
+Insert a child into the sizer before any existing item at {\it index}.
+
+\docparam{index}{The position this child should assume in the sizer.}
+
+See \helpref{wxSizer::Add}{wxsizeradd} for the meaning of the other parameters.
+

 \membersection{wxSizer::Layout}\label{wxsizerlayout}
 
 \func{void}{Layout}{\void}
 \membersection{wxSizer::Layout}\label{wxsizerlayout}
 
 \func{void}{Layout}{\void}


@@ -161,11 +208,11 @@ the current dimension.
 
 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
 
 
 \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.
 
 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.


@@ -184,22 +231,27 @@ and sizes.
 
 \func{bool}{Remove}{\param{wxSizer* }{sizer}}
 
 
 \func{bool}{Remove}{\param{wxSizer* }{sizer}}
 

-\func{bool}{Remove}{\param{int }{nth}}
+\func{bool}{Remove}{\param{size\_t }{index}}
+
+Removes a child from the sizer and destroys it.  {\it sizer} is the wxSizer to be removed,
+{\it index} 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, call
+\helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after removing a
+child from the sizer.

 
 

-Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} is the
-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.
+{\bf NB:} The method taking a wxWindow* parameter is deprecated.  For historical reasons
+it does not destroy the window as would usually be expected from Remove.  You should use
+\helpref{wxSizer::Detach}{wxsizerdetach} in new code instead.  There is currently no wxSizer
+method that will both detach and destroy a wxWindow item.

 
 

-Returns TRUE if the child item was found and removed, FALSE otherwise.
+Returns true if the child item was found and removed, false otherwise.

 
 \membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
 
 \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
 
 \membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
 
 \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}
 \helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
 
 \membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}


@@ -220,7 +272,7 @@ bigger.
 
 \func{void}{SetItemMinSize}{\param{wxSizer* }{sizer}, \param{int}{ width}, \param{int}{ height}}
 
 
 \func{void}{SetItemMinSize}{\param{wxSizer* }{sizer}, \param{int}{ width}, \param{int}{ height}}
 

-\func{void}{SetItemMinSize}{\param{int}{ pos}, \param{int}{ width}, \param{int}{ height}}
+\func{void}{SetItemMinSize}{\param{size\_t }{index}, \param{int}{ width}, \param{int}{ height}}

 
 Set an item's minimum size by window, sizer, or position. The item will be found recursively
 in the sizer's descendants. This function enables an application to set the size of an item
 
 Set an item's minimum size by window, sizer, or position. The item will be found recursively
 in the sizer's descendants. This function enables an application to set the size of an item


@@ -230,8 +282,33 @@ after initial creation.
 
 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
 
 
 \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}
+
+\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}}
+
+\func{void}{Show}{\param{size\_t }{index}, \param{bool }{show = true}}
+
+Shows or hides the {\it window}, {\it sizer}, or item at {\it index}.
+To make a sizer item disappear or reappear, use Show() followed by Layout().
+
+Note that this only works with wxBoxSizer and wxFlexGridSizer, since they
+are the only two sizer classes that can size rows/columns independently.