+\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{wxSizer* }{sizer}, \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 }{option = 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:
+
+\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 flexilibilty 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
+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
+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 option} 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
+wxAGJUST\_MIN flag to make the minimal size of the control dynamically adjust
+to the value returned by its \helpref{GetBestSize()}{wxwindowgetbestsize}
+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 option} and {\it flag} will allow for.}
projects / wxWidgets.git / blobdiff