Refactored wxSizerXmlHandler and added support for wxGridBagSizer
[wxWidgets.git] / src / xrc / xh_sizer.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: xh_sizer.cpp
3 // Purpose: XRC resource for wxBoxSizer
4 // Author: Vaclav Slavik
5 // Created: 2000/03/21
6 // RCS-ID: $Id$
7 // Copyright: (c) 2000 Vaclav Slavik
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 #ifdef __GNUG__
12 #pragma implementation "xh_sizer.h"
13 #endif
14
15 // For compilers that support precompilation, includes "wx.h".
16 #include "wx/wxprec.h"
17
18 #ifdef __BORLANDC__
19 #pragma hdrstop
20 #endif
21
22 #include "wx/xrc/xh_sizer.h"
23 #include "wx/sizer.h"
24 #include "wx/gbsizer.h"
25 #include "wx/log.h"
26 #include "wx/statbox.h"
27 #include "wx/notebook.h"
28 #include "wx/panel.h"
29 #include "wx/tokenzr.h"
30
31
32
33 IMPLEMENT_DYNAMIC_CLASS(wxSizerXmlHandler, wxXmlResourceHandler)
34
35
36
37 wxSizerXmlHandler::wxSizerXmlHandler()
38 : wxXmlResourceHandler(),
39 m_isInside(FALSE),
40 m_isGBS(FALSE),
41 m_parentSizer(NULL)
42 {
43 XRC_ADD_STYLE(wxHORIZONTAL);
44 XRC_ADD_STYLE(wxVERTICAL);
45
46 // and flags
47 XRC_ADD_STYLE(wxLEFT);
48 XRC_ADD_STYLE(wxRIGHT);
49 XRC_ADD_STYLE(wxTOP);
50 XRC_ADD_STYLE(wxBOTTOM);
51 XRC_ADD_STYLE(wxNORTH);
52 XRC_ADD_STYLE(wxSOUTH);
53 XRC_ADD_STYLE(wxEAST);
54 XRC_ADD_STYLE(wxWEST);
55 XRC_ADD_STYLE(wxALL);
56
57 XRC_ADD_STYLE(wxGROW);
58 XRC_ADD_STYLE(wxEXPAND);
59 XRC_ADD_STYLE(wxSHAPED);
60 XRC_ADD_STYLE(wxSTRETCH_NOT);
61
62 XRC_ADD_STYLE(wxALIGN_CENTER);
63 XRC_ADD_STYLE(wxALIGN_CENTRE);
64 XRC_ADD_STYLE(wxALIGN_LEFT);
65 XRC_ADD_STYLE(wxALIGN_TOP);
66 XRC_ADD_STYLE(wxALIGN_RIGHT);
67 XRC_ADD_STYLE(wxALIGN_BOTTOM);
68 XRC_ADD_STYLE(wxALIGN_CENTER_HORIZONTAL);
69 XRC_ADD_STYLE(wxALIGN_CENTRE_HORIZONTAL);
70 XRC_ADD_STYLE(wxALIGN_CENTER_VERTICAL);
71 XRC_ADD_STYLE(wxALIGN_CENTRE_VERTICAL);
72
73 XRC_ADD_STYLE(wxADJUST_MINSIZE);
74 }
75
76
77
78 bool wxSizerXmlHandler::CanHandle(wxXmlNode *node)
79 {
80 return ( (!m_isInside && IsSizerNode(node)) ||
81 (m_isInside && IsOfClass(node, wxT("sizeritem"))) ||
82 (m_isInside && IsOfClass(node, wxT("spacer")))
83 );
84 }
85
86
87 wxObject* wxSizerXmlHandler::DoCreateResource()
88 {
89 if (m_class == wxT("sizeritem"))
90 return Handle_sizeritem();
91
92 else if (m_class == wxT("spacer"))
93 return Handle_spacer();
94
95 else
96 return Handle_sizer();
97 }
98
99
100
101
102 bool wxSizerXmlHandler::IsSizerNode(wxXmlNode *node)
103 {
104 return (IsOfClass(node, wxT("wxBoxSizer"))) ||
105 (IsOfClass(node, wxT("wxStaticBoxSizer"))) ||
106 (IsOfClass(node, wxT("wxGridSizer"))) ||
107 (IsOfClass(node, wxT("wxFlexGridSizer"))) ||
108 (IsOfClass(node, wxT("wxGridBagSizer")));
109 }
110
111
112 wxObject* wxSizerXmlHandler::Handle_sizeritem()
113 {
114 // find the item to be managed by this sizeritem
115 wxXmlNode *n = GetParamNode(wxT("object"));
116 if ( !n )
117 n = GetParamNode(wxT("object_ref"));
118
119 // did we find one?
120 if (n)
121 {
122 // create a sizer item for it
123 wxSizerItem* sitem = MakeSizerItem();
124 SetSizerItemAttributes(sitem);
125
126 // now fetch the item to be managed
127 bool old_gbs = m_isGBS;
128 bool old_ins = m_isInside;
129 wxSizer *old_par = m_parentSizer;
130 m_isInside = FALSE;
131 if (!IsSizerNode(n)) m_parentSizer = NULL;
132 wxObject *item = CreateResFromNode(n, m_parent, NULL);
133 m_isInside = old_ins;
134 m_parentSizer = old_par;
135 m_isGBS = old_gbs;
136
137 // and figure out what type it is
138 wxSizer *sizer = wxDynamicCast(item, wxSizer);
139 wxWindow *wnd = wxDynamicCast(item, wxWindow);
140
141 if (sizer)
142 sitem->SetSizer(sizer);
143 else if (wnd)
144 sitem->SetWindow(wnd);
145 else
146 wxLogError(wxT("Error in resource."));
147
148 AddSizerItem(sitem);
149 return item;
150 }
151 else /*n == NULL*/
152 {
153 wxLogError(wxT("Error in resource: no window/sizer/spacer within sizeritem object."));
154 return NULL;
155 }
156 }
157
158
159 wxObject* wxSizerXmlHandler::Handle_spacer()
160 {
161 wxCHECK_MSG(m_parentSizer, NULL, wxT("Incorrect syntax of XRC resource: spacer not within sizer!"));
162
163 wxSizerItem* sitem = MakeSizerItem();
164 SetSizerItemAttributes(sitem);
165 sitem->SetSpacer(GetSize());
166 AddSizerItem(sitem);
167 return NULL;
168 }
169
170
171 wxObject* wxSizerXmlHandler::Handle_sizer()
172 {
173 wxSizer *sizer = NULL;
174
175 wxXmlNode *parentNode = m_node->GetParent();
176
177 wxCHECK_MSG(m_parentSizer != NULL ||
178 (parentNode->GetType() == wxXML_ELEMENT_NODE &&
179 m_parentAsWindow != NULL &&
180 (m_parentAsWindow->IsKindOf(CLASSINFO(wxPanel)) ||
181 m_parentAsWindow->IsKindOf(CLASSINFO(wxFrame)) ||
182 m_parentAsWindow->IsKindOf(CLASSINFO(wxDialog)))
183 ), NULL,
184 wxT("Incorrect use of sizer: parent is not 'wxDialog', 'wxFrame' or 'wxPanel'."));
185
186 if (m_class == wxT("wxBoxSizer"))
187 sizer = Handle_wxBoxSizer();
188
189 else if (m_class == wxT("wxStaticBoxSizer"))
190 sizer = Handle_wxStaticBoxSizer();
191
192 else if (m_class == wxT("wxGridSizer"))
193 sizer = Handle_wxGridSizer();
194
195 else if (m_class == wxT("wxFlexGridSizer"))
196 sizer = Handle_wxFlexGridSizer();
197
198 else if (m_class == wxT("wxGridBagSizer"))
199 sizer = Handle_wxGridBagSizer();
200
201
202 wxSize minsize = GetSize(wxT("minsize"));
203 if (!(minsize == wxDefaultSize))
204 sizer->SetMinSize(minsize);
205
206 // save state
207 wxSizer *old_par = m_parentSizer;
208 bool old_ins = m_isInside;
209 bool old_gbs = m_isGBS;
210
211 // set new state
212 m_parentSizer = sizer;
213 m_isInside = TRUE;
214 m_isGBS = (m_class == wxT("wxGridBagSizer"));
215
216 CreateChildren(m_parent, TRUE/*only this handler*/);
217
218 // restore state
219 old_gbs = m_isGBS;
220 m_isInside = old_ins;
221 m_parentSizer = old_par;
222
223 if (m_parentSizer == NULL) // setup window:
224 {
225 m_parentAsWindow->SetAutoLayout(TRUE);
226 m_parentAsWindow->SetSizer(sizer);
227
228 wxXmlNode *nd = m_node;
229 m_node = parentNode;
230 if (GetSize() == wxDefaultSize)
231 sizer->Fit(m_parentAsWindow);
232 m_node = nd;
233
234 if (m_parentAsWindow->GetWindowStyle() & (wxRESIZE_BOX | wxRESIZE_BORDER))
235 sizer->SetSizeHints(m_parentAsWindow);
236 }
237
238 return sizer;
239 }
240
241
242 wxSizer* wxSizerXmlHandler::Handle_wxBoxSizer()
243 {
244 return new wxBoxSizer(GetStyle(wxT("orient"), wxHORIZONTAL));
245 }
246
247 wxSizer* wxSizerXmlHandler::Handle_wxStaticBoxSizer()
248 {
249 return new wxStaticBoxSizer(
250 new wxStaticBox(m_parentAsWindow,
251 GetID(),
252 GetText(wxT("label")),
253 wxDefaultPosition, wxDefaultSize,
254 0/*style*/,
255 GetName()),
256 GetStyle(wxT("orient"), wxHORIZONTAL));
257 }
258
259 wxSizer* wxSizerXmlHandler::Handle_wxGridSizer()
260 {
261 return new wxGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
262 GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
263 }
264
265
266 wxSizer* wxSizerXmlHandler::Handle_wxFlexGridSizer()
267 {
268 wxFlexGridSizer *sizer =
269 new wxFlexGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
270 GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
271 SetGrowables(sizer, wxT("growablerows"), true);
272 SetGrowables(sizer, wxT("growablecols"), false);
273 return sizer;
274 }
275
276
277 wxSizer* wxSizerXmlHandler::Handle_wxGridBagSizer()
278 {
279 wxGridBagSizer *sizer =
280 new wxGridBagSizer(GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
281 SetGrowables(sizer, wxT("growablerows"), true);
282 SetGrowables(sizer, wxT("growablecols"), false);
283 return sizer;
284 }
285
286
287
288
289 void wxSizerXmlHandler::SetGrowables(wxFlexGridSizer* sizer,
290 const wxChar* param,
291 bool rows)
292 {
293 wxStringTokenizer tkn;
294 unsigned long l;
295 tkn.SetString(GetParamValue(param), wxT(","));
296 while (tkn.HasMoreTokens())
297 {
298 if (!tkn.GetNextToken().ToULong(&l))
299 wxLogError(wxT("growable[rows|cols] must be comma-separated list of row numbers"));
300 else {
301 if (rows)
302 sizer->AddGrowableRow(l);
303 else
304 sizer->AddGrowableCol(l);
305 }
306 }
307 }
308
309
310 wxGBPosition wxSizerXmlHandler::GetGBPos(const wxString& param)
311 {
312 wxSize sz = GetSize(param);
313 if (sz.x < 0) sz.x = 0;
314 if (sz.y < 0) sz.y = 0;
315 return wxGBPosition(sz.x, sz.y);
316 }
317
318 wxGBSpan wxSizerXmlHandler::GetGBSpan(const wxString& param)
319 {
320 wxSize sz = GetSize(param);
321 if (sz.x < 1) sz.x = 1;
322 if (sz.y < 1) sz.y = 1;
323 return wxGBSpan(sz.x, sz.y);
324 }
325
326
327
328 wxSizerItem* wxSizerXmlHandler::MakeSizerItem()
329 {
330 if (m_isGBS)
331 return new wxGBSizerItem();
332 else
333 return new wxSizerItem();
334 }
335
336 void wxSizerXmlHandler::SetSizerItemAttributes(wxSizerItem* sitem)
337 {
338 sitem->SetProportion(GetLong(wxT("option"))); // Should this check for "proportion" too?
339 sitem->SetFlag(GetStyle(wxT("flag")));
340 sitem->SetBorder(GetDimension(wxT("border")));
341 wxSize sz = GetSize(wxT("minsize"));
342 if (!(sz == wxDefaultSize))
343 sitem->SetInitSize(sz.x, sz.y);
344 sz = GetSize(wxT("ratio"));
345 if (!(sz == wxDefaultSize))
346 sitem->SetRatio(sz);
347
348 if (m_isGBS)
349 {
350 wxGBSizerItem* gbsitem = (wxGBSizerItem*)sitem;
351 gbsitem->SetPos(GetGBPos(wxT("pos")));
352 gbsitem->SetSpan(GetGBSpan(wxT("span")));
353 }
354 }
355
356 void wxSizerXmlHandler::AddSizerItem(wxSizerItem* sitem)
357 {
358 if (m_isGBS)
359 ((wxGridBagSizer*)m_parentSizer)->Add((wxGBSizerItem*)sitem);
360 else
361 m_parentSizer->Add(sitem);
362 }
363
364
365
366
367
368
369
370
371
372