src/xrc/xh_sizer.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/xrc/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 // For compilers that support precompilation, includes "wx.h".
  12 #include "wx/wxprec.h"
  13
  14 #ifdef __BORLANDC__
  15     #pragma hdrstop
  16 #endif
  17
  18 #if wxUSE_XRC
  19
  20 #include "wx/xrc/xh_sizer.h"
  21
  22 #ifndef WX_PRECOMP
  23     #include "wx/log.h"
  24     #include "wx/panel.h"
  25     #include "wx/statbox.h"
  26     #include "wx/sizer.h"
  27     #include "wx/frame.h"
  28     #include "wx/dialog.h"
  29     #include "wx/button.h"
  30     #include "wx/scrolwin.h"
  31 #endif
  32
  33 #include "wx/gbsizer.h"
  34 #include "wx/wrapsizer.h"
  35 #include "wx/notebook.h"
  36 #include "wx/tokenzr.h"
  37
  38
  39 //-----------------------------------------------------------------------------
  40 // wxSizerXmlHandler
  41 //-----------------------------------------------------------------------------
  42
  43 IMPLEMENT_DYNAMIC_CLASS(wxSizerXmlHandler, wxXmlResourceHandler)
  44
  45 wxSizerXmlHandler::wxSizerXmlHandler()
  46                   :wxXmlResourceHandler(),
  47                    m_isInside(false),
  48                    m_isGBS(false),
  49                    m_parentSizer(NULL)
  50 {
  51     XRC_ADD_STYLE(wxHORIZONTAL);
  52     XRC_ADD_STYLE(wxVERTICAL);
  53
  54     // and flags
  55     XRC_ADD_STYLE(wxLEFT);
  56     XRC_ADD_STYLE(wxRIGHT);
  57     XRC_ADD_STYLE(wxTOP);
  58     XRC_ADD_STYLE(wxBOTTOM);
  59     XRC_ADD_STYLE(wxNORTH);
  60     XRC_ADD_STYLE(wxSOUTH);
  61     XRC_ADD_STYLE(wxEAST);
  62     XRC_ADD_STYLE(wxWEST);
  63     XRC_ADD_STYLE(wxALL);
  64
  65     XRC_ADD_STYLE(wxGROW);
  66     XRC_ADD_STYLE(wxEXPAND);
  67     XRC_ADD_STYLE(wxSHAPED);
  68     XRC_ADD_STYLE(wxSTRETCH_NOT);
  69
  70     XRC_ADD_STYLE(wxALIGN_CENTER);
  71     XRC_ADD_STYLE(wxALIGN_CENTRE);
  72     XRC_ADD_STYLE(wxALIGN_LEFT);
  73     XRC_ADD_STYLE(wxALIGN_TOP);
  74     XRC_ADD_STYLE(wxALIGN_RIGHT);
  75     XRC_ADD_STYLE(wxALIGN_BOTTOM);
  76     XRC_ADD_STYLE(wxALIGN_CENTER_HORIZONTAL);
  77     XRC_ADD_STYLE(wxALIGN_CENTRE_HORIZONTAL);
  78     XRC_ADD_STYLE(wxALIGN_CENTER_VERTICAL);
  79     XRC_ADD_STYLE(wxALIGN_CENTRE_VERTICAL);
  80
  81     XRC_ADD_STYLE(wxFIXED_MINSIZE);
  82     XRC_ADD_STYLE(wxRESERVE_SPACE_EVEN_IF_HIDDEN);
  83
  84     // this flag doesn't do anything any more but we can just ignore its
  85     // occurrences in the old resource files instead of raising a fuss because
  86     // of it
  87     AddStyle("wxADJUST_MINSIZE", 0);
  88
  89     // wxWrapSizer-specific flags
  90     XRC_ADD_STYLE(wxEXTEND_LAST_ON_EACH_LINE);
  91     XRC_ADD_STYLE(wxREMOVE_LEADING_SPACES);
  92 }
  93
  94
  95
  96 bool wxSizerXmlHandler::CanHandle(wxXmlNode *node)
  97 {
  98     return ( (!m_isInside && IsSizerNode(node)) ||
  99              (m_isInside && IsOfClass(node, wxT("sizeritem"))) ||
 100              (m_isInside && IsOfClass(node, wxT("spacer")))
 101         );
 102 }
 103
 104
 105 wxObject* wxSizerXmlHandler::DoCreateResource()
 106 {
 107     if (m_class == wxT("sizeritem"))
 108         return Handle_sizeritem();
 109
 110     else if (m_class == wxT("spacer"))
 111         return Handle_spacer();
 112
 113     else
 114         return Handle_sizer();
 115 }
 116
 117
 118
 119
 120 bool wxSizerXmlHandler::IsSizerNode(wxXmlNode *node)
 121 {
 122     return (IsOfClass(node, wxT("wxBoxSizer"))) ||
 123            (IsOfClass(node, wxT("wxStaticBoxSizer"))) ||
 124            (IsOfClass(node, wxT("wxGridSizer"))) ||
 125            (IsOfClass(node, wxT("wxFlexGridSizer"))) ||
 126            (IsOfClass(node, wxT("wxGridBagSizer"))) ||
 127            (IsOfClass(node, wxT("wxWrapSizer")));
 128 }
 129
 130
 131 wxObject* wxSizerXmlHandler::Handle_sizeritem()
 132 {
 133     // find the item to be managed by this sizeritem
 134     wxXmlNode *n = GetParamNode(wxT("object"));
 135     if ( !n )
 136         n = GetParamNode(wxT("object_ref"));
 137
 138     // did we find one?
 139     if (n)
 140     {
 141         // create a sizer item for it
 142         wxSizerItem* sitem = MakeSizerItem();
 143
 144         // now fetch the item to be managed
 145         bool old_gbs = m_isGBS;
 146         bool old_ins = m_isInside;
 147         wxSizer *old_par = m_parentSizer;
 148         m_isInside = false;
 149         if (!IsSizerNode(n)) m_parentSizer = NULL;
 150         wxObject *item = CreateResFromNode(n, m_parent, NULL);
 151         m_isInside = old_ins;
 152         m_parentSizer = old_par;
 153         m_isGBS = old_gbs;
 154
 155         // and figure out what type it is
 156         wxSizer *sizer = wxDynamicCast(item, wxSizer);
 157         wxWindow *wnd = wxDynamicCast(item, wxWindow);
 158
 159         if (sizer)
 160             sitem->AssignSizer(sizer);
 161         else if (wnd)
 162             sitem->AssignWindow(wnd);
 163         else
 164             wxLogError(wxT("Error in resource."));
 165
 166         // finally, set other wxSizerItem attributes
 167         SetSizerItemAttributes(sitem);
 168
 169         AddSizerItem(sitem);
 170         return item;
 171     }
 172     else /*n == NULL*/
 173     {
 174         wxLogError(wxT("Error in resource: no window/sizer/spacer within sizeritem object."));
 175         return NULL;
 176     }
 177 }
 178
 179
 180 wxObject* wxSizerXmlHandler::Handle_spacer()
 181 {
 182     if ( !m_parentSizer )
 183     {
 184         wxLogError(_("XRC syntax error: \"spacer\" only allowed inside a "
 185                      "sizer"));
 186         return NULL;
 187     }
 188
 189     wxSizerItem* sitem = MakeSizerItem();
 190     SetSizerItemAttributes(sitem);
 191     sitem->AssignSpacer(GetSize());
 192     AddSizerItem(sitem);
 193     return NULL;
 194 }
 195
 196
 197 wxObject* wxSizerXmlHandler::Handle_sizer()
 198 {
 199     wxSizer *sizer = NULL;
 200     wxFlexGridSizer *flexsizer = NULL;
 201
 202     wxXmlNode *parentNode = m_node->GetParent();
 203
 204     if ( !m_parentSizer &&
 205             (!parentNode || parentNode->GetType() != wxXML_ELEMENT_NODE ||
 206              !m_parentAsWindow) )
 207     {
 208         wxLogError(_("XRC syntax error: sizer must have a window parent."));
 209         return NULL;
 210     }
 211
 212     if (m_class == wxT("wxBoxSizer"))
 213         sizer = Handle_wxBoxSizer();
 214 #if wxUSE_STATBOX
 215     else if (m_class == wxT("wxStaticBoxSizer"))
 216         sizer = Handle_wxStaticBoxSizer();
 217 #endif
 218     else if (m_class == wxT("wxGridSizer"))
 219         sizer = Handle_wxGridSizer();
 220     else if (m_class == wxT("wxFlexGridSizer"))
 221     {
 222         flexsizer = Handle_wxFlexGridSizer();
 223         sizer = flexsizer;
 224     }
 225     else if (m_class == wxT("wxGridBagSizer"))
 226         sizer = Handle_wxGridBagSizer();
 227     else if (m_class == wxT("wxWrapSizer"))
 228         sizer = Handle_wxWrapSizer();
 229
 230     if ( !sizer )
 231     {
 232         wxLogError(_T("Failed to create size of class \"%s\""), m_class.c_str());
 233         return NULL;
 234     }
 235
 236     wxSize minsize = GetSize(wxT("minsize"));
 237     if (!(minsize == wxDefaultSize))
 238         sizer->SetMinSize(minsize);
 239
 240     // save state
 241     wxSizer *old_par = m_parentSizer;
 242     bool old_ins = m_isInside;
 243
 244     // set new state
 245     m_parentSizer = sizer;
 246     m_isInside = true;
 247     m_isGBS = (m_class == wxT("wxGridBagSizer"));
 248
 249     CreateChildren(m_parent, true/*only this handler*/);
 250
 251     // set growable rows and cols for sizers which support this
 252     if ( flexsizer )
 253     {
 254         SetGrowables(flexsizer, wxT("growablerows"), true);
 255         SetGrowables(flexsizer, wxT("growablecols"), false);
 256     }
 257
 258     // restore state
 259     m_isInside = old_ins;
 260     m_parentSizer = old_par;
 261
 262     if (m_parentSizer == NULL) // setup window:
 263     {
 264         m_parentAsWindow->SetSizer(sizer);
 265
 266         wxXmlNode *nd = m_node;
 267         m_node = parentNode;
 268         if (GetSize() == wxDefaultSize)
 269         {
 270             if ( wxDynamicCast(m_parentAsWindow, wxScrolledWindow) != NULL )
 271             {
 272                 sizer->FitInside(m_parentAsWindow);
 273             }
 274             else
 275             {
 276                 sizer->Fit(m_parentAsWindow);
 277             }
 278         }
 279         m_node = nd;
 280
 281         if (m_parentAsWindow->IsTopLevel())
 282         {
 283             sizer->SetSizeHints(m_parentAsWindow);
 284         }
 285     }
 286
 287     return sizer;
 288 }
 289
 290
 291 wxSizer*  wxSizerXmlHandler::Handle_wxBoxSizer()
 292 {
 293     return new wxBoxSizer(GetStyle(wxT("orient"), wxHORIZONTAL));
 294 }
 295
 296 #if wxUSE_STATBOX
 297 wxSizer*  wxSizerXmlHandler::Handle_wxStaticBoxSizer()
 298 {
 299     return new wxStaticBoxSizer(
 300             new wxStaticBox(m_parentAsWindow,
 301                             GetID(),
 302                             GetText(wxT("label")),
 303                             wxDefaultPosition, wxDefaultSize,
 304                             0/*style*/,
 305                             GetName()),
 306             GetStyle(wxT("orient"), wxHORIZONTAL));
 307 }
 308 #endif // wxUSE_STATBOX
 309
 310 wxSizer*  wxSizerXmlHandler::Handle_wxGridSizer()
 311 {
 312     return new wxGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
 313                            GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
 314 }
 315
 316
 317 wxFlexGridSizer* wxSizerXmlHandler::Handle_wxFlexGridSizer()
 318 {
 319     return new wxFlexGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
 320                                GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
 321 }
 322
 323
 324 wxSizer*  wxSizerXmlHandler::Handle_wxGridBagSizer()
 325 {
 326     return new wxGridBagSizer(GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
 327 }
 328
 329 wxSizer*  wxSizerXmlHandler::Handle_wxWrapSizer()
 330 {
 331     wxWrapSizer *sizer = new wxWrapSizer(GetStyle("orient"), GetStyle("flag"));
 332     return sizer;
 333 }
 334
 335
 336
 337 void wxSizerXmlHandler::SetGrowables(wxFlexGridSizer* sizer,
 338                                      const wxChar* param,
 339                                      bool rows)
 340 {
 341     wxStringTokenizer tkn;
 342     unsigned long l;
 343     tkn.SetString(GetParamValue(param), wxT(","));
 344     while (tkn.HasMoreTokens())
 345     {
 346         if (!tkn.GetNextToken().ToULong(&l))
 347         {
 348             wxLogError(wxT("growable[rows|cols] must be comma-separated list of row numbers"));
 349             break;
 350         }
 351
 352         if (rows)
 353             sizer->AddGrowableRow(l);
 354         else
 355             sizer->AddGrowableCol(l);
 356     }
 357 }
 358
 359
 360 wxGBPosition wxSizerXmlHandler::GetGBPos(const wxString& param)
 361 {
 362     wxSize sz = GetSize(param);
 363     if (sz.x < 0) sz.x = 0;
 364     if (sz.y < 0) sz.y = 0;
 365     return wxGBPosition(sz.x, sz.y);
 366 }
 367
 368 wxGBSpan wxSizerXmlHandler::GetGBSpan(const wxString& param)
 369 {
 370     wxSize sz = GetSize(param);
 371     if (sz.x < 1) sz.x = 1;
 372     if (sz.y < 1) sz.y = 1;
 373     return wxGBSpan(sz.x, sz.y);
 374 }
 375
 376
 377
 378 wxSizerItem* wxSizerXmlHandler::MakeSizerItem()
 379 {
 380     if (m_isGBS)
 381         return new wxGBSizerItem();
 382     else
 383         return new wxSizerItem();
 384 }
 385
 386 void wxSizerXmlHandler::SetSizerItemAttributes(wxSizerItem* sitem)
 387 {
 388     sitem->SetProportion(GetLong(wxT("option")));  // Should this check for "proportion" too?
 389     sitem->SetFlag(GetStyle(wxT("flag")));
 390     sitem->SetBorder(GetDimension(wxT("border")));
 391     wxSize sz = GetSize(wxT("minsize"));
 392     if (!(sz == wxDefaultSize))
 393         sitem->SetMinSize(sz);
 394     sz = GetSize(wxT("ratio"));
 395     if (!(sz == wxDefaultSize))
 396         sitem->SetRatio(sz);
 397
 398     if (m_isGBS)
 399     {
 400         wxGBSizerItem* gbsitem = (wxGBSizerItem*)sitem;
 401         gbsitem->SetPos(GetGBPos(wxT("cellpos")));
 402         gbsitem->SetSpan(GetGBSpan(wxT("cellspan")));
 403     }
 404
 405     // record the id of the item, if any, for use by XRCSIZERITEM()
 406     sitem->SetId(GetID());
 407 }
 408
 409 void wxSizerXmlHandler::AddSizerItem(wxSizerItem* sitem)
 410 {
 411     if (m_isGBS)
 412         ((wxGridBagSizer*)m_parentSizer)->Add((wxGBSizerItem*)sitem);
 413     else
 414         m_parentSizer->Add(sitem);
 415 }
 416
 417
 418
 419 //-----------------------------------------------------------------------------
 420 // wxStdDialogButtonSizerXmlHandler
 421 //-----------------------------------------------------------------------------
 422 #if wxUSE_BUTTON
 423
 424 IMPLEMENT_DYNAMIC_CLASS(wxStdDialogButtonSizerXmlHandler, wxXmlResourceHandler)
 425
 426 wxStdDialogButtonSizerXmlHandler::wxStdDialogButtonSizerXmlHandler()
 427     : m_isInside(false), m_parentSizer(NULL)
 428 {
 429 }
 430
 431 wxObject *wxStdDialogButtonSizerXmlHandler::DoCreateResource()
 432 {
 433     if (m_class == wxT("wxStdDialogButtonSizer"))
 434     {
 435         wxASSERT( !m_parentSizer );
 436
 437         wxSizer *s = m_parentSizer = new wxStdDialogButtonSizer;
 438         m_isInside = true;
 439
 440         CreateChildren(m_parent, true/*only this handler*/);
 441
 442         m_parentSizer->Realize();
 443
 444         m_isInside = false;
 445         m_parentSizer = NULL;
 446
 447         return s;
 448     }
 449     else // m_class == "button"
 450     {
 451         wxASSERT( m_parentSizer );
 452
 453         // find the item to be managed by this sizeritem
 454         wxXmlNode *n = GetParamNode(wxT("object"));
 455         if ( !n )
 456             n = GetParamNode(wxT("object_ref"));
 457
 458         // did we find one?
 459         if (n)
 460         {
 461             wxObject *item = CreateResFromNode(n, m_parent, NULL);
 462             wxButton *button = wxDynamicCast(item, wxButton);
 463
 464             if (button)
 465                 m_parentSizer->AddButton(button);
 466             else
 467                 wxLogError(wxT("Error in resource - expected button."));
 468
 469             return item;
 470         }
 471         else /*n == NULL*/
 472         {
 473             wxLogError(wxT("Error in resource: no button within wxStdDialogButtonSizer."));
 474             return NULL;
 475         }
 476     }
 477 }
 478
 479 bool wxStdDialogButtonSizerXmlHandler::CanHandle(wxXmlNode *node)
 480 {
 481     return (!m_isInside && IsOfClass(node, wxT("wxStdDialogButtonSizer"))) ||
 482            (m_isInside && IsOfClass(node, wxT("button")));
 483 }
 484 #endif // wxUSE_BUTTON
 485
 486 #endif // wxUSE_XRC