src/propgrid/propgridiface.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/propgrid/propgridiface.cpp
   3 // Purpose:     wxPropertyGridInterface class
   4 // Author:      Jaakko Salli
   5 // Modified by:
   6 // Created:     2008-08-24
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Jaakko Salli
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx/wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_PROPGRID
  20
  21 #ifndef WX_PRECOMP
  22     #include "wx/defs.h"
  23     #include "wx/object.h"
  24     #include "wx/hash.h"
  25     #include "wx/string.h"
  26     #include "wx/log.h"
  27     #include "wx/event.h"
  28     #include "wx/window.h"
  29     #include "wx/panel.h"
  30     #include "wx/dc.h"
  31     #include "wx/dcmemory.h"
  32     #include "wx/button.h"
  33     #include "wx/pen.h"
  34     #include "wx/brush.h"
  35     #include "wx/settings.h"
  36     #include "wx/sizer.h"
  37     #include "wx/intl.h"
  38 #endif
  39
  40 #include "wx/propgrid/property.h"
  41 #include "wx/propgrid/propgrid.h"
  42
  43
  44 const wxChar *wxPGTypeName_long = wxT("long");
  45 const wxChar *wxPGTypeName_bool = wxT("bool");
  46 const wxChar *wxPGTypeName_double = wxT("double");
  47 const wxChar *wxPGTypeName_wxString = wxT("string");
  48 const wxChar *wxPGTypeName_void = wxT("void*");
  49 const wxChar *wxPGTypeName_wxArrayString = wxT("arrstring");
  50
  51
  52 // ----------------------------------------------------------------------------
  53 // VariantDatas
  54 // ----------------------------------------------------------------------------
  55
  56 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(wxPoint, WXDLLIMPEXP_PROPGRID)
  57 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(wxSize, WXDLLIMPEXP_PROPGRID)
  58 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_DUMMY_EQ(wxArrayInt, WXDLLIMPEXP_PROPGRID)
  59
  60 // For wxLongLong and wxULongLong have custom classname << variant
  61 // implementation for improved flexibility.
  62 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(wxLongLong, WXDLLIMPEXP_PROPGRID)
  63 WX_PG_IMPLEMENT_VARIANT_DATA_EQ(wxLongLong, WXDLLIMPEXP_PROPGRID)
  64 WXDLLIMPEXP_PROPGRID wxLongLong& operator << ( wxLongLong &value, const wxVariant &variant )
  65 {
  66     wxLongLong_t ll;
  67     if ( !wxPGVariantToLongLong(variant, &ll) )
  68     {
  69         wxFAIL_MSG("Cannot convert to wxLongLong");
  70     }
  71     value = ll;
  72     return value;
  73 }
  74 WXDLLIMPEXP_PROPGRID wxLongLong_t& operator << ( wxLongLong_t &value, const wxVariant &variant )
  75 {
  76     if ( !wxPGVariantToLongLong(variant, &value) )
  77     {
  78         wxFAIL_MSG("Cannot convert to wxLongLong");
  79     }
  80     return value;
  81 }
  82
  83 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(wxULongLong, WXDLLIMPEXP_PROPGRID)
  84 WX_PG_IMPLEMENT_VARIANT_DATA_EQ(wxULongLong, WXDLLIMPEXP_PROPGRID)
  85 WXDLLIMPEXP_PROPGRID wxULongLong& operator << ( wxULongLong &value, const wxVariant &variant )
  86 {
  87     wxULongLong_t ull;
  88     if ( !wxPGVariantToULongLong(variant, &ull) )
  89     {
  90         wxFAIL_MSG("Cannot convert to wxULongLong");
  91     }
  92     value = ull;
  93     return value;
  94 }
  95 WXDLLIMPEXP_PROPGRID wxULongLong_t& operator << ( wxULongLong_t &value, const wxVariant &variant )
  96 {
  97     if ( !wxPGVariantToULongLong(variant, &value) )
  98     {
  99         wxFAIL_MSG("Cannot convert to wxULongLong");
 100     }
 101     return value;
 102 }
 103
 104 IMPLEMENT_VARIANT_OBJECT_EXPORTED(wxFont, WXDLLIMPEXP_PROPGRID)
 105
 106 // -----------------------------------------------------------------------
 107 // wxVariant helpers
 108 // -----------------------------------------------------------------------
 109
 110 long wxPGVariantToInt( const wxVariant& variant, long defVal )
 111 {
 112     if ( variant.IsNull() )
 113         return defVal;
 114
 115     if ( variant.GetType() == wxS("long") )
 116         return variant.GetLong();
 117
 118     if ( variant.GetType() == wxS("bool") )
 119         return variant.GetBool() ? 1 : 0;
 120
 121     if ( variant.GetType() == wxS("wxLongLong") )
 122     {
 123         wxLongLong ll;
 124         ll << variant;
 125         if ( ll >= LONG_MAX )
 126             return LONG_MAX;
 127         else if ( ll <= LONG_MIN )
 128             return LONG_MIN;
 129         return ll.ToLong();
 130     }
 131
 132     long l = defVal;
 133
 134     if ( variant.GetType() == wxPG_VARIANT_TYPE_STRING )
 135         variant.GetString().ToLong(&l, 0);
 136
 137     return l;
 138 }
 139
 140 // -----------------------------------------------------------------------
 141
 142 bool wxPGVariantToLongLong( const wxVariant& variant, wxLongLong_t* pResult )
 143 {
 144     if ( variant.IsNull() )
 145         return false;
 146
 147     wxString variantType = variant.GetType();
 148
 149     if ( variantType == wxPG_VARIANT_TYPE_LONG )
 150     {
 151         *pResult = variant.GetLong();
 152         return true;
 153     }
 154
 155     if ( variantType == wxLongLong_VariantType )
 156     {
 157         // NOTE: << operator uses this functions, so we can't use it here
 158         *pResult = wxLongLongRefFromVariant(variant).GetValue();
 159         return true;
 160     }
 161
 162     return false;
 163 }
 164
 165 // -----------------------------------------------------------------------
 166
 167 bool wxPGVariantToULongLong( const wxVariant& variant, wxULongLong_t* pResult )
 168 {
 169     if ( variant.IsNull() )
 170         return false;
 171
 172     wxString variantType = variant.GetType();
 173
 174     if ( variantType == wxPG_VARIANT_TYPE_LONG )
 175     {
 176         *pResult = (unsigned long)variant.GetLong();
 177         return true;
 178     }
 179
 180     if ( variantType == wxULongLong_VariantType )
 181     {
 182         // NOTE: << operator uses this functions, so we can't use it here
 183         *pResult = wxULongLongRefFromVariant(variant).GetValue();
 184         return true;
 185     }
 186
 187     return false;
 188 }
 189
 190 // -----------------------------------------------------------------------
 191
 192 bool wxPGVariantToDouble( const wxVariant& variant, double* pResult )
 193 {
 194     if ( variant.IsNull() )
 195         return false;
 196
 197     wxString variantType = variant.GetType();
 198
 199     if ( variantType == wxPG_VARIANT_TYPE_DOUBLE )
 200     {
 201         *pResult = variant.GetDouble();
 202         return true;
 203     }
 204
 205     if ( variantType == wxPG_VARIANT_TYPE_LONG )
 206     {
 207         *pResult = (double)variant.GetLong();
 208         return true;
 209     }
 210
 211     if ( variantType == wxLongLong_VariantType )
 212     {
 213         wxLongLong ll;
 214         ll << variant;
 215         *pResult = ll.ToDouble();
 216         return true;
 217     }
 218
 219     if ( variantType == wxPG_VARIANT_TYPE_STRING )
 220         if ( variant.GetString().ToDouble(pResult) )
 221             return true;
 222
 223     return false;
 224 }
 225
 226 // -----------------------------------------------------------------------
 227 // wxPGPropArgCls
 228 // -----------------------------------------------------------------------
 229
 230 wxPGProperty* wxPGPropArgCls::GetPtr( wxPropertyGridInterface* iface ) const
 231 {
 232     if ( m_flags == IsProperty )
 233     {
 234         wxASSERT_MSG( m_ptr.property, wxT("invalid property ptr") );
 235         return m_ptr.property;
 236     }
 237     else if ( m_flags & IsWxString )
 238         return iface->GetPropertyByNameA(*m_ptr.stringName);
 239     else if ( m_flags & IsCharPtr )
 240         return iface->GetPropertyByNameA(m_ptr.charName);
 241 #if wxUSE_WCHAR_T
 242     else if ( m_flags & IsWCharPtr )
 243         return iface->GetPropertyByNameA(m_ptr.wcharName);
 244 #endif
 245
 246     return NULL;
 247 }
 248
 249 // -----------------------------------------------------------------------
 250 // wxPropertyGridInterface
 251 // -----------------------------------------------------------------------
 252
 253 void wxPropertyGridInterface::RefreshGrid( wxPropertyGridPageState* state )
 254 {
 255     if ( !state )
 256         state = m_pState;
 257
 258     wxPropertyGrid* grid = state->GetGrid();
 259     if ( grid->GetState() == state && !grid->IsFrozen() )
 260     {
 261         grid->Refresh();
 262     }
 263 }
 264
 265 // -----------------------------------------------------------------------
 266
 267 wxPGProperty* wxPropertyGridInterface::Append( wxPGProperty* property )
 268 {
 269     wxPGProperty* retp = m_pState->DoAppend(property);
 270
 271     wxPropertyGrid* grid = m_pState->GetGrid();
 272     if ( grid )
 273         grid->RefreshGrid();
 274
 275     return retp;
 276 }
 277
 278 // -----------------------------------------------------------------------
 279
 280 wxPGProperty* wxPropertyGridInterface::AppendIn( wxPGPropArg id, wxPGProperty* newproperty )
 281 {
 282     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxNullProperty)
 283     wxPGProperty* pwc = (wxPGProperty*) p;
 284     wxPGProperty* retp = m_pState->DoInsert(pwc, pwc->GetChildCount(), newproperty);
 285     return retp;
 286 }
 287
 288 // -----------------------------------------------------------------------
 289
 290 wxPGProperty* wxPropertyGridInterface::Insert( wxPGPropArg id, wxPGProperty* property )
 291 {
 292     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxNullProperty)
 293     wxPGProperty* retp = m_pState->DoInsert(p->GetParent(), p->GetIndexInParent(), property);
 294     RefreshGrid();
 295     return retp;
 296 }
 297
 298 // -----------------------------------------------------------------------
 299
 300 wxPGProperty* wxPropertyGridInterface::Insert( wxPGPropArg id, int index, wxPGProperty* newproperty )
 301 {
 302     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxNullProperty)
 303     wxPGProperty* retp = m_pState->DoInsert((wxPGProperty*)p,index,newproperty);
 304     RefreshGrid();
 305     return retp;
 306 }
 307
 308 // -----------------------------------------------------------------------
 309
 310 void wxPropertyGridInterface::DeleteProperty( wxPGPropArg id )
 311 {
 312     wxPG_PROP_ARG_CALL_PROLOG()
 313
 314     wxPropertyGridPageState* state = p->GetParentState();
 315     wxPropertyGrid* grid = state->GetGrid();
 316
 317     if ( grid->GetState() == state )
 318         grid->DoSelectProperty(NULL, wxPG_SEL_DELETING|wxPG_SEL_NOVALIDATE);
 319
 320     state->DoDelete( p, true );
 321
 322     RefreshGrid(state);
 323 }
 324
 325 // -----------------------------------------------------------------------
 326
 327 wxPGProperty* wxPropertyGridInterface::RemoveProperty( wxPGPropArg id )
 328 {
 329     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxNullProperty)
 330
 331     wxCHECK( !p->GetChildCount() || p->HasFlag(wxPG_PROP_AGGREGATE),
 332              wxNullProperty);
 333
 334     wxPropertyGridPageState* state = p->GetParentState();
 335     wxPropertyGrid* grid = state->GetGrid();
 336
 337     if ( grid->GetState() == state )
 338     {
 339         grid->DoSelectProperty(NULL,
 340             wxPG_SEL_DELETING|wxPG_SEL_NOVALIDATE);
 341     }
 342
 343     state->DoDelete( p, false );
 344
 345     // Mark the property as 'unattached'
 346     p->m_parentState = NULL;
 347     p->m_parent = NULL;
 348
 349     RefreshGrid(state);
 350
 351     return p;
 352 }
 353
 354 // -----------------------------------------------------------------------
 355
 356 wxPGProperty* wxPropertyGridInterface::ReplaceProperty( wxPGPropArg id, wxPGProperty* property )
 357 {
 358     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxNullProperty)
 359
 360     wxPGProperty* replaced = p;
 361     wxCHECK_MSG( replaced && property,
 362                  wxNullProperty,
 363                  wxT("NULL property") );
 364     wxCHECK_MSG( !replaced->IsCategory(),
 365                  wxNullProperty,
 366                  wxT("cannot replace this type of property") );
 367     wxCHECK_MSG( !m_pState->IsInNonCatMode(),
 368                  wxNullProperty,
 369                  wxT("cannot replace properties in alphabetic mode") );
 370
 371     // Get address to the slot
 372     wxPGProperty* parent = replaced->GetParent();
 373     int ind = replaced->GetIndexInParent();
 374
 375     wxPropertyGridPageState* state = replaced->GetParentState();
 376     DeleteProperty(replaced); // Must use generic Delete
 377     state->DoInsert(parent,ind,property);
 378
 379     return property;
 380 }
 381
 382 // -----------------------------------------------------------------------
 383 // wxPropertyGridInterface property operations
 384 // -----------------------------------------------------------------------
 385
 386 bool wxPropertyGridInterface::ClearSelection( bool validation )
 387 {
 388     int flags = 0;
 389     if ( !validation )
 390         flags |= wxPG_SEL_NOVALIDATE;
 391
 392     wxPropertyGridPageState* state = m_pState;
 393
 394     if ( state )
 395     {
 396         wxPropertyGrid* pg = state->GetGrid();
 397         if ( pg->GetState() == state )
 398             return pg->DoSelectProperty(NULL, flags);
 399         else
 400             state->SetSelection(NULL);
 401     }
 402
 403     return true;
 404 }
 405
 406 // -----------------------------------------------------------------------
 407
 408 void wxPropertyGridInterface::LimitPropertyEditing( wxPGPropArg id, bool limit )
 409 {
 410     wxPG_PROP_ARG_CALL_PROLOG()
 411
 412     m_pState->DoLimitPropertyEditing(p, limit);
 413     RefreshProperty(p);
 414 }
 415
 416 // -----------------------------------------------------------------------
 417
 418 bool wxPropertyGridInterface::EnableProperty( wxPGPropArg id, bool enable )
 419 {
 420     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 421
 422     wxPropertyGridPageState* state = p->GetParentState();
 423     wxPropertyGrid* grid = state->GetGrid();
 424
 425     if ( enable )
 426     {
 427         if ( !(p->m_flags & wxPG_PROP_DISABLED) )
 428             return false;
 429
 430         // If active, Set active Editor.
 431         if ( grid->GetState() == state && p == grid->GetSelection() )
 432             grid->DoSelectProperty( p, wxPG_SEL_FORCE );
 433     }
 434     else
 435     {
 436         if ( p->m_flags & wxPG_PROP_DISABLED )
 437             return false;
 438
 439         // If active, Disable as active Editor.
 440         if ( grid->GetState() == state && p == grid->GetSelection() )
 441             grid->DoSelectProperty( p, wxPG_SEL_FORCE );
 442     }
 443
 444     state->DoEnableProperty(p, enable);
 445
 446     RefreshProperty( p );
 447
 448     return true;
 449 }
 450
 451 // -----------------------------------------------------------------------
 452
 453 bool wxPropertyGridInterface::ExpandAll( bool doExpand )
 454 {
 455     wxPropertyGridPageState* state = m_pState;
 456
 457     if ( !state->DoGetRoot()->GetChildCount() )
 458         return true;
 459
 460     wxPropertyGrid* pg = state->GetGrid();
 461
 462     if ( GetSelection() && GetSelection() != state->DoGetRoot() &&
 463          !doExpand )
 464     {
 465         pg->ClearSelection(false);
 466     }
 467
 468     wxPGVIterator it;
 469
 470     for ( it = GetVIterator( wxPG_ITERATE_ALL ); !it.AtEnd(); it.Next() )
 471     {
 472         wxPGProperty* p = (wxPGProperty*) it.GetProperty();
 473         if ( p->GetChildCount() )
 474         {
 475             if ( doExpand )
 476             {
 477                 if ( !p->IsExpanded() )
 478                 {
 479                     state->DoExpand(p);
 480                 }
 481             }
 482             else
 483             {
 484                 if ( p->IsExpanded() )
 485                 {
 486                     state->DoCollapse(p);
 487                 }
 488             }
 489         }
 490     }
 491
 492     pg->RecalculateVirtualSize();
 493
 494     RefreshGrid();
 495
 496     return true;
 497 }
 498
 499 // -----------------------------------------------------------------------
 500
 501 void wxPropertyGridInterface::SetPropertyValueUnspecified( wxPGPropArg id )
 502 {
 503     wxPG_PROP_ARG_CALL_PROLOG()
 504     wxPropertyGrid* propGrid = p->GetGridIfDisplayed();
 505     if ( propGrid )
 506         propGrid->DoSetPropertyValueUnspecified(p);
 507     else
 508         p->GetParentState()->DoSetPropertyValueUnspecified(p);
 509 }
 510
 511 // -----------------------------------------------------------------------
 512
 513 void wxPropertyGridInterface::ClearModifiedStatus()
 514 {
 515     unsigned int pageIndex = 0;
 516
 517     for (;;)
 518     {
 519         wxPropertyGridPageState* page = GetPageState(pageIndex);
 520         if ( !page ) break;
 521
 522         page->DoGetRoot()->SetFlagRecursively(wxPG_PROP_MODIFIED, false);
 523
 524         pageIndex++;
 525     }
 526
 527     // Update active editor control, if any
 528     GetPropertyGrid()->RefreshEditor();
 529 }
 530
 531 // -----------------------------------------------------------------------
 532 // wxPropertyGridInterface property value setting and getting
 533 // -----------------------------------------------------------------------
 534
 535 void wxPGGetFailed( const wxPGProperty* p, const wxString& typestr )
 536 {
 537     wxPGTypeOperationFailed(p, typestr, wxS("Get"));
 538 }
 539
 540 // -----------------------------------------------------------------------
 541
 542 void wxPGTypeOperationFailed( const wxPGProperty* p,
 543                               const wxString& typestr,
 544                               const wxString& op )
 545 {
 546     wxASSERT( p != NULL );
 547     wxLogError( _("Type operation \"%s\" failed: Property labeled \"%s\" is of type \"%s\", NOT \"%s\"."),
 548         op.c_str(), p->GetLabel().c_str(), p->GetValue().GetType().c_str(), typestr.c_str() );
 549 }
 550
 551 // -----------------------------------------------------------------------
 552
 553 void wxPropertyGridInterface::SetPropVal( wxPGPropArg id, wxVariant& value )
 554 {
 555     wxPG_PROP_ARG_CALL_PROLOG()
 556
 557     if ( p )
 558     {
 559         p->SetValue(value);
 560         wxPropertyGrid* propGrid = p->GetGridIfDisplayed();
 561         if ( propGrid )
 562             propGrid->DrawItemAndValueRelated( p );
 563
 564     }
 565 }
 566
 567 // -----------------------------------------------------------------------
 568
 569 void wxPropertyGridInterface::SetPropertyValueString( wxPGPropArg id, const wxString& value )
 570 {
 571     wxPG_PROP_ARG_CALL_PROLOG()
 572
 573     if ( m_pState->DoSetPropertyValueString(p,value) )
 574     {
 575         wxPropertyGrid* propGrid = p->GetGridIfDisplayed();
 576         if ( propGrid )
 577             propGrid->DrawItemAndValueRelated( p );
 578     }
 579 }
 580
 581 // -----------------------------------------------------------------------
 582
 583 void wxPropertyGridInterface::SetValidationFailureBehavior( int vfbFlags )
 584 {
 585     GetPropertyGrid()->m_permanentValidationFailureBehavior = vfbFlags;
 586 }
 587
 588 // -----------------------------------------------------------------------
 589
 590 wxPGProperty* wxPropertyGridInterface::GetPropertyByNameA( const wxString& name ) const
 591 {
 592     wxPGProperty* p = GetPropertyByName(name);
 593     wxASSERT_MSG(p,wxString::Format(wxT("no property with name '%s'"),name.c_str()));
 594     return p;
 595 }
 596
 597 // ----------------------------------------------------------------------------
 598
 599 wxPGProperty* wxPropertyGridInterface::GetPropertyByLabel( const wxString& label ) const
 600 {
 601     wxPGVIterator it;
 602
 603     for ( it = GetVIterator( wxPG_ITERATE_PROPERTIES ); !it.AtEnd(); it.Next() )
 604     {
 605         if ( it.GetProperty()->GetLabel() == label )
 606             return it.GetProperty();
 607     }
 608
 609     return wxNullProperty;
 610 }
 611
 612 // ----------------------------------------------------------------------------
 613
 614 void wxPropertyGridInterface::DoSetPropertyAttribute( wxPGPropArg id, const wxString& name,
 615                                                       wxVariant& value, long argFlags )
 616 {
 617     wxPG_PROP_ARG_CALL_PROLOG()
 618
 619     p->SetAttribute( name, value );
 620
 621     if ( argFlags & wxPG_RECURSE )
 622     {
 623         unsigned int i;
 624         for ( i = 0; i < p->GetChildCount(); i++ )
 625             DoSetPropertyAttribute(p->Item(i), name, value, argFlags);
 626     }
 627 }
 628
 629 // -----------------------------------------------------------------------
 630
 631 void wxPropertyGridInterface::SetPropertyAttributeAll( const wxString& attrName,
 632                                                        wxVariant value )
 633 {
 634     unsigned int pageIndex = 0;
 635
 636     for (;;)
 637     {
 638         wxPropertyGridPageState* page = GetPageState(pageIndex);
 639         if ( !page ) break;
 640
 641         DoSetPropertyAttribute(page->DoGetRoot(), attrName, value, wxPG_RECURSE);
 642
 643         pageIndex++;
 644     }
 645 }
 646
 647 // -----------------------------------------------------------------------
 648
 649 void wxPropertyGridInterface::GetPropertiesWithFlag( wxArrayPGProperty* targetArr,
 650                                                      wxPGProperty::FlagType flags,
 651                                                      bool inverse,
 652                                                      int iterFlags ) const
 653 {
 654     wxASSERT( targetArr );
 655     wxPGVIterator it = GetVIterator( iterFlags );
 656
 657     for ( ;
 658           !it.AtEnd();
 659           it.Next() )
 660     {
 661         const wxPGProperty* property = it.GetProperty();
 662
 663         if ( !inverse )
 664         {
 665             if ( (property->GetFlags() & flags) == flags )
 666                 targetArr->push_back((wxPGProperty*)property);
 667         }
 668         else
 669         {
 670             if ( (property->GetFlags() & flags) != flags )
 671                 targetArr->push_back((wxPGProperty*)property);
 672         }
 673     }
 674 }
 675
 676 // -----------------------------------------------------------------------
 677
 678 void wxPropertyGridInterface::SetBoolChoices( const wxString& trueChoice,
 679                                                  const wxString& falseChoice )
 680 {
 681     wxPGGlobalVars->m_boolChoices[0] = falseChoice;
 682     wxPGGlobalVars->m_boolChoices[1] = trueChoice;
 683 }
 684
 685 // -----------------------------------------------------------------------
 686
 687 wxPGProperty* wxPropertyGridInterface::DoGetPropertyByName( const wxString& name ) const
 688 {
 689     return m_pState->BaseGetPropertyByName(name);
 690 }
 691
 692 // -----------------------------------------------------------------------
 693
 694 wxPGProperty* wxPropertyGridInterface::GetPropertyByName( const wxString& name,
 695                                                              const wxString& subname ) const
 696 {
 697     wxPGProperty* p = DoGetPropertyByName(name);
 698     if ( !p || !p->GetChildCount() )
 699         return wxNullProperty;
 700
 701     return p->GetPropertyByName(subname);
 702 }
 703
 704 // -----------------------------------------------------------------------
 705
 706 // Since GetPropertyByName is used *a lot*, this makes sense
 707 // since non-virtual method can be called with less code.
 708 wxPGProperty* wxPropertyGridInterface::GetPropertyByName( const wxString& name ) const
 709 {
 710     wxPGProperty* p = DoGetPropertyByName(name);
 711     if ( p )
 712         return p;
 713
 714     // Check if its "Property.SubProperty" format
 715     int pos = name.Find(wxT('.'));
 716     if ( pos <= 0 )
 717         return NULL;
 718
 719     return GetPropertyByName(name.substr(0,pos),
 720                              name.substr(pos+1,name.length()-pos-1));
 721 }
 722
 723 // -----------------------------------------------------------------------
 724
 725 bool wxPropertyGridInterface::HideProperty( wxPGPropArg id, bool hide, int flags )
 726 {
 727     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 728
 729     wxPropertyGrid* pg = m_pState->GetGrid();
 730
 731     if ( pg == p->GetGrid() )
 732         return pg->DoHideProperty(p, hide, flags);
 733     else
 734         m_pState->DoHideProperty(p, hide, flags);
 735
 736     return true;
 737 }
 738
 739 // -----------------------------------------------------------------------
 740
 741 bool wxPropertyGridInterface::Collapse( wxPGPropArg id )
 742 {
 743     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 744     wxPropertyGrid* pg = p->GetGridIfDisplayed();
 745     if ( pg )
 746         return pg->DoCollapse(p);
 747
 748     return p->GetParentState()->DoCollapse(p);
 749 }
 750
 751 // -----------------------------------------------------------------------
 752
 753 bool wxPropertyGridInterface::Expand( wxPGPropArg id )
 754 {
 755     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 756     wxPropertyGrid* pg = p->GetGridIfDisplayed();
 757     if ( pg )
 758         return pg->DoExpand(p);
 759
 760     return p->GetParentState()->DoExpand(p);
 761 }
 762
 763 // -----------------------------------------------------------------------
 764
 765 void wxPropertyGridInterface::SetPropertyLabel( wxPGPropArg id, const wxString& newproplabel )
 766 {
 767     wxPG_PROP_ARG_CALL_PROLOG()
 768
 769     p->SetLabel( newproplabel );
 770
 771     wxPropertyGridPageState* state = p->GetParentState();
 772     wxPropertyGrid* pg = state->GetGrid();
 773
 774     if ( pg->HasFlag(wxPG_AUTO_SORT) )
 775         pg->SortChildren(p->GetParent());
 776
 777     if ( pg->GetState() == state )
 778     {
 779         if ( pg->HasFlag(wxPG_AUTO_SORT) )
 780             pg->Refresh();
 781         else
 782             pg->DrawItem( p );
 783     }
 784 }
 785
 786 // -----------------------------------------------------------------------
 787
 788 bool wxPropertyGridInterface::SetPropertyMaxLength( wxPGPropArg id, int maxLen )
 789 {
 790     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 791
 792     wxPropertyGrid* pg = m_pState->GetGrid();
 793
 794     p->m_maxLen = (short) maxLen;
 795
 796     // Adjust control if selected currently
 797     if ( pg == p->GetGrid() && p == m_pState->GetSelection() )
 798     {
 799         wxWindow* wnd = pg->GetEditorControl();
 800         wxTextCtrl* tc = wxDynamicCast(wnd,wxTextCtrl);
 801         if ( tc )
 802             tc->SetMaxLength( maxLen );
 803         else
 804         // Not a text ctrl
 805             return false;
 806     }
 807
 808     return true;
 809 }
 810
 811 // -----------------------------------------------------------------------
 812
 813 void
 814 wxPropertyGridInterface::SetPropertyBackgroundColour( wxPGPropArg id,
 815                                                       const wxColour& colour,
 816                                                       bool recursively )
 817 {
 818     wxPG_PROP_ARG_CALL_PROLOG()
 819     p->SetBackgroundColour( colour, recursively );
 820     RefreshProperty( p );
 821 }
 822
 823 // -----------------------------------------------------------------------
 824
 825 void wxPropertyGridInterface::SetPropertyTextColour( wxPGPropArg id,
 826                                                      const wxColour& colour,
 827                                                      bool recursively )
 828 {
 829     wxPG_PROP_ARG_CALL_PROLOG()
 830     p->SetTextColour( colour, recursively );
 831     RefreshProperty( p );
 832 }
 833
 834 // -----------------------------------------------------------------------
 835
 836 void wxPropertyGridInterface::SetPropertyColoursToDefault( wxPGPropArg id )
 837 {
 838     wxPG_PROP_ARG_CALL_PROLOG()
 839
 840     p->m_cells.clear();
 841 }
 842
 843 // -----------------------------------------------------------------------
 844
 845 void wxPropertyGridInterface::SetPropertyCell( wxPGPropArg id,
 846                                                int column,
 847                                                const wxString& text,
 848                                                const wxBitmap& bitmap,
 849                                                const wxColour& fgCol,
 850                                                const wxColour& bgCol )
 851 {
 852     wxPG_PROP_ARG_CALL_PROLOG()
 853
 854     wxPGCell& cell = p->GetCell(column);
 855     if ( text.length() && text != wxPG_LABEL )
 856         cell.SetText(text);
 857     if ( bitmap.IsOk() )
 858         cell.SetBitmap(bitmap);
 859     if ( fgCol != wxNullColour )
 860         cell.SetFgCol(fgCol);
 861     if ( bgCol != wxNullColour )
 862         cell.SetBgCol(bgCol);
 863 }
 864
 865 // -----------------------------------------------------------------------
 866 // GetPropertyValueAsXXX methods
 867
 868 #define IMPLEMENT_GET_VALUE(T,TRET,BIGNAME,DEFRETVAL) \
 869 TRET wxPropertyGridInterface::GetPropertyValueAs##BIGNAME( wxPGPropArg id ) const \
 870 { \
 871     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(DEFRETVAL) \
 872     wxVariant value = p->GetValue(); \
 873     if ( wxStrcmp(value.GetType(), wxPGTypeName_##T) != 0 ) \
 874     { \
 875         wxPGGetFailed(p,wxPGTypeName_##T); \
 876         return (TRET)DEFRETVAL; \
 877     } \
 878     return (TRET)value.Get##BIGNAME(); \
 879 }
 880
 881 // String is different than others.
 882 wxString wxPropertyGridInterface::GetPropertyValueAsString( wxPGPropArg id ) const
 883 {
 884     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxEmptyString)
 885     return p->GetValueAsString(wxPG_FULL_VALUE);
 886 }
 887
 888 bool wxPropertyGridInterface::GetPropertyValueAsBool( wxPGPropArg id ) const
 889 {
 890     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 891     wxVariant value = p->GetValue();
 892     if ( wxStrcmp(value.GetType(), wxPGTypeName_bool) == 0 )
 893     {
 894         return value.GetBool();
 895     }
 896     if ( wxStrcmp(value.GetType(), wxPGTypeName_long) == 0 )
 897     {
 898         return value.GetLong()?true:false;
 899     }
 900     wxPGGetFailed(p,wxPGTypeName_bool);
 901     return false;
 902 }
 903
 904 IMPLEMENT_GET_VALUE(long,long,Long,0)
 905 IMPLEMENT_GET_VALUE(double,double,Double,0.0)
 906
 907 bool wxPropertyGridInterface::IsPropertyExpanded( wxPGPropArg id ) const
 908 {
 909     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 910     return p->IsExpanded();
 911 }
 912
 913 // -----------------------------------------------------------------------
 914 // wxPropertyGridInterface wrappers
 915 // -----------------------------------------------------------------------
 916
 917 bool wxPropertyGridInterface::ChangePropertyValue( wxPGPropArg id, wxVariant newValue )
 918 {
 919     return GetPropertyGrid()->ChangePropertyValue(id, newValue);
 920 }
 921
 922 // -----------------------------------------------------------------------
 923
 924 void wxPropertyGridInterface::BeginAddChildren( wxPGPropArg id )
 925 {
 926     wxPG_PROP_ARG_CALL_PROLOG()
 927     wxCHECK_RET( p->HasFlag(wxPG_PROP_AGGREGATE), wxT("only call on properties with fixed children") );
 928     p->ClearFlag(wxPG_PROP_AGGREGATE);
 929     p->SetFlag(wxPG_PROP_MISC_PARENT);
 930 }
 931
 932 // -----------------------------------------------------------------------
 933
 934 bool wxPropertyGridInterface::EditorValidate()
 935 {
 936     return GetPropertyGrid()->DoEditorValidate();
 937 }
 938
 939 // -----------------------------------------------------------------------
 940
 941 void wxPropertyGridInterface::EndAddChildren( wxPGPropArg id )
 942 {
 943     wxPG_PROP_ARG_CALL_PROLOG()
 944     wxCHECK_RET( p->HasFlag(wxPG_PROP_MISC_PARENT), wxT("only call on properties for which BeginAddChildren was called prior") );
 945     p->ClearFlag(wxPG_PROP_MISC_PARENT);
 946     p->SetFlag(wxPG_PROP_AGGREGATE);
 947 }
 948
 949 // -----------------------------------------------------------------------
 950 // wxPGVIterator_State
 951 // -----------------------------------------------------------------------
 952
 953 // Default returned by wxPropertyGridInterface::GetVIterator().
 954 class wxPGVIteratorBase_State : public wxPGVIteratorBase
 955 {
 956 public:
 957     wxPGVIteratorBase_State( wxPropertyGridPageState* state, int flags )
 958     {
 959         m_it.Init( state, flags );
 960     }
 961     virtual ~wxPGVIteratorBase_State() { }
 962     virtual void Next() { m_it.Next(); }
 963 };
 964
 965 wxPGVIterator wxPropertyGridInterface::GetVIterator( int flags ) const
 966 {
 967     return wxPGVIterator( new wxPGVIteratorBase_State( m_pState, flags ) );
 968 }
 969
 970 // -----------------------------------------------------------------------
 971 // wxPGEditableState related functions
 972 // -----------------------------------------------------------------------
 973
 974 // EscapeDelimiters() changes ";" into "\;" and "|" into "\|"
 975 // in the input string.  This is an internal functions which is
 976 // used for saving states
 977 // NB: Similar function exists in aui/framemanager.cpp
 978 static wxString EscapeDelimiters(const wxString& s)
 979 {
 980     wxString result;
 981     result.Alloc(s.length());
 982     const wxChar* ch = s.c_str();
 983     while (*ch)
 984     {
 985         if (*ch == wxT(';') || *ch == wxT('|') || *ch == wxT(','))
 986             result += wxT('\\');
 987         result += *ch;
 988         ++ch;
 989     }
 990     return result;
 991 }
 992
 993 wxString wxPropertyGridInterface::SaveEditableState( int includedStates ) const
 994 {
 995     wxString result;
 996
 997     //
 998     // Save state on page basis
 999     unsigned int pageIndex = 0;
1000     wxArrayPtrVoid pageStates;
1001
1002     for (;;)
1003     {
1004         wxPropertyGridPageState* page = GetPageState(pageIndex);
1005         if ( !page ) break;
1006
1007         pageStates.Add(page);
1008
1009         pageIndex++;
1010     }
1011
1012     for ( pageIndex=0; pageIndex < pageStates.size(); pageIndex++ )
1013     {
1014         wxPropertyGridPageState* pageState = (wxPropertyGridPageState*) pageStates[pageIndex];
1015
1016         if ( includedStates & SelectionState )
1017         {
1018             wxString sel;
1019             if ( pageState->GetSelection() )
1020                 sel = pageState->GetSelection()->GetName();
1021             result += wxS("selection=");
1022             result += EscapeDelimiters(sel);
1023             result += wxS(";");
1024         }
1025         if ( includedStates & ExpandedState )
1026         {
1027             wxArrayPGProperty ptrs;
1028             wxPropertyGridConstIterator it =
1029                 wxPropertyGridConstIterator( pageState,
1030                                              wxPG_ITERATE_ALL_PARENTS_RECURSIVELY|wxPG_ITERATE_HIDDEN,
1031                                              wxNullProperty );
1032
1033             result += wxS("expanded=");
1034
1035             for ( ;
1036                   !it.AtEnd();
1037                   it.Next() )
1038             {
1039                 const wxPGProperty* p = it.GetProperty();
1040
1041                 if ( !p->HasFlag(wxPG_PROP_COLLAPSED) )
1042                     result += EscapeDelimiters(p->GetName());
1043                 result += wxS(",");
1044
1045             }
1046
1047             if ( result.Last() == wxS(',') )
1048                 result.RemoveLast();
1049
1050             result += wxS(";");
1051         }
1052         if ( includedStates & ScrollPosState )
1053         {
1054             int x, y;
1055             GetPropertyGrid()->GetViewStart(&x,&y);
1056             result += wxString::Format(wxS("scrollpos=%i,%i;"), x, y);
1057         }
1058         if ( includedStates & SplitterPosState )
1059         {
1060             result += wxS("splitterpos=");
1061
1062             for ( size_t i=0; i<pageState->GetColumnCount(); i++ )
1063                 result += wxString::Format(wxS("%i,"), pageState->DoGetSplitterPosition(i));
1064
1065             result.RemoveLast();  // Remove last comma
1066             result += wxS(";");
1067         }
1068         if ( includedStates & PageState )
1069         {
1070             result += wxS("ispageselected=");
1071
1072             if ( GetPageState(-1) == pageState )
1073                 result += wxS("1;");
1074             else
1075                 result += wxS("0;");
1076         }
1077         if ( includedStates & DescBoxState )
1078         {
1079             wxVariant v = GetEditableStateItem(wxS("descboxheight"));
1080             if ( !v.IsNull() )
1081                 result += wxString::Format(wxS("descboxheight=%i;"), (int)v.GetLong());
1082         }
1083         result.RemoveLast();  // Remove last semicolon
1084         result += wxS("|");
1085     }
1086
1087     // Remove last '|'
1088     if ( result.length() )
1089         result.RemoveLast();
1090
1091     return result;
1092 }
1093
1094 bool wxPropertyGridInterface::RestoreEditableState( const wxString& src, int restoreStates )
1095 {
1096     wxPropertyGrid* pg = GetPropertyGrid();
1097     wxPGProperty* newSelection = NULL;
1098     size_t pageIndex;
1099     long vx = -1;
1100     long vy = -1;
1101     long selectedPage = -1;
1102     bool pgSelectionSet = false;
1103     bool res = true;
1104
1105     pg->Freeze();
1106     wxArrayString pageStrings = ::wxSplit(src, wxS('|'), wxS('\\'));
1107
1108     for ( pageIndex=0; pageIndex<pageStrings.size(); pageIndex++ )
1109     {
1110         wxPropertyGridPageState* pageState = GetPageState(pageIndex);
1111         if ( !pageState )
1112             break;
1113
1114         wxArrayString kvpairStrings = ::wxSplit(pageStrings[pageIndex], wxS(';'), wxS('\\'));
1115
1116         for ( size_t i=0; i<kvpairStrings.size(); i++ )
1117         {
1118             const wxString& kvs = kvpairStrings[i];
1119             int eq_pos = kvs.Find(wxS('='));
1120             if ( eq_pos != wxNOT_FOUND )
1121             {
1122                 wxString key = kvs.substr(0, eq_pos);
1123                 wxString value = kvs.substr(eq_pos+1);
1124
1125                 // Further split value by commas
1126                 wxArrayString values = ::wxSplit(value, wxS(','), wxS('\\'));
1127
1128                 if ( key == wxS("expanded") )
1129                 {
1130                     if ( restoreStates & ExpandedState )
1131                     {
1132                         wxPropertyGridIterator it =
1133                             wxPropertyGridIterator( pageState,
1134                                                     wxPG_ITERATE_ALL,
1135                                                     wxNullProperty );
1136
1137                         // First collapse all
1138                         for ( ; !it.AtEnd(); it.Next() )
1139                         {
1140                             wxPGProperty* p = it.GetProperty();
1141                             pageState->DoCollapse(p);
1142                         }
1143
1144                         // Then expand those which names are in values
1145                         for ( size_t n=0; n<values.size(); n++ )
1146                         {
1147                             const wxString& name = values[n];
1148                             wxPGProperty* prop = GetPropertyByName(name);
1149                             if ( prop )
1150                                 pageState->DoExpand(prop);
1151                         }
1152                     }
1153                 }
1154                 else if ( key == wxS("scrollpos") )
1155                 {
1156                     if ( restoreStates & ScrollPosState )
1157                     {
1158                         if ( values.size() == 2 )
1159                         {
1160                             values[0].ToLong(&vx);
1161                             values[1].ToLong(&vy);
1162                         }
1163                         else
1164                         {
1165                             res = false;
1166                         }
1167                     }
1168                 }
1169                 else if ( key == wxS("splitterpos") )
1170                 {
1171                     if ( restoreStates & SplitterPosState )
1172                     {
1173                         for ( size_t n=1; n<values.size(); n++ )
1174                         {
1175                             long pos = 0;
1176                             values[n].ToLong(&pos);
1177                             if ( pos > 0 )
1178                                 pageState->DoSetSplitterPosition(pos, n);
1179                         }
1180                     }
1181                 }
1182                 else if ( key == wxS("selection") )
1183                 {
1184                     if ( restoreStates & SelectionState )
1185                     {
1186                         if ( values.size() > 0 )
1187                         {
1188                             if ( pageState->IsDisplayed() )
1189                             {
1190                                 if ( values[0].length() )
1191                                     newSelection = GetPropertyByName(value);
1192                                 pgSelectionSet = true;
1193                             }
1194                             else
1195                             {
1196                                 if ( values[0].length() )
1197                                     pageState->SetSelection(GetPropertyByName(value));
1198                                 else
1199                                     pageState->DoClearSelection();
1200                             }
1201                         }
1202                     }
1203                 }
1204                 else if ( key == wxS("ispageselected") )
1205                 {
1206                     if ( restoreStates & PageState )
1207                     {
1208                         long pageSelStatus;
1209                         if ( values.size() == 1 && values[0].ToLong(&pageSelStatus) )
1210                         {
1211                             if ( pageSelStatus )
1212                                 selectedPage = pageIndex;
1213                         }
1214                         else
1215                         {
1216                             res = false;
1217                         }
1218                     }
1219                 }
1220                 else if ( key == wxS("descboxheight") )
1221                 {
1222                     if ( restoreStates & DescBoxState )
1223                     {
1224                         long descBoxHeight;
1225                         if ( values.size() == 1 && values[0].ToLong(&descBoxHeight) )
1226                         {
1227                             SetEditableStateItem(wxS("descboxheight"), descBoxHeight);
1228                         }
1229                         else
1230                         {
1231                             res = false;
1232                         }
1233                     }
1234                 }
1235                 else
1236                 {
1237                     res = false;
1238                 }
1239             }
1240         }
1241     }
1242
1243     //
1244     // Force recalculation of virtual heights of all pages
1245     // (may be needed on unclean source string).
1246     pageIndex = 0;
1247     wxPropertyGridPageState* pageState = GetPageState(pageIndex);
1248     while ( pageState )
1249     {
1250         pageState->VirtualHeightChanged();
1251         pageIndex += 1;
1252         pageState = GetPageState(pageIndex);
1253     }
1254
1255     pg->Thaw();
1256
1257     //
1258     // Selection of visible grid page must be set after Thaw() call
1259     if ( pgSelectionSet )
1260     {
1261         if ( newSelection )
1262             pg->SelectProperty(newSelection);
1263         else
1264             pg->ClearSelection();
1265     }
1266
1267     if ( selectedPage != -1 )
1268     {
1269         DoSelectPage(selectedPage);
1270     }
1271
1272     if ( vx >= 0 )
1273     {
1274         pg->Scroll(vx, vy);
1275     }
1276
1277     return res;
1278 }
1279
1280 #endif  // wxUSE_PROPGRID
1281