A lot of documentation revision. Updated doctest code in propgrid sample to reflect...

[wxWidgets.git] / src / propgrid / property.cpp

diff --git a/src/propgrid/property.cpp b/src/propgrid/property.cpp
index 158574288b469e19a7aeb45f846aeaa4abcdbfba..262d4648c26341ad56453be9d4cfb078337c968f 100644 (file)
--- a/src/propgrid/property.cpp
+++ b/src/propgrid/property.cpp
@@ -16,6 +16,8 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_PROPGRID
+

 #ifndef WX_PRECOMP
     #include "wx/defs.h"
     #include "wx/object.h"
 #ifndef WX_PRECOMP
     #include "wx/defs.h"
     #include "wx/object.h"


@@ -208,11 +210,16 @@ void wxPGDefaultRenderer::Render( wxDC& dc, const wxRect& rect,
     // Use choice cell?
     if ( column == 1 && (flags & Control) )
     {
     // Use choice cell?
     if ( column == 1 && (flags & Control) )
     {

-        const wxPGCell* ccell = property->GetCurrentChoice();
-        if ( ccell &&
-             ( ccell->GetBitmap().IsOk() || ccell->GetFgCol().IsOk() || ccell->GetBgCol().IsOk() )
-           )
-            cell = ccell;
+        int selectedIndex = property->GetChoiceSelection();
+        if ( selectedIndex != wxNOT_FOUND )
+        {
+            const wxPGChoices& choices = property->GetChoices();
+            const wxPGCell* ccell = &choices[selectedIndex];
+            if ( ccell &&
+                 ( ccell->GetBitmap().IsOk() || ccell->GetFgCol().IsOk() || ccell->GetBgCol().IsOk() )
+               )
+                cell = ccell;
+        }

     }
 
     if ( cell )
     }
 
     if ( cell )


@@ -774,22 +781,24 @@ bool wxPGProperty::StringToValue( wxVariant& variant, const wxString& text, int
 
                     const wxPGProperty* child = Item(curChild);
 
 
                     const wxPGProperty* child = Item(curChild);
 

-                    wxVariant variant(child->GetValueRef());
-                    if ( child->StringToValue( variant, token, propagatedFlags ) )
+                    wxVariant oldChildValue = child->GetValue();
+                    wxVariant variant(oldChildValue);
+                    bool stvRes = child->StringToValue( variant, token, propagatedFlags );
+                    if ( stvRes || (variant != oldChildValue) )

                     {
                     {

-                        variant.SetName(child->GetBaseName());
-                        list.Append(variant);
-                        changed = true;
+                        if ( stvRes )
+                            changed = true;

                     }
                     else
                     {
                         // Failed, becomes unspecified
                     }
                     else
                     {
                         // Failed, becomes unspecified

-                        wxVariant variant2;
-                        variant2.SetName(child->GetBaseName());
-                        list.Append(variant2);
+                        variant.MakeNull();

                         changed = true;
                     }
 
                         changed = true;
                     }
 

+                    variant.SetName(child->GetBaseName());
+                    list.Append(variant);
+

                     curChild++;
                     if ( curChild >= iMax )
                         break;
                     curChild++;
                     if ( curChild >= iMax )
                         break;


@@ -898,7 +907,7 @@ void wxPGProperty::SetValue( wxVariant value, wxVariant* pList, int flags )
         // List variants are reserved a special purpose
         // as intermediate containers for child values
         // of properties with children.
         // List variants are reserved a special purpose
         // as intermediate containers for child values
         // of properties with children.

-        if ( wxPGIsVariantType(value, list) )
+        if ( value.GetType() == wxPG_VARIANT_TYPE_LIST )

         {
             //
             // However, situation is different for composed string properties
         {
             //
             // However, situation is different for composed string properties


@@ -919,7 +928,7 @@ void wxPGProperty::SetValue( wxVariant value, wxVariant* pList, int flags )
 
         if ( pList && !pList->IsNull() )
         {
 
         if ( pList && !pList->IsNull() )
         {

-            wxASSERT( wxPGIsVariantType(*pList, list) );
+            wxASSERT( pList->GetType() == wxPG_VARIANT_TYPE_LIST );

             wxASSERT( GetChildCount() );
             wxASSERT( !IsCategory() );
 
             wxASSERT( GetChildCount() );
             wxASSERT( !IsCategory() );
 


@@ -938,7 +947,7 @@ void wxPGProperty::SetValue( wxVariant value, wxVariant* pList, int flags )
                 if ( child )
                 {
                     //wxLogDebug(wxT("%i: child = %s, childValue.GetType()=%s"),i,child->GetBaseName().c_str(),childValue.GetType().c_str());
                 if ( child )
                 {
                     //wxLogDebug(wxT("%i: child = %s, childValue.GetType()=%s"),i,child->GetBaseName().c_str(),childValue.GetType().c_str());

-                    if ( wxPGIsVariantType(childValue, list) )
+                    if ( childValue.GetType() == wxPG_VARIANT_TYPE_LIST )

                     {
                         if ( child->HasFlag(wxPG_PROP_AGGREGATE) && !(flags & wxPG_SETVAL_AGGREGATED) )
                         {
                     {
                         if ( child->HasFlag(wxPG_PROP_AGGREGATE) && !(flags & wxPG_SETVAL_AGGREGATED) )
                         {


@@ -951,7 +960,7 @@ void wxPGProperty::SetValue( wxVariant value, wxVariant* pList, int flags )
                             child->SetValue(oldVal, &childValue, flags|wxPG_SETVAL_FROM_PARENT);
                         }
                     }
                             child->SetValue(oldVal, &childValue, flags|wxPG_SETVAL_FROM_PARENT);
                         }
                     }

-                    else if ( !wxPG_VARIANT_EQ(child->GetValue(), childValue) )
+                    else if ( child->GetValue() != childValue )

                     {
                         // For aggregate properties, we will trust RefreshChildren()
                         // to update child values.
                     {
                         // For aggregate properties, we will trust RefreshChildren()
                         // to update child values.


@@ -967,7 +976,7 @@ void wxPGProperty::SetValue( wxVariant value, wxVariant* pList, int flags )
 
         if ( !value.IsNull() )
         {
 
         if ( !value.IsNull() )
         {

-            wxPGVariantAssign(m_value, value);
+            m_value = value;

             OnSetValue();
 
             if ( !(flags & wxPG_SETVAL_FROM_PARENT) )
             OnSetValue();
 
             if ( !(flags & wxPG_SETVAL_FROM_PARENT) )


@@ -1053,34 +1062,34 @@ wxVariant wxPGProperty::GetDefaultValue() const
 
     if ( !value.IsNull() )
     {
 
     if ( !value.IsNull() )
     {

-        wxPGVariantDataClassInfo classInfo = wxPGVariantDataGetClassInfo(value.GetData());
-        if ( wxPGIsVariantClassInfo(classInfo, long) )
+        wxString valueType(value.GetType());
+
+        if ( valueType == wxPG_VARIANT_TYPE_LONG )

             return wxPGVariant_Zero;
             return wxPGVariant_Zero;

-        if ( wxPGIsVariantClassInfo(classInfo, string) )
+        if ( valueType == wxPG_VARIANT_TYPE_STRING )

             return wxPGVariant_EmptyString;
             return wxPGVariant_EmptyString;

-        if ( wxPGIsVariantClassInfo(classInfo, bool) )
+        if ( valueType == wxPG_VARIANT_TYPE_BOOL )

             return wxPGVariant_False;
             return wxPGVariant_False;

-        if ( wxPGIsVariantClassInfo(classInfo, double) )
+        if ( valueType == wxPG_VARIANT_TYPE_DOUBLE )

             return wxVariant(0.0);
             return wxVariant(0.0);

-
-        wxPGVariantData* pgvdata = wxDynamicCastVariantData(m_value.GetData(), wxPGVariantData);
-        if ( pgvdata )
-            return pgvdata->GetDefaultValue();
-
-        if ( wxPGIsVariantClassInfo(classInfo, arrstring) )
+        if ( valueType == wxPG_VARIANT_TYPE_ARRSTRING )

             return wxVariant(wxArrayString());
             return wxVariant(wxArrayString());

-        if ( wxPGIsVariantClassInfo(classInfo, wxColour) )
-            return WXVARIANT(*wxRED);
+        if ( valueType == wxS("wxLongLong") )
+            return WXVARIANT(wxLongLong(0));
+        if ( valueType == wxS("wxULongLong") )
+            return WXVARIANT(wxULongLong(0));
+        if ( valueType == wxS("wxColour") )
+            return WXVARIANT(*wxBLACK);

 #if wxUSE_DATETIME
 #if wxUSE_DATETIME

-        if ( wxPGIsVariantClassInfo(classInfo, datetime) )
+        if ( valueType == wxPG_VARIANT_TYPE_DATETIME )

             return wxVariant(wxDateTime::Now());
 #endif
             return wxVariant(wxDateTime::Now());
 #endif

-
-        wxFAIL_MSG(
-            wxString::Format(wxT("Inorder for value to have default value, it must be added to")
-                             wxT("wxPGProperty::GetDefaultValue or it's variantdata must inherit")
-                             wxT("from wxPGVariantData (unrecognized type was '%s')"),m_value.GetType().c_str())
-                  );
+        if ( valueType == wxS("wxFont") )
+            return WXVARIANT(*wxNORMAL_FONT);
+        if ( valueType == wxS("wxPoint") )
+            return WXVARIANT(wxPoint(0, 0));
+        if ( valueType == wxS("wxSize") )
+            return WXVARIANT(wxSize(0, 0));

     }
 
     return wxVariant();
     }
 
     return wxVariant();


@@ -1095,104 +1104,6 @@ void wxPGProperty::SetCell( int column, wxPGCell* cellObj )
     m_cells[column] = cellObj;
 }
 
     m_cells[column] = cellObj;
 }
 

-void wxPGProperty::SetChoiceSelection( int newValue, const wxPGChoiceInfo& choiceInfo )
-{
-    // Changes value of a property with choices, but only
-    // works if the value type is long or string.
-    wxString ts = GetValue().GetType();
-
-    wxCHECK_RET( choiceInfo.m_choices, wxT("invalid choiceinfo") );
-
-    if ( ts == wxS("long") )
-    {
-        SetValue( (long) newValue );
-    }
-    else if ( ts == wxS("string") )
-    {
-        SetValue( choiceInfo.m_choices->GetLabel(newValue) );
-    }
-}
-
-
-wxString wxPGProperty::GetChoiceString( unsigned int index )
-{
-    wxPGChoiceInfo ci;
-    GetChoiceInfo(&ci);
-    wxASSERT(ci.m_choices);
-    return ci.m_choices->GetLabel(index);
-}
-
-int wxPGProperty::InsertChoice( const wxString& label, int index, int value )
-{
-    wxPropertyGrid* pg = GetGrid();
-
-    wxPGChoiceInfo ci;
-    ci.m_choices = (wxPGChoices*) NULL;
-    int sel = GetChoiceInfo(&ci);
-
-    if ( ci.m_choices )
-    {
-        int newSel = sel;
-
-        if ( index < 0 )
-            index = ci.m_choices->GetCount();
-
-        if ( index <= sel )
-            newSel++;
-
-        ci.m_choices->Insert(label, index, value);
-
-        if ( sel != newSel )
-            SetChoiceSelection(newSel, ci);
-
-        if ( this == pg->GetSelection() )
-            GetEditorClass()->InsertItem(pg->GetEditorControl(),label,index);
-
-        return index;
-    }
-
-    return -1;
-}
-
-
-void wxPGProperty::DeleteChoice( int index )
-{
-    wxPropertyGrid* pg = GetGrid();
-
-    wxPGChoiceInfo ci;
-    ci.m_choices = (wxPGChoices*) NULL;
-    int sel = GetChoiceInfo(&ci);
-
-    if ( ci.m_choices )
-    {
-        int newSel = sel;
-
-        // Adjust current value
-        if ( sel == index )
-        {
-            SetValueToUnspecified();
-            newSel = 0;
-        }
-        else if ( index < sel )
-        {
-            newSel--;
-        }
-
-        ci.m_choices->RemoveAt(index);
-
-        if ( sel != newSel )
-            SetChoiceSelection(newSel, ci);
-
-        if ( this == pg->GetSelection() )
-            GetEditorClass()->DeleteItem(pg->GetEditorControl(), index);
-    }
-}
-
-int wxPGProperty::GetChoiceInfo( wxPGChoiceInfo* WXUNUSED(info) )
-{
-    return -1;
-}
-

 wxPGEditorDialogAdapter* wxPGProperty::GetEditorDialog() const
 {
     return NULL;
 wxPGEditorDialogAdapter* wxPGProperty::GetEditorDialog() const
 {
     return NULL;


@@ -1345,63 +1256,116 @@ wxValidator* wxPGProperty::DoGetValidator() const
     return (wxValidator*) NULL;
 }
 
     return (wxValidator*) NULL;
 }
 

-wxPGChoices& wxPGProperty::GetChoices()
+int wxPGProperty::InsertChoice( const wxString& label, int index, int value )

 {
 {

-    wxPGChoiceInfo choiceInfo;
-    choiceInfo.m_choices = NULL;
-    GetChoiceInfo(&choiceInfo);
-    return *choiceInfo.m_choices;
+    wxPropertyGrid* pg = GetGrid();
+    int sel = GetChoiceSelection();
+
+    int newSel = sel;
+
+    if ( index == wxNOT_FOUND )
+        index = m_choices.GetCount();
+
+    if ( index <= sel )
+        newSel++;
+
+    m_choices.Insert(label, index, value);
+
+    if ( sel != newSel )
+        SetChoiceSelection(newSel);
+
+    if ( this == pg->GetSelection() )
+        GetEditorClass()->InsertItem(pg->GetEditorControl(),label,index);
+
+    return index;

 }
 
 }
 

-const wxPGChoices& wxPGProperty::GetChoices() const
+
+void wxPGProperty::DeleteChoice( int index )

 {
 {

-    return (const wxPGChoices&) ((wxPGProperty*)this)->GetChoices();
+    wxPropertyGrid* pg = GetGrid();
+
+    int sel = GetChoiceSelection();
+    int newSel = sel;
+
+    // Adjust current value
+    if ( sel == index )
+    {
+        SetValueToUnspecified();
+        newSel = 0;
+    }
+    else if ( index < sel )
+    {
+        newSel--;
+    }
+
+    m_choices.RemoveAt(index);
+
+    if ( sel != newSel )
+        SetChoiceSelection(newSel);
+
+    if ( this == pg->GetSelection() )
+        GetEditorClass()->DeleteItem(pg->GetEditorControl(), index);

 }
 
 }
 

-unsigned int wxPGProperty::GetChoiceCount() const
+int wxPGProperty::GetChoiceSelection() const

 {
 {

-    const wxPGChoices& choices = GetChoices();
-    if ( &choices && choices.IsOk() )
-        return choices.GetCount();
-    return 0;
+    wxVariant value = GetValue();
+    wxString valueType = value.GetType();
+    int index = wxNOT_FOUND;
+
+    if ( IsValueUnspecified() || !m_choices.GetCount() )
+        return wxNOT_FOUND;
+
+    if ( valueType == wxPG_VARIANT_TYPE_LONG )
+    {
+        index = value.GetLong();
+    }
+    else if ( valueType == wxPG_VARIANT_TYPE_STRING )
+    {
+        index = m_choices.Index(value.GetString());
+    }
+    else if ( valueType == wxPG_VARIANT_TYPE_BOOL )
+    {
+        index = value.GetBool()? 1 : 0;
+    }
+
+    return index;

 }
 
 }
 

-const wxPGChoiceEntry* wxPGProperty::GetCurrentChoice() const
+void wxPGProperty::SetChoiceSelection( int newValue )

 {
 {

-    wxPGChoiceInfo ci;
-    ci.m_choices = (wxPGChoices*) NULL;
-    int index = ((wxPGProperty*)this)->GetChoiceInfo(&ci);
-    if ( index == -1 || !ci.m_choices || index >= (int)ci.m_choices->GetCount() )
-        return NULL;
+    // Changes value of a property with choices, but only
+    // works if the value type is long or string.
+    wxString valueType = GetValue().GetType();
+
+    wxCHECK_RET( m_choices.IsOk(), wxT("invalid choiceinfo") );

 
 

-    return &(*ci.m_choices)[index];
+    if ( valueType == wxPG_VARIANT_TYPE_STRING )
+    {
+        SetValue( m_choices.GetLabel(newValue) );
+    }
+    else  // if ( valueType == wxPG_VARIANT_TYPE_LONG )
+    {
+        SetValue( (long) newValue );
+    }

 }
 
 bool wxPGProperty::SetChoices( wxPGChoices& choices )
 {
 }
 
 bool wxPGProperty::SetChoices( wxPGChoices& choices )
 {

-    wxPGChoiceInfo ci;
-    ci.m_choices = (wxPGChoices*) NULL;
+    m_choices.Assign(choices);

 
 

-    // Unref existing
-    GetChoiceInfo(&ci);
-    if ( ci.m_choices )

     {
     {

-        ci.m_choices->Assign(choices);
-
-        //if ( m_parent )
-        {
-            // This may be needed to trigger some initialization
-            // (but don't do it if property is somewhat uninitialized)
-            wxVariant defVal = GetDefaultValue();
-            if ( defVal.IsNull() )
-                return false;
-
-            SetValue(defVal);
+        // This may be needed to trigger some initialization
+        // (but don't do it if property is somewhat uninitialized)
+        wxVariant defVal = GetDefaultValue();
+        if ( defVal.IsNull() )
+            return false;

 
 

-            return true;
-        }
+        SetValue(defVal);

     }
     }

-    return false;
+
+    return true;

 }
 
 
 }
 
 


@@ -1432,18 +1396,6 @@ const wxPGEditor* wxPGProperty::GetEditorClass() const
     return editor;
 }
 
     return editor;
 }
 

-
-// Privatizes set of choices
-void wxPGProperty::SetChoicesExclusive()
-{
-    wxPGChoiceInfo ci;
-    ci.m_choices = (wxPGChoices*) NULL;
-
-    GetChoiceInfo(&ci);
-    if ( ci.m_choices )
-        ci.m_choices->SetExclusive();
-}
-

 bool wxPGProperty::HasVisibleChildren() const
 {
     unsigned int i;
 bool wxPGProperty::HasVisibleChildren() const
 {
     unsigned int i;


@@ -1672,7 +1624,7 @@ void wxPGProperty::AdaptListToValue( wxVariant& list, wxVariant* value ) const
         {
             //wxLogDebug(wxT("  %s(n=%i), %s"),childValue.GetName().c_str(),n,childValue.GetType().c_str());
 
         {
             //wxLogDebug(wxT("  %s(n=%i), %s"),childValue.GetName().c_str(),n,childValue.GetType().c_str());
 

-            if ( wxPGIsVariantType(childValue, list) )
+            if ( childValue.GetType() == wxPG_VARIANT_TYPE_LIST )

             {
                 wxVariant cv2(child->GetValue());
                 child->AdaptListToValue(childValue, &cv2);
             {
                 wxVariant cv2(child->GetValue());
                 child->AdaptListToValue(childValue, &cv2);


@@ -1916,7 +1868,7 @@ bool wxPGProperty::AreAllChildrenSpecified( wxVariant* pendingList ) const
         {
             const wxVariant* childList = NULL;
 
         {
             const wxVariant* childList = NULL;
 

-            if ( listValue && wxPGIsVariantType(*listValue, list) )
+            if ( listValue && listValue->GetType() == wxPG_VARIANT_TYPE_LIST )

                 childList = listValue;
 
             if ( !child->AreAllChildrenSpecified((wxVariant*)childList) )
                 childList = listValue;
 
             if ( !child->AreAllChildrenSpecified((wxVariant*)childList) )


@@ -2165,3 +2117,4 @@ void wxPGAttributeStorage::Set( const wxString& name, const wxVariant& value )
     m_map[name] = data;
 }
 
     m_map[name] = data;
 }
 

+#endif  // wxUSE_PROPGRID