sizer.tex

很牛的GUI源码wxWidgets-2.8.0.zip 可在多种平台下运行.

\section{\class{wxSizer}}\label{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{wxGridSizer}{wxgridsizer} 
\helpref{wxFlexGridSizer}{wxflexgridsizer} and \helpref{wxGridBagSizer}{wxgridbagsizer}.

The layout algorithm used by sizers in wxWidgets 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 be 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 does 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 wxWidgets 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.

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.}

\wxheading{Derived from}

\helpref{wxObject}{wxobject}\\
\helpref{wxClientDataContainer}{wxclientdatacontainer}

\wxheading{Include files}

<wx/sizer.h>

\wxheading{See also}

\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{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}

\func{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}

\func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}}

\func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}

\func{wxSizerItem*}{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.}

\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 \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{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 \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
dependent on the specific kind of sizer used.

\twocolwidtha{5cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxTOP}\\
\windowstyle{wxBOTTOM}\\
\windowstyle{wxLEFT}\\
\windowstyle{wxRIGHT}\\
\windowstyle{wxALL}}{These flags are used to specify which side(s) of
  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.}
\twocolitem{\windowstyle{wxSHAPED}}{The item will be expanded as much
as possible while also maintaining its aspect ratio}
\twocolitem{\windowstyle{wxFIXED\_MINSIZE}}{Normally wxSizers will use 
\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 \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 wxALIGN\_CENTRE}\\
\windowstyle{wxALIGN\_LEFT}\\
\windowstyle{wxALIGN\_RIGHT}\\
\windowstyle{wxALIGN\_TOP}\\
\windowstyle{wxALIGN\_BOTTOM}\\
\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 \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 \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.}

\membersection{wxSizer::AddSpacer}\label{wxsizeraddspacer}

\func{wxSizerItem*}{AddSpacer}{\param{int }{size}}

Adds non-stretchable space to the sizer. More readable way of calling
\helpref{Add}{wxsizeradd}(size, size, 0).


\membersection{wxSizer::AddStretchSpacer}\label{wxsizeraddstretchspacer}

\func{wxSizerItem*}{AddStretchSpacer}{\param{int }{prop = 1}}

Adds stretchable space to the sizer. More readable way of calling
\helpref{Add}{wxsizeradd}(0, 0, prop).


\membersection{wxSizer::CalcMin}\label{wxsizercalcmin}

\func{wxSize}{CalcMin}{\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 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{wxSizer* }{sizer}}

\func{bool}{Detach}{\param{size\_t }{index}}

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.

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 \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.

For a top level window this is the total window size, not client size.


\membersection{wxSizer::FitInside}\label{wxsizerfitinside}

\func{void}{FitInside}{\param{wxWindow* }{window}}

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.

\wxheading{See also}

\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
\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{wxSizer* }{sizer}, \param{bool }{recursive = false}}

\func{wxSizerItem *}{GetItem}{\param{size\_t }{index}}

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.


\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::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{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}

\func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}}

\func{wxSizerItem*}{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{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 \arg{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::InsertSpacer}\label{wxsizerinsertspacer}

\func{wxSizerItem*}{InsertSpacer}{\param{size\_t }{index}, \param{int }{size}}

Inserts non-stretchable space to the sizer. More readable way of calling
\helpref{Insert}{wxsizerinsert}(size, size, 0).


\membersection{wxSizer::InsertStretchSpacer}\label{wxsizerinsertstretchspacer}

\func{wxSizerItem*}{InsertStretchSpacer}{\param{size\_t }{index}, \param{int }{prop = 1}}

Inserts stretchable space to the sizer. More readable way of calling
\helpref{Insert}{wxsizerinsert}(0, 0, prop).