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 \wxheading{Derived from}
  11
  12 \helpref{wxFlexGridSizer}{wxflexgridsizer}\\
  13 \helpref{wxGridSizer}{wxgridsizer}\\
  14 \helpref{wxSizer}{wxsizer}\\
  15 \helpref{wxObject}{wxobject}
  16
  17 \wxheading{Include files}
  18
  19 <wx/gbsizer.h>
  20
  21 \wxheading{Library}
  22
  23 \helpref{wxCore}{librarieslist}
  24
  25 \latexignore{\rtfignore{\wxheading{Members}}}
  26
  27 \membersection{wxGridBagSizer::wxGridBagSizer}\label{wxgridbagsizerwxgridbagsizer}
  28
  29 \func{}{wxGridBagSizer}{\param{int }{vgap = 0}, \param{int }{hgap = 0}}
  30
  31 Constructor, with optional parameters to specify the gap between the
  32 rows and columns.
  33
  34 \membersection{wxGridBagSizer::Add}\label{wxgridbagsizeradd}
  35
  36 \func{wxSizerItem*}{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}}
  37
  38 \func{wxSizerItem*}{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}}
  39
  40 \func{wxSizerItem*}{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}}
  41
  42 \func{wxSizerItem*}{Add}{\param{wxGBSizerItem* }{item}}
  43
  44 The Add methods return a valid pointer if the item was successfully placed at the
  45 given position, NULL if something was already there.
  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 \membersection{wxGridBagSizer::CheckForIntersection}\label{wxgridbagsizercheckforintersection}
  55
  56 \func{bool}{CheckForIntersection}{\param{wxGBSizerItem* }{item}, \param{wxGBSizerItem* }{excludeItem = NULL}}
  57
  58 \func{bool}{CheckForIntersection}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{wxGBSizerItem* }{excludeItem = NULL}}
  59
  60 Look at all items and see if any intersect (or would overlap) the given
  61 item. Returns true if so, false if there would be no overlap. If an
  62 excludeItem is given then it will not be checked for intersection, for
  63 example it may be the item we are checking the position of.
  64
  65 \membersection{wxGridBagSizer::FindItem}\label{wxgridbagsizerfinditem}
  66
  67 \func{wxGBSizerItem*}{FindItem}{\param{wxWindow* }{window}}
  68
  69 \func{wxGBSizerItem*}{FindItem}{\param{wxSizer* }{sizer}}
  70
  71 Find the sizer item for the given window or subsizer, returns NULL if
  72 not found. (non-recursive)
  73
  74 \membersection{wxGridBagSizer::FindItemAtPoint}\label{wxgridbagsizerfinditematpoint}
  75
  76 \func{wxGBSizerItem*}{FindItemAtPoint}{\param{const wxPoint\& }{pt}}
  77
  78 Return the sizer item located at the point given in pt, or NULL if
  79 there is no item at that point. The (x,y) coordinates in pt correspond
  80 to the client coordinates of the window using the sizer for
  81 layout. (non-recursive)
  82
  83 \membersection{wxGridBagSizer::FindItemAtPosition}\label{wxgridbagsizerfinditematposition}
  84
  85 \func{wxGBSizerItem*}{FindItemAtPosition}{\param{const wxGBPosition\& }{pos}}
  86
  87 Return the sizer item for the given grid cell, or NULL if there is no
  88 item at that position. (non-recursive)
  89
  90 \membersection{wxGridBagSizer::FindItemWithData}\label{wxgridbagsizerfinditemwithdata}
  91
  92 \func{wxGBSizerItem*}{FindItemWithData}{\param{const wxObject* }{userData}}
  93
  94 Return the sizer item that has a matching user data (it only compares
  95 pointer values) or NULL if not found. (non-recursive)
  96
  97 \membersection{wxGridBagSizer::GetCellSize}\label{wxgridbagsizergetcellsize}
  98
  99 \constfunc{wxSize}{GetCellSize}{\param{int }{row}, \param{int }{col}}
 100
 101 Get the size of the specified cell, including hgap and vgap. Only
 102 valid after a Layout.
 103
 104 \membersection{wxGridBagSizer::GetEmptyCellSize}\label{wxgridbagsizergetemptycellsize}
 105
 106 \constfunc{wxSize}{GetEmptyCellSize}{\void}
 107
 108 Get the size used for cells in the grid with no item.
 109
 110 \membersection{wxGridBagSizer::GetItemPosition}\label{wxgridbagsizergetitemposition}
 111
 112 \func{wxGBPosition}{GetItemPosition}{\param{wxWindow* }{window}}
 113
 114 \func{wxGBPosition}{GetItemPosition}{\param{wxSizer* }{sizer}}
 115
 116 \func{wxGBPosition}{GetItemPosition}{\param{size\_t }{index}}
 117
 118 Get the grid position of the specified item.
 119
 120 \membersection{wxGridBagSizer::GetItemSpan}\label{wxgridbagsizergetitemspan}
 121
 122 \func{wxGBSpan}{GetItemSpan}{\param{wxWindow* }{window}}
 123
 124 \func{wxGBSpan}{GetItemSpan}{\param{wxSizer* }{sizer}}
 125
 126 \func{wxGBSpan}{GetItemSpan}{\param{size\_t }{index}}
 127
 128 Get the row/col spanning of the specified item
 129
 130 \membersection{wxGridBagSizer::RecalcSizes}\label{wxgridbagsizerrecalcsizes}
 131
 132 \func{void}{RecalcSizes}{\void}
 133
 134 Called when the managed size of the sizer is needed or when layout
 135 needs done.
 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 \membersection{wxGridBagSizer::SetItemPosition}\label{wxgridbagsizersetitemposition}
 144
 145 \func{bool}{SetItemPosition}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}}
 146
 147 \func{bool}{SetItemPosition}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}}
 148
 149 \func{bool}{SetItemPosition}{\param{size\_t }{index}, \param{const wxGBPosition\& }{pos}}
 150
 151 Set the grid position of the specified item. Returns true on success.
 152 If the move is not allowed (because an item is already there) then
 153 false is returned.
 154
 155 \membersection{wxGridBagSizer::SetItemSpan}\label{wxgridbagsizersetitemspan}
 156
 157 \func{bool}{SetItemSpan}{\param{wxWindow* }{window}, \param{const wxGBSpan\& }{span}}
 158
 159 \func{bool}{SetItemSpan}{\param{wxSizer* }{sizer}, \param{const wxGBSpan\& }{span}}
 160
 161 \func{bool}{SetItemSpan}{\param{size\_t }{index}, \param{const wxGBSpan\& }{span}}
 162
 163 Set the row/col spanning of the specified item. Returns true on
 164 success. If the move is not allowed (because an item is already there)
 165 then false is returned.
 166