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.
+Sizers may also be used to control the layout of custom drawn items on the window. The
+Add, Insert, and Prepend functions return a pointer to the newly added wxSizerItem. Just
+add empty space of the desired size and attributes, and then use the wxSizerItem::GetRect
+method to determine where the drawing operations should take place.
+
+
+Please notice that sizers, like child windows, are owned by the library and
+will be deleted by it which implies that they must be allocated on the heap.
+However if you create a sizer and do not add it to another sizer or window, the
+library wouldn't be able to delete such an orphan sizer and in this, and only
+this, case it should be deleted explicitly.
+
\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.}
\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}.}
+cases also the initial size.}
\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
\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
+using the \arg{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{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
+window: the \arg{border} parameter determines the border width whereas
the flags given here determine which side(s) of the item that the
border will be added. The other flags determine how the sizer item
behaves when the space allotted to the sizer changes, and is somewhat
\windowstyle{wxLEFT}\\
\windowstyle{wxRIGHT}\\
\windowstyle{wxALL}}{These flags are used to specify which side(s) of
- the sizer item the {\it border} width will apply to. }
+ the sizer item the \arg{border} width will apply to. }
\twocolitem{\windowstyle{wxEXPAND}}{The item will be expanded to fill
the space assigned to the item.}
\helpref{GetAdjustedBestSize}{wxwindowgetadjustedbestsize} to
determine what the minimal size of window items should be, and will
use that size to calculate the layout. This allows layouts to
-adjust when an item changes and its {\it best size} becomes
+adjust when an item changes and its \arg{best size} becomes
different. If you would rather have a window item stay the size it
started with then use wxFIXED\_MINSIZE.}
-\twocolitem{\windowstyle{wxALIGN\_CENTER}\\
+\twocolitem{\windowstyle{wxALIGN\_CENTER wxALIGN\_CENTRE}\\
\windowstyle{wxALIGN\_LEFT}\\
\windowstyle{wxALIGN\_RIGHT}\\
\windowstyle{wxALIGN\_TOP}\\
\windowstyle{wxALIGN\_BOTTOM}\\
-\windowstyle{wxALIGN\_CENTER\_VERTICAL}\\
-\windowstyle{wxALIGN\_CENTER\_HORIZONTAL}}{The wxALIGN flags allow you to
+\windowstyle{wxALIGN\_CENTER\_VERTICAL wxALIGN\_CENTRE\_VERTICAL}\\
+\windowstyle{wxALIGN\_CENTER\_HORIZONTAL wxALIGN\_CENTRE\_HORIZONTAL}}{The wxALIGN flags allow you to
specify the alignment of the item within the space allotted to it by
the sizer, adjusted for the border if any.}
\end{twocollist}
}
-\docparam{border}{Determines the border width, if the {\it flag}
+\docparam{border}{Determines the border width, if the \arg{flag}
parameter is set to include any border flag.}
\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.}
+complex than the \arg{proportion} and \arg{flag} will allow for.}
\docparam{flags}{A \helpref{wxSizerFlags}{wxsizerflags} object that
enables you to specify most of the above parameters more conveniently.}
Here, the sizer will do the actual calculation of its children minimal sizes.
+\membersection{wxSizer::Clear}\label{wxsizerclear}
+
+\func{void}{Clear}{\param{bool }{delete\_windows = false}}
+
+Detaches all children from the sizer. If \arg{delete\_windows} is \true then child windows will also be deleted.
+
+
\membersection{wxSizer::Detach}\label{wxsizerdetach}
\func{bool}{Detach}{\param{wxWindow* }{window}}
\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
+Detach a child from the sizer without destroying it. \arg{window} is the window to be
+detached, \arg{sizer} is the equivalent sizer and \arg{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{wxSize}{Fit}{\param{wxWindow* }{window}}
-Tell the sizer to resize the {\it window} to match the sizer's minimal size. This
+Tell the sizer to resize the \arg{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.
\func{void}{FitInside}{\param{wxWindow* }{window}}
-Tell the sizer to resize the virtual size of the {\it window} to match the sizer's
+Tell the sizer to resize the virtual size of the \arg{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.
\helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints}
+\membersection{wxSizer::GetChildren}\label{wxsizergetchildren}
+
+\func{wxSizerItemList\&}{GetChildren}{\void}
+
+Returns the list of the items in this sizer. The elements of type-safe
+\helpref{wxList}{wxlist} \texttt{wxSizerItemList} are objects of type
+\helpref{wxSizerItem *}{wxsizeritem}.
+
+
+\membersection{wxSizer::GetContainingWindow}\label{wxsizergetcontainingwindow}
+
+\constfunc{wxWindow *}{GetContainingWindow}{\void}
+
+Returns the window this sizer is used in or \NULL if none.
+
+
\membersection{wxSizer::GetItem}\label{wxsizergetitem}
\func{wxSizerItem *}{GetItem}{\param{wxWindow* }{window}, \param{bool }{recursive = false}}
\func{wxSizerItem *}{GetItem}{\param{size\_t }{index}}
-Finds item of the sizer which holds given {\it window}, {\it sizer} or is located
-in sizer at position {\it index}.
-Use parameter {\it recursive} to search in subsizers too.
+Finds item of the sizer which holds given \arg{window}, \arg{sizer} or is located
+in sizer at position \arg{index}.
+Use parameter \arg{recursive} to search in subsizers too.
Returns pointer to item or NULL.
\helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger.
+\membersection{wxSizer::Hide}\label{wxsizerhide}
+
+\func{bool}{Hide}{\param{wxWindow* }{window}, \param{bool }{recursive = false}}
+
+\func{bool}{Hide}{\param{wxSizer* }{sizer}, \param{bool }{recursive = false}}
+
+\func{bool}{Hide}{\param{size\_t }{index}}
+
+Hides the \arg{window}, \arg{sizer}, or item at \arg{index}.
+To make a sizer item disappear, use Hide() followed by \helpref{Layout()}{wxsizerlayout}.
+Use parameter \arg{recursive} to hide elements found in subsizers.
+
+Returns \true if the child item was found, \false otherwise.
+
+\wxheading{See also}
+
+\helpref{wxSizer::IsShown}{wxsizerisshown},\rtfsp
+\helpref{wxSizer::Show}{wxsizershow}
+
+
\membersection{wxSizer::Insert}\label{wxsizerinsert}
\func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}
\func{wxSizerItem*}{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}.
+Insert a child into the sizer before any existing item at \arg{index}.
\docparam{index}{The position this child should assume in the sizer.}
\helpref{Insert}{wxsizerinsert}(0, 0, prop).
+\membersection{wxSizer::IsShown}\label{wxsizerisshown}
+
+\constfunc{bool}{IsShown}{\param{wxWindow* }{window}}
+
+\constfunc{bool}{IsShown}{\param{wxSizer* }{sizer}}
+
+\constfunc{bool}{IsShown}{\param{size\_t }{index}}
+
+Returns \true if the \arg{window}, \arg{sizer}, or item at \arg{index} is shown.
+
+\wxheading{See also}
+
+\helpref{wxSizer::Hide}{wxsizerhide},\rtfsp
+\helpref{wxSizer::Show}{wxsizershow}
+
+
\membersection{wxSizer::Layout}\label{wxsizerlayout}
\func{void}{Layout}{\void}
\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.
+Removes a child from the sizer and destroys it if it is a sizer or a spacer,
+but not if it is a window (because windows are owned by their parent window,
+not the sizer). \arg{sizer} is the wxSizer to be removed,
+\arg{index} is the position of the child in the sizer, e.g. $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.
+{\bf NB:} The method taking a wxWindow* parameter is deprecated as 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::Replace}\label{wxsizerreplace}
+
+\func{bool}{Replace}{\param{wxWindow* }{oldwin}, \param{wxWindow* }{newwin}, \param{bool }{recursive = false}}
+
+\func{bool}{Replace}{\param{wxSizer* }{oldsz}, \param{wxSizer* }{newsz}, \param{bool }{recursive = false}}
+
+\func{bool}{Remove}{\param{size\_t }{oldindex}, \param{wxSizerItem* }{newitem}}
+
+Detaches the given \arg{oldwin}, \arg{oldsz} child from the sizer and
+replaces it with the given window, sizer, or wxSizerItem.
+
+The detached child is removed {\bf only} if it is a sizer or a spacer
+(because windows are owned by their parent window, not the sizer).
+
+Use parameter \arg{recursive} to search the given element recursively in subsizers.
+
+
+This method does not cause any layout or resizing to take place, call
+\helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after replacing a
+child from the sizer.
Returns true if the child item was found and removed, false otherwise.
\func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
-\func{void}{SetMinSize}{\param{wxSize }{size}}
+\func{void}{SetMinSize}{\param{const 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
\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).
+This method first calls \helpref{wxSizer::Fit}{wxsizerfit} and then
+\helpref{SetSizeHints}{wxtoplevelwindowsetsizehints} on the {\it window}
+passed to it. This only makes sense when {\it window} is actually a
+\helpref{wxTopLevelWindow}{wxtoplevelwindow} such as a wxFrame or a
+wxDialog, since SetSizeHints only has any effect in these classes.
+It does nothing in normal windows or controls.
+This method is commonly invoked in the constructor of a toplevel window itself
+(see the sample in the description of \helpref{wxBoxSizer}{wxboxsizer}) if the
+toplevel window is resizable.
\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
+Tell the sizer to set the minimal size of the \arg{window} virtual area to match the sizer's
minimal size. For windows with managed scrollbars this will set them appropriately.
\wxheading{See also}
\func{bool}{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().
-Use parameter {\it recursive} to show or hide elements found in subsizers.
+Shows or hides the \arg{window}, \arg{sizer}, or item at \arg{index}.
+To make a sizer item disappear or reappear, use Show() followed by \helpref{Layout()}{wxsizerlayout}.
+Use parameter \arg{recursive} to show or hide elements found in subsizers.
Returns true if the child item was found, false otherwise.
-Note that this only works with wxBoxSizer and wxFlexGridSizer, since they
-are the only two sizer classes that can size rows/columns independently.
+\wxheading{See also}
+
+\helpref{wxSizer::Hide}{wxsizerhide},\rtfsp
+\helpref{wxSizer::IsShown}{wxsizerisshown}
\section{\class{wxSizerFlags}}\label{wxsizerflags}
-PRELIMINARY.
+Normally, when you add an item to a sizer via
+\helpref{wxSizer::Add}{wxsizeradd}, you have to specify a lot of flags and
+parameters which can be unwieldy. This is where wxSizerFlags comes in: it
+allows you to specify all parameters using the named methods instead. For
+example, instead of
+
+\begin{verbatim}
+ sizer->Add(ctrl, 0, wxEXPAND | wxBORDER, 10);
+\end{verbatim}
-Normally, when you add something to a sizer via \helpref{wxSizer::Add}{wxsizeradd}, you have to specify a lot of flags and parameters. This can be unwieldy.
+you can now write
-This is where wxSizerFlags comes in. Instead of a bunch of flags and other stuff, you can use wxSizerFlags, which is a convenient class for doing so.
+\begin{verbatim}
+ sizer->Add(ctrl, wxSizerFlags().Expand().Border(10));
+\end{verbatim}
-Note that by specification, all methods of wxSizerFlags return the wxSizerFlags object itself to ease the calling of multiple methods at a time.
+This is more readable and also allows you to create wxSizerFlags objects which
+can be reused for several sizer items.
+\begin{verbatim}
+ wxSizerFlags flagsExpand(1);
+ flagsExpand.Expand().Border(10);
+
+ sizer->Add(ctrl1, flagsExpand);
+ sizer->Add(ctrl2, flagsExpand);
+\end{verbatim}
+
+Note that by specification, all methods of wxSizerFlags return the wxSizerFlags
+object itself to allowing chaining multiple methods calls like in the examples
+above.
\membersection{wxSizerFlags::wxSizerFlags}\label{wxsizerflagsctor}
\func{}{wxSizerFlags}{\param{int }{proportion = 0}}
-Creates the wxSizer with the proportion specified by \tt{proportion}.
+Creates the wxSizer with the proportion specified by \arg{proportion}.
\membersection{wxSizerFlags::Align}\label{wxsizerflagsalign}
\func{wxSizerFlags\& }{Align}{\param{int }{align = 0}}
-Sets the alignment of this wxSizerFlags to \tt{align}.
+Sets the alignment of this wxSizerFlags to \arg{align}.
Note that if this method is not called, the wxSizerFlags has no specified alignment.
\wxheading{See also}
+\helpref{Top}{wxsizerflagstop},\\
\helpref{Left}{wxsizerflagsleft},\\
\helpref{Right}{wxsizerflagsright},\\
+\helpref{Bottom}{wxsizerflagsbottom},\\
\helpref{Centre}{wxsizerflagscentre}
\func{wxSizerFlags\& }{Border}{\param{int }{direction}, \param{int }{borderinpixels}}
-Sets the wxSizerFlags to have a border of a number of pixels specified by \tt{borderinpixels} with the directions specified by \tt{direction}.
-
\func{wxSizerFlags\& }{Border}{\param{int }{direction = wxALL}}
-Sets the wxSizerFlags to have a border of a default size with the directions specified by \tt{direction}.
+Sets the wxSizerFlags to have a border of a number of pixels specified by
+\arg{borderinpixels} with the directions specified by \arg{direction}.
+
+In the overloaded version without \arg{borderinpixels} parameter, the border of
+default size, as returned by \helpref{GetDefaultBorder}{wxsizerflagsgetdefaultborder},
+is used.
+
+
+\membersection{wxSizerFlags::Bottom}\label{wxsizerflagsbottom}
+
+\func{wxSizerFlags\& }{Bottom}{\void}
+
+Aligns the object to the bottom, shortcut for \texttt{Align(wxALIGN\_BOTTOM)}
+
+\wxheading{See also}
+
+\helpref{Align}{wxsizerflagsalign}
\membersection{wxSizerFlags::Center}\label{wxsizerflagscenter}
\helpref{wxSizerFlags::Center}{wxsizerflagscenter} for people with the other dialect of english.
+\membersection{wxSizerFlags::DoubleBorder}\label{wxsizerflagsdoubleborder}
+
+\func{wxSizerFlags\& }{DoubleBorder}{\param{int }{direction = wxALL}}
+
+Sets the border in the given \arg{direction} having twice the default border
+size.
+
+
+\membersection{wxSizerFlags::DoubleHorzBorder}\label{wxsizerflagsdoublehorzborder}
+
+\func{wxSizerFlags\& }{DoubleHorzBorder}{\void}
+
+Sets the border in left and right directions having twice the default border
+size.
+
+
\membersection{wxSizerFlags::Expand}\label{wxsizerflagsexpand}
\func{wxSizerFlags\& }{Expand}{\void}
Sets the object of the wxSizerFlags to expand to fill as much area as it can.
+\membersection{wxSizerFlags::GetDefaultBorder}\label{wxsizerflagsgetdefaultborder}
+
+\func{static int}{GetDefaultBorder}{\void}
+
+Returns the border used by default in \helpref{Border}{wxsizerflagsborder} method.
+
+
\membersection{wxSizerFlags::Left}\label{wxsizerflagsleft}
\func{wxSizerFlags\& }{Left}{\void}
\helpref{Align}{wxsizerflagsalign}
+\membersection{wxSizerFlags::FixedMinSize}\label{wxsizerflagsfixedminsize}
+
+\func{wxSizerFlags\& }{FixedMinSize}{\void}
+
+Set the \texttt{wxFIXED\_MINSIZE} flag which indicates that the initial size of
+the window should be also set as its minimal size.
+
+
\membersection{wxSizerFlags::Proportion}\label{wxsizerflagsproportion}
\func{wxSizerFlags\& }{Proportion}{\param{int }{proportion = 0}}
-Sets the proportion of this wxSizerFlags to \tt{proportion}
+Sets the proportion of this wxSizerFlags to \arg{proportion}
\membersection{wxSizerFlags::Right}\label{wxsizerflagsright}
\helpref{Align}{wxsizerflagsalign}
+
+\membersection{wxSizerFlags::Shaped}\label{wxsizerflagsshaped}
+
+\func{wxSizerFlags\& }{Shaped}{\void}
+
+Set the \texttt{wx\_SHAPED} flag which indicates that the elements should
+always keep the fixed width to height ratio equal to its original value.
+
+
+\membersection{wxSizerFlags::Top}\label{wxsizerflagstop}
+
+\func{wxSizerFlags\& }{Top}{\void}
+
+Aligns the object to the top, shortcut for \texttt{Align(wxALIGN\_TOP)}
+
+\wxheading{See also}
+
+\helpref{Align}{wxsizerflagsalign}
+
+
+\membersection{wxSizerFlags::TripleBorder}\label{wxsizerflagstriplebleborder}
+
+\func{wxSizerFlags\& }{TripleBorder}{\param{int }{direction = wxALL}}
+
+Sets the border in the given \arg{direction} having thrice the default border
+size.
+
+
projects / wxWidgets.git / blobdiff