docs/latex/wx/gbsizeritem.tex

   1
   2 \section{\class{wxGBSizerItem}}\label{wxgbsizeritem}
   3
   4 The wxGBSizerItem class is used by the
   5 \helpref{wxGridBagSizer}{wxgridbagsizer} for tracking the items in the
   6 sizer. It adds grid position and spanning information to the normal
   7 \helpref{wxSizerItem}{wxsizeritem} by adding
   8 \helpref{wxGBPosition}{wxgbposition} and \helpref{wxGBSpan}{wxgbspan}
   9 attrbibutes. Most of the time you will not need to use a
  10 wxGBSizerItem directly in your code, but there are a couple of cases
  11 where it is handy.
  12
  13 \wxheading{Derived from}
  14
  15 \helpref{wxSizerItem}{wxsizeritem}
  16
  17 \wxheading{Include files}
  18
  19 <wx/gbsizer.h>
  20
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23 \membersection{wxGBSizerItem::wxGBSizerItem}\label{wxgbsizeritemwxgbsizeritem}
  24
  25 \func{}{wxGBSizerItem}{\param{int }{width}, \param{int }{height}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
  26
  27 Construct a sizer item for tracking a spacer.
  28
  29 \func{}{wxGBSizerItem}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
  30
  31 Construct a sizer item for tracking a window.
  32
  33 \func{}{wxGBSizerItem}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
  34
  35 Construct a sizer item for tracking a subsizer.
  36
  37 \membersection{wxGBSizerItem::GetEndPos}\label{wxgbsizeritemgetendpos}
  38
  39 \func{void}{GetEndPos}{\param{int\& }{row}, \param{int\& }{col}}
  40
  41 Get the row and column of the endpoint of this item
  42
  43 \membersection{wxGBSizerItem::GetPos}\label{wxgbsizeritemgetpos}
  44
  45 \constfunc{wxGBPosition}{GetPos}{\void}
  46
  47 \constfunc{void}{GetPos}{\param{int\& }{row}, \param{int\& }{col}}
  48
  49 Get the grid position of the item.
  50
  51 \membersection{wxGBSizerItem::GetSpan}\label{wxgbsizeritemgetspan}
  52
  53 \constfunc{wxGBSpan}{GetSpan}{\void}
  54
  55 \constfunc{void}{GetSpan}{\param{int\& }{rowspan}, \param{int\& }{colspan}}
  56
  57 Get the row and column spanning of the item.
  58
  59 \membersection{wxGBSizerItem::Intersects}\label{wxgbsizeritemintersects}
  60
  61 \func{bool}{Intersects}{\param{const wxGBSizerItem\& }{other}}
  62
  63 Returns true if this item and the other item instersect
  64
  65 \func{bool}{Intersects}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}}
  66
  67 Returns true if the given pos/span would intersect with this item.
  68
  69 \membersection{wxGBSizerItem::SetPos}\label{wxgbsizeritemsetpos}
  70
  71 \func{bool}{SetPos}{\param{const wxGBPosition\& }{pos}}
  72
  73 If the item is already a member of a sizer then first ensure that
  74 there is no other item that would intersect with this one at the new
  75 position, then set the new position. Returns true if the change is
  76 successful and after the next Layout the item will be moved.
  77
  78 \membersection{wxGBSizerItem::SetSpan}\label{wxgbsizeritemsetspan}
  79
  80 \func{bool}{SetSpan}{\param{const wxGBSpan\& }{span}}
  81
  82 If the item is already a member of a sizer then first ensure that
  83 there is no other item that would intersect with this one with its new
  84 spanning size, then set the new spanning. Returns true if the change
  85 is successful and after the next Layout the item will be resized.
  86