-%
-% automatically generated by HelpGen from
-% include\wx\sizer.h at 13/Aug/99 22:27:59
-%
-
-
\section{\class{wxSizer}}\label{wxsizer}
-
-
-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 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
+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
+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
+to a real window on screen.
+
+What makes sizers so well fitted for use in wxWindows 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
+on Windows, the initial dialog size will automatically be bigger on Motif than on Windows.
+
+\pythonnote{If you wish to create a sizer class in wxPython you should
+derive the class from {\tt wxPySizer} in order to get Python-aware
+capabilities for the various virtual methods.}
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
-\wxheading{Data structures}
+\wxheading{See also}
-\latexignore{\rtfignore{\wxheading{Members}}}
+\helpref{Sizer overview}{sizeroverview}
+\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
\func{}{wxSizer}{\void}
+The constructor. Note that wxSizer is an abstract base class and may not
+be instantiated.
\membersection{wxSizer::\destruct{wxSizer}}\label{wxsizerdtor}
\func{}{\destruct{wxSizer}}{\void}
+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}}
+\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 }{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 }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+
+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
+cases also the initial size. This is particularly useful in connection with \helpref{SetSizeHints}{wxsizersetsizehints}.}
+
+\docparam{sizer}{The (child-)sizer to be added to the sizer. This allows placing a child sizer in a
+sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several
+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 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{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
+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.}
+
+\docparam{flag}{This parameter can be used to set a number of flags which can
+be combined using the binary OR operator |. Two main behaviours are defined
+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 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
+out the new size (using either wxGROW or wxEXPAND), it may get proportionally
+resized (wxSHAPED), it may get centered (wxALIGN\_CENTER or wxALIGN\_CENTRE)
+or it may get aligned to either side (wxALIGN\_LEFT and wxALIGN\_TOP are set
+to 0 and thus represent the default, wxALIGN\_RIGHT and wxALIGN\_BOTTOM have
+their obvious meaning). With proportional resize, a child may also be centered
+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{GetAdjustedBestSize()}{wxwindowgetadjustedbestsize}
+method - this allows, for example, for correct relayouting of a static text
+control even if its text is changed during run-time.}
+
+\docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.}
+
+\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 proportion} and {\it flag} will allow for.}
+\membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
-\membersection{wxSizer::Add}\label{wxsizeradd}
+\func{wxSize}{CalcMin}{\void}
-\func{void}{Add}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+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}
-\membersection{wxSizer::Add}\label{wxsizeradd}
+\func{bool}{Detach}{\param{wxWindow* }{window}}
-\func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
+\func{bool}{Detach}{\param{wxSizer* }{sizer}}
+\func{bool}{Detach}{\param{size\_t }{index}}
-\membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
+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.
-\func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
+Returns true if the child item was found and detached, false otherwise.
+
+\wxheading{See also}
+
+\helpref{wxSizer::Remove}{wxsizerremove}
+
+\membersection{wxSizer::Fit}\label{wxsizerfit}
+\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}. 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}
\func{wxSize}{GetSize}{\void}
+Returns the current size of the sizer.
\membersection{wxSizer::GetPosition}\label{wxsizergetposition}
\func{wxPoint}{GetPosition}{\void}
+Returns the current position of the sizer.
\membersection{wxSizer::GetMinSize}\label{wxsizergetminsize}
\func{wxSize}{GetMinSize}{\void}
+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.
-\membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
+\membersection{wxSizer::Insert}\label{wxsizerinsert}
-\func{void}{RecalcSizes}{\void}
+\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}}
-\membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
+\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}}
-\func{wxSize}{CalcMin}{\void}
+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}
+Call this to force layout of the children anew, e.g. after having added a child
+to or removed a child (window, other sizer or space) from the sizer while keeping
+the current dimension.
-\membersection{wxSizer::Fit}\label{wxsizerfit}
+\membersection{wxSizer::Prepend}\label{wxsizerprepend}
+
+\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 }{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 }{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.
-\func{void}{Fit}{\param{wxWindow* }{window}}
+\membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
+
+\func{void}{RecalcSizes}{\void}
+
+This method is abstract and has to be overwritten by any derived class.
+Here, the sizer will do the actual calculation of its children's positions
+and sizes.
+
+\membersection{wxSizer::Remove}\label{wxsizerremove}
+
+\func{bool}{Remove}{\param{wxWindow* }{window}}
+
+\func{bool}{Remove}{\param{wxSizer* }{sizer}}
+
+\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.
+
+{\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.
+
+\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 parameter in the
+\helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
+
+\membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}
+\func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
+
+\func{void}{SetMinSize}{\param{wxSize }{size}}
+
+Call this to give the sizer a minimal size. Normally, the sizer will calculate its
+minimal size based purely on how much space its children need. After calling this
+method \helpref{GetMinSize}{wxsizergetminsize} will return either the minimal size
+as requested by its children or the minimal size set here, depending on which is
+bigger.
+
+\membersection{wxSizer::SetItemMinSize}\label{wxsizersetitemminsize}
+
+\func{void}{SetItemMinSize}{\param{wxWindow* }{window}, \param{int}{ width}, \param{int}{ height}}
+
+\func{void}{SetItemMinSize}{\param{wxSizer* }{sizer}, \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
+after initial creation.
\membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints}
\func{void}{SetSizeHints}{\param{wxWindow* }{window}}
+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}}
-\membersection{wxSizer::GetMinWindowSize}\label{wxsizergetminwindowsize}
+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().
-\func{wxSize}{GetMinWindowSize}{\param{wxWindow* }{window}
\ No newline at end of file
projects / wxWidgets.git / blobdiff