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             ReportError(n, "unexpected item in sizer");
 165
 166         // finally, set other wxSizerItem attributes
 167         SetSizerItemAttributes(sitem);
 168
 169         AddSizerItem(sitem);
 170         return item;
 171     }
 172     else /*n == NULL*/
 173     {
 174         ReportError("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         ReportError("spacer only allowed inside a sizer");
 185         return NULL;
 186     }
 187
 188     wxSizerItem* sitem = MakeSizerItem();
 189     SetSizerItemAttributes(sitem);
 190     sitem->AssignSpacer(GetSize());
 191     AddSizerItem(sitem);
 192     return NULL;
 193 }
 194
 195
 196 wxObject* wxSizerXmlHandler::Handle_sizer()
 197 {
 198     wxSizer *sizer = NULL;
 199     wxFlexGridSizer *flexsizer = NULL;
 200
 201     wxXmlNode *parentNode = m_node->GetParent();
 202
 203     if ( !m_parentSizer &&
 204             (!parentNode || parentNode->GetType() != wxXML_ELEMENT_NODE ||
 205              !m_parentAsWindow) )
 206     {
 207         ReportError("sizer must have a window parent");
 208         return NULL;
 209     }
 210
 211     if (m_class == wxT("wxBoxSizer"))
 212         sizer = Handle_wxBoxSizer();
 213 #if wxUSE_STATBOX
 214     else if (m_class == wxT("wxStaticBoxSizer"))
 215         sizer = Handle_wxStaticBoxSizer();
 216 #endif
 217     else if (m_class == wxT("wxGridSizer"))
 218         sizer = Handle_wxGridSizer();
 219     else if (m_class == wxT("wxFlexGridSizer"))
 220     {
 221         flexsizer = Handle_wxFlexGridSizer();
 222         sizer = flexsizer;
 223     }
 224     else if (m_class == wxT("wxGridBagSizer"))
 225     {
 226         flexsizer = Handle_wxGridBagSizer();
 227         sizer = flexsizer;
 228     }
 229     else if (m_class == wxT("wxWrapSizer"))
 230         sizer = Handle_wxWrapSizer();
 231
 232     if ( !sizer )
 233     {
 234         ReportError(wxString::Format("unknown sizer class \"%s\"", m_class));
 235         return NULL;
 236     }
 237
 238     wxSize minsize = GetSize(wxT("minsize"));
 239     if (!(minsize == wxDefaultSize))
 240         sizer->SetMinSize(minsize);
 241
 242     // save state
 243     wxSizer *old_par = m_parentSizer;
 244     bool old_ins = m_isInside;
 245
 246     // set new state
 247     m_parentSizer = sizer;
 248     m_isInside = true;
 249     m_isGBS = (m_class == wxT("wxGridBagSizer"));
 250
 251     CreateChildren(m_parent, true/*only this handler*/);
 252
 253     // set growable rows and cols for sizers which support this
 254     if ( flexsizer )
 255     {
 256         SetGrowables(flexsizer, wxT("growablerows"), true);
 257         SetGrowables(flexsizer, wxT("growablecols"), false);
 258     }
 259
 260     // restore state
 261     m_isInside = old_ins;
 262     m_parentSizer = old_par;
 263
 264     if (m_parentSizer == NULL) // setup window:
 265     {
 266         m_parentAsWindow->SetSizer(sizer);
 267
 268         wxXmlNode *nd = m_node;
 269         m_node = parentNode;
 270         if (GetSize() == wxDefaultSize)
 271         {
 272             if ( wxDynamicCast(m_parentAsWindow, wxScrolledWindow) != NULL )
 273             {
 274                 sizer->FitInside(m_parentAsWindow);
 275             }
 276             else
 277             {
 278                 sizer->Fit(m_parentAsWindow);
 279             }
 280         }
 281         m_node = nd;
 282
 283         if (m_parentAsWindow->IsTopLevel())
 284         {
 285             sizer->SetSizeHints(m_parentAsWindow);
 286         }
 287     }
 288
 289     return sizer;
 290 }
 291
 292
 293 wxSizer*  wxSizerXmlHandler::Handle_wxBoxSizer()
 294 {
 295     return new wxBoxSizer(GetStyle(wxT("orient"), wxHORIZONTAL));
 296 }
 297
 298 #if wxUSE_STATBOX
 299 wxSizer*  wxSizerXmlHandler::Handle_wxStaticBoxSizer()
 300 {
 301     return new wxStaticBoxSizer(
 302             new wxStaticBox(m_parentAsWindow,
 303                             GetID(),
 304                             GetText(wxT("label")),
 305                             wxDefaultPosition, wxDefaultSize,
 306                             0/*style*/,
 307                             GetName()),
 308             GetStyle(wxT("orient"), wxHORIZONTAL));
 309 }
 310 #endif // wxUSE_STATBOX
 311
 312 wxSizer*  wxSizerXmlHandler::Handle_wxGridSizer()
 313 {
 314     return new wxGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
 315                            GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
 316 }
 317
 318
 319 wxFlexGridSizer* wxSizerXmlHandler::Handle_wxFlexGridSizer()
 320 {
 321     return new wxFlexGridSizer(GetLong(wxT("rows")), GetLong(wxT("cols")),
 322                                GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
 323 }
 324
 325
 326 wxGridBagSizer* wxSizerXmlHandler::Handle_wxGridBagSizer()
 327 {
 328     return new wxGridBagSizer(GetDimension(wxT("vgap")), GetDimension(wxT("hgap")));
 329 }
 330
 331 wxSizer*  wxSizerXmlHandler::Handle_wxWrapSizer()
 332 {
 333     wxWrapSizer *sizer = new wxWrapSizer(GetStyle("orient"), GetStyle("flag"));
 334     return sizer;
 335 }
 336
 337
 338
 339 void wxSizerXmlHandler::SetGrowables(wxFlexGridSizer* sizer,
 340                                      const wxChar* param,
 341                                      bool rows)
 342 {
 343     wxStringTokenizer tkn;
 344     unsigned long l;
 345     tkn.SetString(GetParamValue(param), wxT(","));
 346     while (tkn.HasMoreTokens())
 347     {
 348         if (!tkn.GetNextToken().ToULong(&l))
 349         {
 350             ReportParamError
 351             (
 352                 param,
 353                 "value must be comma-separated list of row numbers"
 354             );
 355             break;
 356         }
 357
 358         if (rows)
 359             sizer->AddGrowableRow(l);
 360         else
 361             sizer->AddGrowableCol(l);
 362     }
 363 }
 364
 365
 366 wxGBPosition wxSizerXmlHandler::GetGBPos(const wxString& param)
 367 {
 368     wxSize sz = GetSize(param);
 369     if (sz.x < 0) sz.x = 0;
 370     if (sz.y < 0) sz.y = 0;
 371     return wxGBPosition(sz.x, sz.y);
 372 }
 373
 374 wxGBSpan wxSizerXmlHandler::GetGBSpan(const wxString& param)
 375 {
 376     wxSize sz = GetSize(param);
 377     if (sz.x < 1) sz.x = 1;
 378     if (sz.y < 1) sz.y = 1;
 379     return wxGBSpan(sz.x, sz.y);
 380 }
 381
 382
 383
 384 wxSizerItem* wxSizerXmlHandler::MakeSizerItem()
 385 {
 386     if (m_isGBS)
 387         return new wxGBSizerItem();
 388     else
 389         return new wxSizerItem();
 390 }
 391
 392 void wxSizerXmlHandler::SetSizerItemAttributes(wxSizerItem* sitem)
 393 {
 394     sitem->SetProportion(GetLong(wxT("option")));  // Should this check for "proportion" too?
 395     sitem->SetFlag(GetStyle(wxT("flag")));
 396     sitem->SetBorder(GetDimension(wxT("border")));
 397     wxSize sz = GetSize(wxT("minsize"));
 398     if (!(sz == wxDefaultSize))
 399         sitem->SetMinSize(sz);
 400     sz = GetSize(wxT("ratio"));
 401     if (!(sz == wxDefaultSize))
 402         sitem->SetRatio(sz);
 403
 404     if (m_isGBS)
 405     {
 406         wxGBSizerItem* gbsitem = (wxGBSizerItem*)sitem;
 407         gbsitem->SetPos(GetGBPos(wxT("cellpos")));
 408         gbsitem->SetSpan(GetGBSpan(wxT("cellspan")));
 409     }
 410
 411     // record the id of the item, if any, for use by XRCSIZERITEM()
 412     sitem->SetId(GetID());
 413 }
 414
 415 void wxSizerXmlHandler::AddSizerItem(wxSizerItem* sitem)
 416 {
 417     if (m_isGBS)
 418         ((wxGridBagSizer*)m_parentSizer)->Add((wxGBSizerItem*)sitem);
 419     else
 420         m_parentSizer->Add(sitem);
 421 }
 422
 423
 424
 425 //-----------------------------------------------------------------------------
 426 // wxStdDialogButtonSizerXmlHandler
 427 //-----------------------------------------------------------------------------
 428 #if wxUSE_BUTTON
 429
 430 IMPLEMENT_DYNAMIC_CLASS(wxStdDialogButtonSizerXmlHandler, wxXmlResourceHandler)
 431
 432 wxStdDialogButtonSizerXmlHandler::wxStdDialogButtonSizerXmlHandler()
 433     : m_isInside(false), m_parentSizer(NULL)
 434 {
 435 }
 436
 437 wxObject *wxStdDialogButtonSizerXmlHandler::DoCreateResource()
 438 {
 439     if (m_class == wxT("wxStdDialogButtonSizer"))
 440     {
 441         wxASSERT( !m_parentSizer );
 442
 443         wxSizer *s = m_parentSizer = new wxStdDialogButtonSizer;
 444         m_isInside = true;
 445
 446         CreateChildren(m_parent, true/*only this handler*/);
 447
 448         m_parentSizer->Realize();
 449
 450         m_isInside = false;
 451         m_parentSizer = NULL;
 452
 453         return s;
 454     }
 455     else // m_class == "button"
 456     {
 457         wxASSERT( m_parentSizer );
 458
 459         // find the item to be managed by this sizeritem
 460         wxXmlNode *n = GetParamNode(wxT("object"));
 461         if ( !n )
 462             n = GetParamNode(wxT("object_ref"));
 463
 464         // did we find one?
 465         if (n)
 466         {
 467             wxObject *item = CreateResFromNode(n, m_parent, NULL);
 468             wxButton *button = wxDynamicCast(item, wxButton);
 469
 470             if (button)
 471                 m_parentSizer->AddButton(button);
 472             else
 473                 ReportError(n, "expected wxButton");
 474
 475             return item;
 476         }
 477         else /*n == NULL*/
 478         {
 479             ReportError("no button within wxStdDialogButtonSizer");
 480             return NULL;
 481         }
 482     }
 483 }
 484
 485 bool wxStdDialogButtonSizerXmlHandler::CanHandle(wxXmlNode *node)
 486 {
 487     return (!m_isInside && IsOfClass(node, wxT("wxStdDialogButtonSizer"))) ||
 488            (m_isInside && IsOfClass(node, wxT("button")));
 489 }
 490 #endif // wxUSE_BUTTON
 491
 492 #endif // wxUSE_XRC