]> git.saurik.com Git - wxWidgets.git/blame - interface/wx/gbsizer.h
Fix wxGCDC::Clear() for Cairo, and possibly MSW.
[wxWidgets.git] / interface / wx / gbsizer.h
CommitLineData
23324ae1
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: gbsizer.h
e54c96f1 3// Purpose: interface of wxGBPosition
23324ae1
FM
4// Author: wxWidgets team
5// RCS-ID: $Id$
526954c5 6// Licence: wxWindows licence
23324ae1
FM
7/////////////////////////////////////////////////////////////////////////////
8
9/**
10 @class wxGBPosition
7c913512 11
3d2cf884
BP
12 This class represents the position of an item in a virtual grid of rows and
13 columns managed by a wxGridBagSizer.
7c913512 14
23324ae1 15 @library{wxcore}
3d2cf884 16 @category{winlayout}
23324ae1 17*/
7c913512 18class wxGBPosition
23324ae1
FM
19{
20public:
23324ae1 21 /**
3d2cf884 22 Default constructor, setting the row and column to (0,0).
23324ae1
FM
23 */
24 wxGBPosition();
3d2cf884
BP
25 /**
26 Construct a new wxGBPosition, setting the row and column.
27 */
7c913512 28 wxGBPosition(int row, int col);
23324ae1
FM
29
30 /**
31 Get the current column value.
32 */
328f5751 33 int GetCol() const;
23324ae1
FM
34
35 /**
36 Get the current row value.
37 */
328f5751 38 int GetRow() const;
23324ae1
FM
39
40 /**
41 Set a new column value.
42 */
43 void SetCol(int col);
44
45 /**
46 Set a new row value.
47 */
48 void SetRow(int row);
49
50 /**
fc910c50 51 Compare inequality of two wxGBPositions.
23324ae1 52 */
fc910c50 53 bool operator!=(const wxGBPosition& p) const;
23324ae1
FM
54
55 /**
56 Compare equality of two wxGBPositions.
57 */
3d2cf884 58 bool operator==(const wxGBPosition& p) const;
23324ae1
FM
59};
60
61
e54c96f1 62
23324ae1
FM
63/**
64 @class wxGridBagSizer
7c913512 65
3d2cf884
BP
66 A wxSizer that can lay out items in a virtual grid like a wxFlexGridSizer
67 but in this case explicit positioning of the items is allowed using
68 wxGBPosition, and items can optionally span more than one row and/or column
69 using wxGBSpan.
7c913512 70
23324ae1
FM
71 @library{wxcore}
72 @category{winlayout}
73*/
74class wxGridBagSizer : public wxFlexGridSizer
75{
76public:
77 /**
78 Constructor, with optional parameters to specify the gap between the
79 rows and columns.
80 */
81 wxGridBagSizer(int vgap = 0, int hgap = 0);
82
83 //@{
84 /**
3d2cf884
BP
85 Adds the given item to the given position.
86
d29a9a8a 87 @return A valid pointer if the item was successfully placed at the
3d2cf884 88 given position, or @NULL if something was already there.
23324ae1
FM
89 */
90 wxSizerItem* Add(wxWindow* window, const wxGBPosition& pos,
91 const wxGBSpan& span = wxDefaultSpan,
3d2cf884 92 int flag = 0, int border = 0, wxObject* userData = NULL);
7c913512
FM
93 wxSizerItem* Add(wxSizer* sizer, const wxGBPosition& pos,
94 const wxGBSpan& span = wxDefaultSpan,
3d2cf884
BP
95 int flag = 0, int border = 0, wxObject* userData = NULL);
96 wxSizerItem* Add(int width, int height, const wxGBPosition& pos,
7c913512 97 const wxGBSpan& span = wxDefaultSpan,
3d2cf884 98 int flag = 0, int border = 0, wxObject* userData = NULL);
7c913512 99 wxSizerItem* Add(wxGBSizerItem* item);
23324ae1
FM
100 //@}
101
102 /**
103 Called when the managed size of the sizer is needed or when layout
104 needs done.
105 */
106 wxSize CalcMin();
107
108 //@{
109 /**
110 Look at all items and see if any intersect (or would overlap) the given
111 item. Returns @true if so, @false if there would be no overlap. If an
3d2cf884
BP
112 @a excludeItem is given then it will not be checked for intersection,
113 for example it may be the item we are checking the position of.
23324ae1
FM
114 */
115 bool CheckForIntersection(wxGBSizerItem* item,
4cc4bfaf 116 wxGBSizerItem* excludeItem = NULL);
3d2cf884 117 bool CheckForIntersection(const wxGBPosition& pos, const wxGBSpan& span,
4cc4bfaf 118 wxGBSizerItem* excludeItem = NULL);
23324ae1
FM
119 //@}
120
121 //@{
122 /**
123 Find the sizer item for the given window or subsizer, returns @NULL if
124 not found. (non-recursive)
125 */
126 wxGBSizerItem* FindItem(wxWindow* window);
7c913512 127 wxGBSizerItem* FindItem(wxSizer* sizer);
23324ae1
FM
128 //@}
129
130 /**
131 Return the sizer item located at the point given in pt, or @NULL if
3d2cf884
BP
132 there is no item at that point. The (x,y) coordinates in @a pt
133 correspond to the client coordinates of the window using the sizer for
23324ae1
FM
134 layout. (non-recursive)
135 */
136 wxGBSizerItem* FindItemAtPoint(const wxPoint& pt);
137
138 /**
139 Return the sizer item for the given grid cell, or @NULL if there is no
140 item at that position. (non-recursive)
141 */
142 wxGBSizerItem* FindItemAtPosition(const wxGBPosition& pos);
143
144 /**
145 Return the sizer item that has a matching user data (it only compares
146 pointer values) or @NULL if not found. (non-recursive)
147 */
148 wxGBSizerItem* FindItemWithData(const wxObject* userData);
149
150 /**
3d2cf884
BP
151 Get the size of the specified cell, including hgap and vgap. Only valid
152 after window layout has been performed.
23324ae1 153 */
328f5751 154 wxSize GetCellSize(int row, int col) const;
23324ae1
FM
155
156 /**
157 Get the size used for cells in the grid with no item.
158 */
328f5751 159 wxSize GetEmptyCellSize() const;
23324ae1
FM
160
161 //@{
162 /**
163 Get the grid position of the specified item.
164 */
165 wxGBPosition GetItemPosition(wxWindow* window);
7c913512
FM
166 wxGBPosition GetItemPosition(wxSizer* sizer);
167 wxGBPosition GetItemPosition(size_t index);
23324ae1
FM
168 //@}
169
170 //@{
171 /**
3d2cf884 172 Get the row/col spanning of the specified item.
23324ae1
FM
173 */
174 wxGBSpan GetItemSpan(wxWindow* window);
7c913512
FM
175 wxGBSpan GetItemSpan(wxSizer* sizer);
176 wxGBSpan GetItemSpan(size_t index);
23324ae1
FM
177 //@}
178
179 /**
180 Called when the managed size of the sizer is needed or when layout
181 needs done.
182 */
183 void RecalcSizes();
184
185 /**
186 Set the size used for cells in the grid with no item.
187 */
188 void SetEmptyCellSize(const wxSize& sz);
189
190 //@{
191 /**
192 Set the grid position of the specified item. Returns @true on success.
193 If the move is not allowed (because an item is already there) then
194 @false is returned.
195 */
196 bool SetItemPosition(wxWindow* window, const wxGBPosition& pos);
7c913512
FM
197 bool SetItemPosition(wxSizer* sizer, const wxGBPosition& pos);
198 bool SetItemPosition(size_t index, const wxGBPosition& pos);
23324ae1
FM
199 //@}
200
201 //@{
202 /**
203 Set the row/col spanning of the specified item. Returns @true on
204 success. If the move is not allowed (because an item is already there)
205 then @false is returned.
206 */
207 bool SetItemSpan(wxWindow* window, const wxGBSpan& span);
7c913512
FM
208 bool SetItemSpan(wxSizer* sizer, const wxGBSpan& span);
209 bool SetItemSpan(size_t index, const wxGBSpan& span);
23324ae1
FM
210 //@}
211};
212
213
e54c96f1 214
23324ae1
FM
215/**
216 @class wxGBSizerItem
7c913512 217
3d2cf884
BP
218 The wxGBSizerItem class is used by the wxGridBagSizer for tracking the
219 items in the sizer. It adds grid position and spanning information to the
d13b34d3 220 normal wxSizerItem by adding wxGBPosition and wxGBSpan attributes. Most of
3d2cf884
BP
221 the time you will not need to use a wxGBSizerItem directly in your code,
222 but there are a couple of cases where it is handy.
7c913512 223
23324ae1 224 @library{wxcore}
3d2cf884 225 @category{winlayout}
23324ae1
FM
226*/
227class wxGBSizerItem : public wxSizerItem
228{
229public:
23324ae1 230 /**
3d2cf884 231 Construct a sizer item for tracking a spacer.
23324ae1
FM
232 */
233 wxGBSizerItem(int width, int height, const wxGBPosition& pos,
5eb16fe2
RD
234 const wxGBSpan& span=wxDefaultSpan, int flag=0, int border=0,
235 wxObject* userData=NULL);
3d2cf884
BP
236 /**
237 Construct a sizer item for tracking a window.
238 */
7c913512 239 wxGBSizerItem(wxWindow* window, const wxGBPosition& pos,
5eb16fe2
RD
240 const wxGBSpan& span=wxDefaultSpan, int flag=0, int border=0,
241 wxObject* userData=NULL);
3d2cf884
BP
242 /**
243 Construct a sizer item for tracking a subsizer.
244 */
7c913512 245 wxGBSizerItem(wxSizer* sizer, const wxGBPosition& pos,
5eb16fe2
RD
246 const wxGBSpan& span=wxDefaultSpan, int flag=0, int border=0,
247 wxObject* userData=NULL);
23324ae1
FM
248
249 /**
3d2cf884 250 Get the row and column of the endpoint of this item.
23324ae1
FM
251 */
252 void GetEndPos(int& row, int& col);
253
254 //@{
255 /**
256 Get the grid position of the item.
257 */
328f5751 258 wxGBPosition GetPos() const;
3d2cf884 259 void GetPos(int& row, int& col) const;
23324ae1
FM
260 //@}
261
262 //@{
263 /**
264 Get the row and column spanning of the item.
265 */
328f5751 266 wxGBSpan GetSpan() const;
3d2cf884 267 void GetSpan(int& rowspan, int& colspan) const;
23324ae1
FM
268 //@}
269
23324ae1 270 /**
d13b34d3 271 Returns @true if this item and the @a other item intersect.
23324ae1
FM
272 */
273 bool Intersects(const wxGBSizerItem& other);
3d2cf884
BP
274 /**
275 Returns @true if the given pos/span would intersect with this item.
276 */
277 bool Intersects(const wxGBPosition& pos, const wxGBSpan& span);
23324ae1
FM
278
279 /**
3d2cf884
BP
280 If the item is already a member of a sizer then first ensure that there
281 is no other item that would intersect with this one at the new
23324ae1
FM
282 position, then set the new position. Returns @true if the change is
283 successful and after the next Layout the item will be moved.
284 */
285 bool SetPos(const wxGBPosition& pos);
286
287 /**
3d2cf884
BP
288 If the item is already a member of a sizer then first ensure that there
289 is no other item that would intersect with this one with its new
23324ae1
FM
290 spanning size, then set the new spanning. Returns @true if the change
291 is successful and after the next Layout the item will be resized.
292 */
293 bool SetSpan(const wxGBSpan& span);
5eb16fe2
RD
294
295
296 wxGridBagSizer* GetGBSizer() const;
297 void SetGBSizer(wxGridBagSizer* sizer);
23324ae1
FM
298};
299
300
e54c96f1 301
23324ae1
FM
302/**
303 @class wxGBSpan
7c913512 304
3d2cf884
BP
305 This class is used to hold the row and column spanning attributes of items
306 in a wxGridBagSizer.
7c913512 307
23324ae1 308 @library{wxcore}
3d2cf884 309 @category{winlayout}
23324ae1 310*/
7c913512 311class wxGBSpan
23324ae1
FM
312{
313public:
23324ae1 314 /**
3d2cf884
BP
315 Default constructor, setting the rowspan and colspan to (1,1) meaning
316 that the item occupies one cell in each direction.
23324ae1
FM
317 */
318 wxGBSpan();
3d2cf884
BP
319 /**
320 Construct a new wxGBSpan, setting the @a rowspan and @a colspan.
321 */
7c913512 322 wxGBSpan(int rowspan, int colspan);
23324ae1
FM
323
324 /**
325 Get the current colspan value.
326 */
328f5751 327 int GetColspan() const;
23324ae1
FM
328
329 /**
330 Get the current rowspan value.
331 */
328f5751 332 int GetRowspan() const;
23324ae1
FM
333
334 /**
335 Set a new colspan value.
336 */
337 void SetColspan(int colspan);
338
339 /**
340 Set a new rowspan value.
341 */
342 void SetRowspan(int rowspan);
343
344 /**
fc910c50 345 Compare inequality of two wxGBSpans.
23324ae1 346 */
fc910c50 347 bool operator!=(const wxGBSpan& o) const;
23324ae1
FM
348
349 /**
350 Compare equality of two wxGBSpans.
351 */
3d2cf884 352 bool operator==(const wxGBSpan& o) const;
23324ae1 353};
e54c96f1 354
5eb16fe2
RD
355
356const wxGBSpan wxDefaultSpan;