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 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
  73
  74 \func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
  75
  76 \func{void}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
  77
  78 \func{void}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{option = 0}, \param{int }{flag = 0}, \param{int }{border = 0}}
  79
  80 Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
  81 list of items (windows, subsizers or spaces) owned by this sizer.
  82
  83 \membersection{wxSizer::Remove}\label{wxsizerremove}
  84
  85 \func{bool}{Remove}{\param{wxWindow* }{window}}
  86
  87 \func{bool}{Remove}{\param{wxSizer* }{sizer}}
  88
  89 \func{bool}{Remove}{\param{int }{nth}}
  90
  91 Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} the
  92 equivalent sizer and {\it nth} is the position of the child in the sizer, typically 0 for
  93 the first item. This method does not cause any layouting or resizing to take place and does
  94 not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} for updating
  95 the layout "on screen" after removing a child fom the sizer.
  96
  97 Returns TRUE if the child item was found and removed, FALSE otherwise.
  98
  99 \membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
 100
 101 \func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
 102
 103 Call this to force the sizer to take the given dimension and thus force the items owned
 104 by the sizer to resize themselves according to the rules defined by the paramater in the
 105 \helpref{wxSizer::Add}{wxsizeradd} and \helpref{wxSizer::Prepend}{wxsizerprepend} methods.
 106
 107 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
 108
 109 \func{wxSize}{GetSize}{\void}
 110
 111 Returns the current size of the sizer.
 112
 113 \membersection{wxSizer::GetPosition}\label{wxsizergetposition}
 114
 115 \func{wxPoint}{GetPosition}{\void}
 116
 117 Returns the current position of the sizer.
 118
 119 \membersection{wxSizer::GetMinSize}\label{wxsizergetminsize}
 120
 121 \func{wxSize}{GetMinSize}{\void}
 122
 123 Returns the minimal size of the sizer.
 124
 125 \membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
 126
 127 \func{void}{RecalcSizes}{\void}
 128
 129 This method is abstract and has to be overwritten by any derived class.
 130 Here, the sizer will do the actual calculation of its children's positions
 131 and sizes.
 132
 133 \membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
 134
 135 \func{wxSize}{CalcMin}{\void}
 136
 137 This method is abstract and has to be overwritten by any derived class.
 138 Here, the sizer will do the actual calculation of its children minimal sizes.
 139
 140 \membersection{wxSizer::Layout}\label{wxsizerlayout}
 141
 142 \func{void}{Layout}{\void}
 143
 144 Call this to force laying out the children anew, e.g. after having added a child
 145 to or removed a child (window, other sizer or space) from the sizer while keeping
 146 the current dimension.
 147
 148 \membersection{wxSizer::Fit}\label{wxsizerfit}
 149
 150 \func{void}{Fit}{\param{wxWindow* }{window}}
 151
 152 Tell the sizer to resize the {\it window} to match the sizer's minimal size. This
 153 is commonly done in the constructor of the window itself, see sample in the description
 154 of \helpref{wxBoxSizer}{wxboxsizer}.
 155
 156 \membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints}
 157
 158 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
 159
 160 Tell the sizer to set the minimal size of the {\it window} to match the sizer's minimal size.
 161 This is commonly done in the constructor of the window itself, see sample in the description
 162 of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable (as many dialogs under Unix and
 163 frames on probably all platforms).