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{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
  30
  31 Construct a sizer item for tracking a window.
  32
  33
  34 \func{}{wxSizerItem}{\param{wxSizer* }{sizer}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
  35
  36 Construct a sizer item for tracking a subsizer.
  37
  38
  39
  40 \membersection{wxSizerItem::\destruct{wxSizerItem}}\label{wxsizeritemdtor}
  41
  42 \func{}{\destruct{wxSizerItem}}{\void}
  43
  44 Deletes the user data and subsizer, if any.
  45
  46
  47 \membersection{wxSizerItem::CalcMin}\label{wxsizeritemcalcmin}
  48
  49 \func{wxSize}{CalcMin}{\void}
  50
  51 Calculates the minimum desired size for the item, including any space
  52 needed by borders.
  53
  54
  55 \membersection{wxSizerItem::DeleteWindows}\label{wxsizeritemdeletewindows}
  56
  57 \func{void}{DeleteWindows}{\void}
  58
  59 Destroy the window or the windows in a subsizer, depending on the type
  60 of item.
  61
  62
  63 \membersection{wxSizerItem::DetachSizer}\label{wxsizeritemdetachsizer}
  64
  65 \func{void}{DetachSizer}{\void}
  66
  67 Enable deleting the SizerItem without destroying the contained sizer.
  68
  69
  70 \membersection{wxSizerItem::GetBorder}\label{wxsizeritemgetborder}
  71
  72 \constfunc{int}{GetBorder}{\void}
  73
  74 Return the border attribute.
  75
  76 \membersection{wxSizerItem::GetFlag}\label{wxsizeritemgetflag}
  77
  78 \constfunc{int}{GetFlag}{\void}
  79
  80 Return the flags attribute.
  81
  82
  83 \membersection{wxSizerItem::GetMinSize}\label{wxsizeritemgetminsize}
  84
  85 \constfunc{wxSize}{GetMinSize}{\void}
  86
  87 Get the minimum size needed for the item.
  88
  89 \membersection{wxSizerItem::GetPosition}\label{wxsizeritemgetposition}
  90
  91 \constfunc{wxPoint}{GetPosition}{\void}
  92
  93 What is the current position of the item, as set in the last Layout.
  94
  95 \membersection{wxSizerItem::GetProportion}\label{wxsizeritemgetproportion}
  96
  97 \constfunc{int}{GetProportion}{\void}
  98
  99 Get the proportion item attribute.
 100
 101 \membersection{wxSizerItem::GetRatio}\label{wxsizeritemgetratio}
 102
 103 \constfunc{float}{GetRatio}{\void}
 104
 105 Get the ration item attribute.
 106
 107 \membersection{wxSizerItem::GetSize}\label{wxsizeritemgetsize}
 108
 109 \constfunc{wxSize}{GetSize}{\void}
 110
 111 Get the current size of the item, as set in the last Layout.
 112
 113 \membersection{wxSizerItem::GetSizer}\label{wxsizeritemgetsizer}
 114
 115 \constfunc{wxSizer*}{GetSizer}{\void}
 116
 117 If this item is tracking a sizer, return it.  NULL otherwise.
 118
 119
 120 \membersection{wxSizerItem::GetSpacer}\label{wxsizeritemgetspacer}
 121
 122 \constfunc{const wxSize\&}{GetSpacer}{\void}
 123
 124 If this item is tracking a spacer, return its size.
 125
 126
 127 \membersection{wxSizerItem::GetUserData}\label{wxsizeritemgetuserdata}
 128
 129 \constfunc{wxObject*}{GetUserData}{\void}
 130
 131 Get the userData item attribute.
 132
 133
 134 \membersection{wxSizerItem::GetWindow}\label{wxsizeritemgetwindow}
 135
 136 \constfunc{wxWindow*}{GetWindow}{\void}
 137
 138 If this item is trackign a window then return it.  NULL otherwise.
 139
 140 \membersection{wxSizerItem::IsShown}\label{wxsizeritemisshown}
 141
 142 \constfunc{bool}{IsShown}{\void}
 143
 144 Is this item shown?
 145
 146
 147 \membersection{wxSizerItem::IsSizer}\label{wxsizeritemissizer}
 148
 149 \constfunc{bool}{IsSizer}{\void}
 150
 151 Is this item a sizer?
 152
 153
 154 \membersection{wxSizerItem::IsSpacer}\label{wxsizeritemisspacer}
 155
 156 \constfunc{bool}{IsSpacer}{\void}
 157
 158 Is this item a spacer?
 159
 160
 161 \membersection{wxSizerItem::IsWindow}\label{wxsizeritemiswindow}
 162
 163 \constfunc{bool}{IsWindow}{\void}
 164
 165 Is this item a window?
 166
 167
 168 \membersection{wxSizerItem::SetBorder}\label{wxsizeritemsetborder}
 169
 170 \func{void}{SetBorder}{\param{int }{border}}
 171
 172 Set the border item attribute.
 173
 174 \membersection{wxSizerItem::SetDimension}\label{wxsizeritemsetdimension}
 175
 176 \func{void}{SetDimension}{\param{wxPoint }{pos}, \param{wxSize }{size}}
 177
 178 Set the position and size of the space allocated to the sizer, and
 179 adjust the position and size of the item to be within that space
 180 taking alignment and borders into account.
 181
 182
 183 \membersection{wxSizerItem::SetFlag}\label{wxsizeritemsetflag}
 184
 185 \func{void}{SetFlag}{\param{int }{flag}}
 186
 187 Set the flag  item attribute.
 188
 189
 190 \membersection{wxSizerItem::SetInitSize}\label{wxsizeritemsetinitsize}
 191
 192 \func{void}{SetInitSize}{\param{int }{x}, \param{int }{y}}
 193
 194
 195 \membersection{wxSizerItem::SetProportion}\label{wxsizeritemsetproportion}
 196
 197 \func{void}{SetProportion}{\param{int }{proportion}}
 198
 199 Set the proportion item attribute.
 200
 201 \membersection{wxSizerItem::SetRatio}\label{wxsizeritemsetratio}
 202
 203 \func{void}{SetRatio}{\param{int }{width}, \param{int }{height}}
 204
 205 \func{void}{SetRatio}{\param{wxSize }{size}}
 206
 207 \func{void}{SetRatio}{\param{float }{ratio}}
 208
 209 Set the ratio item attribute.
 210
 211
 212 \membersection{wxSizerItem::SetSizer}\label{wxsizeritemsetsizer}
 213
 214 \func{void}{SetSizer}{\param{wxSizer* }{sizer}}
 215
 216 Set the sizer tracked by this item.
 217
 218
 219 \membersection{wxSizerItem::SetSpacer}\label{wxsizeritemsetspacer}
 220
 221 \func{void}{SetSpacer}{\param{const wxSize\& }{size}}
 222
 223 Set the size of the spacer tracked by this item.
 224
 225
 226 \membersection{wxSizerItem::SetWindow}\label{wxsizeritemsetwindow}
 227
 228 \func{void}{SetWindow}{\param{wxWindow* }{window}}
 229
 230 Set the window to be tracked by thsi item.
 231
 232
 233 \membersection{wxSizerItem::Show}\label{wxsizeritemshow}
 234
 235 \func{void}{Show}{\param{bool }{show}}
 236
 237 Set the show item attribute, which sizers use to determine if the item
 238 is to be made part of the layout or not.  If the item is tracking a
 239 window then it is shown or hidden as needed.
 240