docs/latex/wx/sizeritem.tex

   1
   2 \section{\class{wxSizerItem}}\label{wxsizeritem}
   3
   4 The wxSizerItem class is used to track the position, size and other
   5 attributes of each item managed by a \helpref{wxSizer}{wxsizer}.  In
   6 normal usage user code should never need to deal directly with a
   7 wxSizerItem, but derived sizer classes will.
   8
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxObject}{wxobject}
  13
  14 \wxheading{Include files}
  15
  16 <wx/sizer.h>
  17
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21
  22 \membersection{wxSizerItem::wxSizerItem}\label{wxsizeritemwxsizeritem}
  23
  24 \func{}{wxSizerItem}{\param{int }{width}, \param{int }{height}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
  25
  26 Construct a sizer item for tracking a spacer.
  27
  28
  29 \func{}{wxSizerItem}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}
  30
  31 \func{}{wxSizerItem}{\param{wxWindow* }{window}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
  32
  33 Construct a sizer item for tracking a window.
  34
  35
  36 \func{}{wxSizerItem}{\param{wxSizer* }{window}, \param{const wxSizerFlags\& }{flags}}
  37
  38 \func{}{wxSizerItem}{\param{wxSizer* }{sizer}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
  39
  40 Construct a sizer item for tracking a subsizer.
  41
  42
  43
  44 \membersection{wxSizerItem::\destruct{wxSizerItem}}\label{wxsizeritemdtor}
  45
  46 \func{}{\destruct{wxSizerItem}}{\void}
  47
  48 Deletes the user data and subsizer, if any.
  49
  50
  51 \membersection{wxSizerItem::CalcMin}\label{wxsizeritemcalcmin}
  52
  53 \func{wxSize}{CalcMin}{\void}
  54
  55 Calculates the minimum desired size for the item, including any space
  56 needed by borders.
  57
  58
  59 \membersection{wxSizerItem::DeleteWindows}\label{wxsizeritemdeletewindows}
  60
  61 \func{void}{DeleteWindows}{\void}
  62
  63 Destroy the window or the windows in a subsizer, depending on the type
  64 of item.
  65
  66
  67 \membersection{wxSizerItem::DetachSizer}\label{wxsizeritemdetachsizer}
  68
  69 \func{void}{DetachSizer}{\void}
  70
  71 Enable deleting the SizerItem without destroying the contained sizer.
  72
  73
  74 \membersection{wxSizerItem::GetBorder}\label{wxsizeritemgetborder}
  75
  76 \constfunc{int}{GetBorder}{\void}
  77
  78 Return the border attribute.
  79
  80 \membersection{wxSizerItem::GetFlag}\label{wxsizeritemgetflag}
  81
  82 \constfunc{int}{GetFlag}{\void}
  83
  84 Return the flags attribute.
  85
  86
  87 \membersection{wxSizerItem::GetMinSize}\label{wxsizeritemgetminsize}
  88
  89 \constfunc{wxSize}{GetMinSize}{\void}
  90
  91 Get the minimum size needed for the item.
  92
  93 \membersection{wxSizerItem::GetPosition}\label{wxsizeritemgetposition}
  94
  95 \constfunc{wxPoint}{GetPosition}{\void}
  96
  97 What is the current position of the item, as set in the last Layout.
  98
  99 \membersection{wxSizerItem::GetProportion}\label{wxsizeritemgetproportion}
 100
 101 \constfunc{int}{GetProportion}{\void}
 102
 103 Get the proportion item attribute.
 104
 105 \membersection{wxSizerItem::GetRatio}\label{wxsizeritemgetratio}
 106
 107 \constfunc{float}{GetRatio}{\void}
 108
 109 Get the ration item attribute.
 110
 111 \membersection{wxSizerItem::GetRect}\label{wxsizeritemgetrect}
 112
 113 \func{wxRect}{GetRect}{\void}
 114
 115 Get the rectangle of the item on the parent window, excluding borders.
 116
 117 \membersection{wxSizerItem::GetSize}\label{wxsizeritemgetsize}
 118
 119 \constfunc{wxSize}{GetSize}{\void}
 120
 121 Get the current size of the item, as set in the last Layout.
 122
 123 \membersection{wxSizerItem::GetSizer}\label{wxsizeritemgetsizer}
 124
 125 \constfunc{wxSizer*}{GetSizer}{\void}
 126
 127 If this item is tracking a sizer, return it.  NULL otherwise.
 128
 129
 130 \membersection{wxSizerItem::GetSpacer}\label{wxsizeritemgetspacer}
 131
 132 \constfunc{const wxSize\&}{GetSpacer}{\void}
 133
 134 If this item is tracking a spacer, return its size.
 135
 136
 137 \membersection{wxSizerItem::GetUserData}\label{wxsizeritemgetuserdata}
 138
 139 \constfunc{wxObject*}{GetUserData}{\void}
 140
 141 Get the userData item attribute.
 142
 143
 144 \membersection{wxSizerItem::GetWindow}\label{wxsizeritemgetwindow}
 145
 146 \constfunc{wxWindow*}{GetWindow}{\void}
 147
 148 If this item is tracking a window then return it.  NULL otherwise.
 149
 150
 151 \membersection{wxSizerItem::IsSizer}\label{wxsizeritemissizer}
 152
 153 \constfunc{bool}{IsSizer}{\void}
 154
 155 Is this item a sizer?
 156
 157
 158 \membersection{wxSizerItem::IsShown}\label{wxsizeritemisshown}
 159
 160 \constfunc{bool}{IsShown}{\void}
 161
 162 Returns \true if this item is a window or a spacer and it is shown or if this
 163 item is a sizer and not all its elements are hidden. In other words, for sizer
 164 items, all of the child elements must be hidden for the sizer itself to be
 165 considered hidden.
 166
 167
 168 \membersection{wxSizerItem::IsSpacer}\label{wxsizeritemisspacer}
 169
 170 \constfunc{bool}{IsSpacer}{\void}
 171
 172 Is this item a spacer?
 173
 174
 175 \membersection{wxSizerItem::IsWindow}\label{wxsizeritemiswindow}
 176
 177 \constfunc{bool}{IsWindow}{\void}
 178
 179 Is this item a window?
 180
 181
 182 \membersection{wxSizerItem::SetBorder}\label{wxsizeritemsetborder}
 183
 184 \func{void}{SetBorder}{\param{int }{border}}
 185
 186 Set the border item attribute.
 187
 188 \membersection{wxSizerItem::SetDimension}\label{wxsizeritemsetdimension}
 189
 190 \func{void}{SetDimension}{\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size}}
 191
 192 Set the position and size of the space allocated to the sizer, and
 193 adjust the position and size of the item to be within that space
 194 taking alignment and borders into account.
 195
 196
 197 \membersection{wxSizerItem::SetFlag}\label{wxsizeritemsetflag}
 198
 199 \func{void}{SetFlag}{\param{int }{flag}}
 200
 201 Set the flag  item attribute.
 202
 203
 204 \membersection{wxSizerItem::SetInitSize}\label{wxsizeritemsetinitsize}
 205
 206 \func{void}{SetInitSize}{\param{int }{x}, \param{int }{y}}
 207
 208
 209 \membersection{wxSizerItem::SetProportion}\label{wxsizeritemsetproportion}
 210
 211 \func{void}{SetProportion}{\param{int }{proportion}}
 212
 213 Set the proportion item attribute.
 214
 215 \membersection{wxSizerItem::SetRatio}\label{wxsizeritemsetratio}
 216
 217 \func{void}{SetRatio}{\param{int }{width}, \param{int }{height}}
 218
 219 \func{void}{SetRatio}{\param{wxSize }{size}}
 220
 221 \func{void}{SetRatio}{\param{float }{ratio}}
 222
 223 Set the ratio item attribute.
 224
 225
 226 \membersection{wxSizerItem::SetSizer}\label{wxsizeritemsetsizer}
 227
 228 \func{void}{SetSizer}{\param{wxSizer* }{sizer}}
 229
 230 Set the sizer tracked by this item.
 231
 232
 233 \membersection{wxSizerItem::SetSpacer}\label{wxsizeritemsetspacer}
 234
 235 \func{void}{SetSpacer}{\param{const wxSize\& }{size}}
 236
 237 Set the size of the spacer tracked by this item.
 238
 239
 240 \membersection{wxSizerItem::SetWindow}\label{wxsizeritemsetwindow}
 241
 242 \func{void}{SetWindow}{\param{wxWindow* }{window}}
 243
 244 Set the window to be tracked by thsi item.
 245
 246
 247 \membersection{wxSizerItem::Show}\label{wxsizeritemshow}
 248
 249 \func{void}{Show}{\param{bool }{show}}
 250
 251 Set the show item attribute, which sizers use to determine if the item
 252 is to be made part of the layout or not.  If the item is tracking a
 253 window then it is shown or hidden as needed.
 254