docs/latex/wx/gridbagsizer.tex

   1
   2 \section{\class{wxGridBagSizer}}\label{wxgridbagsizer}
   3
   4 A \helpref{wxSizer}{wxsizer} that can lay out items in a virtual grid
   5 like a \helpref{wxFlexGridSizer}{wxflexgridsizer} but in this case
   6 explicit positioning of the items is allowed using
   7 \helpref{wxGBPosition}{wxgbposition}, and items can optionally span
   8 more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
   9
  10
  11 \wxheading{Derived from}
  12
  13 \helpref{wxFlexGridSizer}{wxflexgridsizer}
  14
  15 \wxheading{Include files}
  16
  17 <wx/gbsizer.h>
  18
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22
  23 \membersection{wxGridBagSizer::wxGridBagSizer}\label{wxgridbagsizerwxgridbagsizer}
  24
  25 \func{}{wxGridBagSizer}{\param{int }{vgap = 0}, \param{int }{hgap = 0}}
  26
  27 Constructor, with optional parameters to specify the gap between the
  28 rows and columns.
  29
  30
  31 \membersection{wxGridBagSizer::Add}\label{wxgridbagsizeradd}
  32
  33 \func{bool}{Add}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
  34
  35 \func{bool}{Add}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
  36
  37 \func{bool}{Add}{\param{int }{width}, \param{int }{height}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
  38
  39 \func{bool}{Add}{\param{wxGBSizerItem* }{item}}
  40
  41 The Add methods return true if the item was successfully placed at the
  42 given position, false if something was already there.
  43
  44
  45
  46
  47 \membersection{wxGridBagSizer::CalcMin}\label{wxgridbagsizercalcmin}
  48
  49 \func{wxSize}{CalcMin}{\void}
  50
  51 Called when the managed size of the sizer is needed or when layout
  52 needs done.
  53
  54
  55 \membersection{wxGridBagSizer::CheckForIntersection}\label{wxgridbagsizercheckforintersection}
  56
  57 \func{bool}{CheckForIntersection}{\param{wxGBSizerItem* }{item}, \param{wxGBSizerItem* }{excludeItem = NULL}}
  58
  59 \func{bool}{CheckForIntersection}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{wxGBSizerItem* }{excludeItem = NULL}}
  60
  61 Look at all items and see if any intersect (or would overlap) the given
  62 item.  Returns true if so, false if there would be no overlap.  If an
  63 excludeItem is given then it will not be checked for intersection, for
  64 example it may be the item we are checking the position of.
  65
  66
  67
  68 \membersection{wxGridBagSizer::FindItem}\label{wxgridbagsizerfinditem}
  69
  70 \func{wxGBSizerItem*}{FindItem}{\param{wxWindow* }{window}}
  71
  72 \func{wxGBSizerItem*}{FindItem}{\param{wxSizer* }{sizer}}
  73
  74 Find the sizer item for the given window or subsizer, returns NULL if
  75 not found. (non-recursive)
  76
  77
  78
  79 \membersection{wxGridBagSizer::FindItemAtPosition}\label{wxgridbagsizerfinditematposition}
  80
  81 \func{wxGBSizerItem*}{FindItemAtPosition}{\param{const wxGBPosition\& }{pos}}
  82
  83 Return the sizer item for the given grid cell, or NULL if there is no
  84 item at that position. (non-recursive)
  85
  86
  87
  88 \membersection{wxGridBagSizer::FindItemWithData}\label{wxgridbagsizerfinditemwithdata}
  89
  90 \func{wxGBSizerItem*}{FindItemWithData}{\param{const wxObject* }{userData}}
  91
  92 Return the sizer item that has a matching user data (it only compares
  93 pointer values) or NULL if not found. (non-recursive)
  94
  95
  96
  97 \membersection{wxGridBagSizer::GetEmptyCellSize}\label{wxgridbagsizergetemptycellsize}
  98
  99 \constfunc{wxSize}{GetEmptyCellSize}{\void}
 100
 101 Get the size used for cells in the grid with no item.
 102
 103
 104
 105 \membersection{wxGridBagSizer::GetItemPosition}\label{wxgridbagsizergetitemposition}
 106
 107 \func{wxGBPosition}{GetItemPosition}{\param{wxWindow* }{window}}
 108
 109 \func{wxGBPosition}{GetItemPosition}{\param{wxSizer* }{sizer}}
 110
 111 \func{wxGBPosition}{GetItemPosition}{\param{size\_t }{index}}
 112
 113 Get the grid position of the specified item.
 114
 115
 116
 117 \membersection{wxGridBagSizer::GetItemSpan}\label{wxgridbagsizergetitemspan}
 118
 119 \func{wxGBSpan}{GetItemSpan}{\param{wxWindow* }{window}}
 120
 121 \func{wxGBSpan}{GetItemSpan}{\param{wxSizer* }{sizer}}
 122
 123 \func{wxGBSpan}{GetItemSpan}{\param{size\_t }{index}}
 124
 125 Get the row/col spanning of the specified item
 126
 127
 128
 129 \membersection{wxGridBagSizer::RecalcSizes}\label{wxgridbagsizerrecalcsizes}
 130
 131 \func{void}{RecalcSizes}{\void}
 132
 133 Called when the managed size of the sizer is needed or when layout
 134 needs done.
 135
 136
 137 \membersection{wxGridBagSizer::SetEmptyCellSize}\label{wxgridbagsizersetemptycellsize}
 138
 139 \func{void}{SetEmptyCellSize}{\param{const wxSize\& }{sz}}
 140
 141 Set the size used for cells in the grid with no item.
 142
 143
 144
 145 \membersection{wxGridBagSizer::SetItemPosition}\label{wxgridbagsizersetitemposition}
 146
 147 \func{bool}{SetItemPosition}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}}
 148
 149 \func{bool}{SetItemPosition}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}}
 150
 151 \func{bool}{SetItemPosition}{\param{size\_t }{index}, \param{const wxGBPosition\& }{pos}}
 152
 153 Set the grid position of the specified item.  Returns true on success.
 154 If the move is not allowed (because an item is already there) then
 155 false is returned.
 156
 157
 158
 159 \membersection{wxGridBagSizer::SetItemSpan}\label{wxgridbagsizersetitemspan}
 160
 161 \func{bool}{SetItemSpan}{\param{wxWindow* }{window}, \param{const wxGBSpan\& }{span}}
 162
 163 \func{bool}{SetItemSpan}{\param{wxSizer* }{sizer}, \param{const wxGBSpan\& }{span}}
 164
 165 \func{bool}{SetItemSpan}{\param{size\_t }{index}, \param{const wxGBSpan\& }{span}}
 166
 167 Set the row/col spanning of the specified item. Returns true on
 168 success.  If the move is not allowed (because an item is already there)
 169 then false is returned.
 170
 171
 172