docs/latex/wx/sizer.tex

   1 \section{\class{wxSizer}}\label{wxsizer}
   2
   3 wxSizer is the abstract base class used for layouting subwindows in a window. You
   4 cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer}
   5 or \helpref{wxStaticBoxSizer}{wxstaticboxsizer}.
   6
   7 The layouting algorithm used by sizers in wxWindows closely related to layouting
   8 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
   9 based upon the idea of the individual subwindows reporting their minimal required
  10 size and their ability to get stretched if the size of the parent window has changed.
  11 This will most often mean, that the programmer does not set the original size of
  12 the dialog in the beginning, rather the top-most sizer will get queried and it will
  13 then query its children. Its children can be normal windows or other sizers, so that
  14 a hierachy of sizer can be constructed. Note that sizer are not derived from wxWindows
  15 and thus do not interfere with tab ordering and require very little resources compared
  16 to a real window on screen.
  17
  18 What makes sizers so well fitted for use in wxWindows, is the fact that every control
  19 reports its own minimal size and the algorithm can handle differences in font sizes
  20 or different window (dialog item) sizes on different platforms without problems. If e.g.
  21 the standard font as well as the overall design of Motif widgets requires more space than
  22 on Windows, the intial dialog size will automatically be bigger on Motif than on Windows.
  23
  24 \wxheading{Derived from}
  25
  26 \helpref{wxObject}{wxobject}
  27
  28 \latexignore{\rtfignore{\wxheading{Members}}}
  29
  30
  31 \membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
  32
  33 \func{}{wxSizer}{\void}
  34
  35 The constructor. Note that wxSizer is an abstract base class and may not
  36 be instantiated.
  37
  38 \membersection{wxSizer::\destruct{wxSizer}}\label{wxsizerdtor}
  39
  40 \func{}{\destruct{wxSizer}}{\void}
  41
  42 The destructor.
  43
  44 \membersection{wxSizer::Add}\label{wxsizeradd}
  45
  46 \func{void}{Add}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
  47
  48 \func{void}{Add}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
  49
  50 \func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
  51
  52 Adds the {\it window} to the sizer. As wxSizer itself is an abstract class, the parameters
  53 have no meaning in the wxSizer class itself, but as there currently is only one class
  54 deriving directly from wxSizer and this class does not override these methods, the meaning
  55 of the paramters is described here:
  56
  57 \docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the
  58 user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many
  59 cases also the initial size. This is particularly useful in connection with \helpref{SetSizeHint}{wxsizersetsizehints}. }
  60
  61 \docparam{sizer}{The (child-)sizer to be added to the sizer. This allows placing a child sizer in a
  62 sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several
  63 horizontal boxes on the level beneath).}
  64
  65 \docparam{width and height}{The dimension of a spacer to be added to the sizer. Adding spacers to sizers
  66 gives more flexilibilty in the design of dialogs; imagine for example a vertical box with two buttons at the
  67 bottom of a dialog: you might want to insert a space between the two buttons and make that space stretchable
  68 using the {\it option} flag and the result will be that the left button will be aligned with the left
  69 side of the dialog and the right button with the right side - the space in between will shrink and grow with
  70 the dialog.}
  71
  72 \docparam{option}{Although the meaning of this parameter is undefined in wxSizer, it is used in wxBoxSizer
  73 to indicate if a child of a sizer can change its size in the main orientation of the wxBoxSizer - where
  74 0 stands for not changable and a value of more than zero in interpreted relative to the value of other
  75 children of the same wxBoxSizer. You might, e.g., have a horizontal wxBoxSizer with three children, two
  76 of which are supposed to change their size with the sizer, then the two stretchable windows would get a
  77 value of 1 each to make them grow and shrink equally with the sizer's vertical dimension.}
  78
  79 \docparam{flag}{This parameter can be used to set a number of flags which can be combined using
  80 the binary OR operator |. Two main behaviours are defined using these flags: One is the border
  81 around a window: the {\it border} parameter determines the border width whereas the flags given here
  82 determine where the border may be (wxTOP, wxBOTTOM, wxLEFT, wxRIGHT or wxALL). The other flags
  83 determine the child window's behaviour if the size of the sizer changes, but - in contrast to
  84 the {\it option} flag - not in the main orientation, but the respectively other orientation. So
  85 if you created a wxBoxSizer with the wxVERTICAL option, these flags will be relevant if the
  86 sizer changes its horizontal size. A child may get resized to completely fill out the new size (using
  87 either wxGROW or wxEXPAND), may get centered (wxCENTER or wxCENTRE) or may get aligned to either
  88 side (wxALIGN_LEFT and wxALIGN_TOP are set to 0 and thus represent the default, wxALIGN_RIGHT and
  89 wxALIGN_BOTTOM have their obvious meaning.}
  90
  91 \docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.}
  92
  93 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
  94
  95 \func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
  96
  97 \func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
  98
  99 \func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
 100
 101 Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
 102 list of items (windows, subsizers or spaces) owned by this sizer.
 103
 104 \membersection{wxSizer::Remove}\label{wxsizerremove}
 105
 106 \func{bool}{Remove}{\param{wxWindow* }{window}}
 107
 108 \func{bool}{Remove}{\param{wxSizer* }{sizer}}
 109
 110 \func{bool}{Remove}{\param{int }{nth}}
 111
 112 Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} the
 113 equivalent sizer and {\it nth} is the position of the child in the sizer, typically 0 for
 114 the first item. This method does not cause any layouting or resizing to take place and does
 115 not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} for updating
 116 the layout "on screen" after removing a child fom the sizer.
 117
 118 Returns TRUE if the child item was found and removed, FALSE otherwise.
 119
 120 \membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
 121
 122 \func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
 123
 124 Call this to force the sizer to take the given dimension and thus force the items owned
 125 by the sizer to resize themselves according to the rules defined by the paramater in the
 126 \helpref{wxSizer::Add}{wxsizeradd} and \helpref{wxSizer::Prepend}{wxsizerprepend} methods.
 127
 128 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
 129
 130 \func{wxSize}{GetSize}{\void}
 131
 132 Returns the current size of the sizer.
 133
 134 \membersection{wxSizer::GetPosition}\label{wxsizergetposition}
 135
 136 \func{wxPoint}{GetPosition}{\void}
 137
 138 Returns the current position of the sizer.
 139
 140 \membersection{wxSizer::GetMinSize}\label{wxsizergetminsize}
 141
 142 \func{wxSize}{GetMinSize}{\void}
 143
 144 Returns the minimal size of the sizer.
 145
 146 \membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
 147
 148 \func{void}{RecalcSizes}{\void}
 149
 150 This method is abstract and has to be overwritten by any derived class.
 151 Here, the sizer will do the actual calculation of its children's positions
 152 and sizes.
 153
 154 \membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
 155
 156 \func{wxSize}{CalcMin}{\void}
 157
 158 This method is abstract and has to be overwritten by any derived class.
 159 Here, the sizer will do the actual calculation of its children minimal sizes.
 160
 161 \membersection{wxSizer::Layout}\label{wxsizerlayout}
 162
 163 \func{void}{Layout}{\void}
 164
 165 Call this to force laying out the children anew, e.g. after having added a child
 166 to or removed a child (window, other sizer or space) from the sizer while keeping
 167 the current dimension.
 168
 169 \membersection{wxSizer::Fit}\label{wxsizerfit}
 170
 171 \func{void}{Fit}{\param{wxWindow* }{window}}
 172
 173 Tell the sizer to resize the {\it window} to match the sizer's minimal size. This
 174 is commonly done in the constructor of the window itself, see sample in the description
 175 of \helpref{wxBoxSizer}{wxboxsizer}.
 176
 177 \membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints}
 178
 179 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
 180
 181 Tell the sizer to set the minimal size of the {\it window} to match the sizer's minimal size.
 182 This is commonly done in the constructor of the window itself, see sample in the description
 183 of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable (as many dialogs under Unix and
 184 frames on probably all platforms).