From: Jaakko Salli <jaakko.salli@dnainternet.net>
Date: Tue, 23 Sep 2008 15:35:32 +0000 (+0000)
Subject: Remove doc references to 'common value' (which is unfinished feature)
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/40924780ea265ba9430b59348c563d78b8c40a71

Remove doc references to 'common value' (which is unfinished feature)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55820 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/include/wx/propgrid/property.h b/include/wx/propgrid/property.h
index cd4ec9f2af..682732813c 100644
--- a/include/wx/propgrid/property.h
+++ b/include/wx/propgrid/property.h
@@ -1420,7 +1420,9 @@ public:
     }
 #endif
 
-    /** Same as GetValueAsString, except takes common value into account.
+    /** To acquire property's value as string, you should use this
+         function (instead of GetValueAsString()), as it may produce
+         more accurate value in future versions.
     */
     wxString GetValueString( int argFlags = 0 ) const;
 
diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h
index 766c51ec63..b5c50da741 100644
--- a/interface/wx/propgrid/property.h
+++ b/interface/wx/propgrid/property.h
@@ -780,17 +780,6 @@ public:
     */
     void DeleteChoice( int index );
 
-    /** Call to enable or disable usage of common value (integer value that can be selected for
-        properties instead of their normal values) for this property.
-
-        Common values are disabled by the default for all properties.
-    */
-    void EnableCommonValue( bool enable = true )
-    {
-        if ( enable ) SetFlag( wxPG_PROP_USES_COMMON_VALUE );
-        else ClearFlag( wxPG_PROP_USES_COMMON_VALUE );
-    }
-
     /** Composes text from values of child properties. */
     void GenerateComposedValue( wxString& text, int argFlags = 0 ) const;
 
@@ -831,7 +820,9 @@ public:
         return m_value;
     }
 
-    /** Same as GetValueAsString, except takes common value into account.
+    /** To acquire property's value as string, you should use this
+         function (instead of GetValueAsString()), as it may produce
+         more accurate value in future versions.
     */
     wxString GetValueString( int argFlags = 0 ) const;
 
@@ -848,10 +839,8 @@ public:
         return (wxPGCell*) m_cells[column];
     }
 
-    /** Return number of displayed common values for this property.
-    */
-    int GetDisplayedCommonValueCount() const;
-
+    /** Returns property's displayed text.
+     */
     wxString GetDisplayedString() const
     {
         return GetValueString(0);
@@ -927,13 +916,6 @@ public:
         return NULL;
     }
 
-    /** Returns common value selected for this property. -1 for none.
-    */
-    int GetCommonValue() const
-    {
-        return m_commonValue;
-    }
-
     /** Returns true if property has even one visible child.
     */
     bool HasVisibleChildren() const;
@@ -1108,13 +1090,6 @@ public:
     */
     void SetChoiceSelection( int newValue );
 
-    /** Sets common value selected for this property. -1 for none.
-    */
-    void SetCommonValue( int commonValue )
-    {
-        m_commonValue = commonValue;
-    }
-
     /** Sets flags from a '|' delimited string. Note that flag names are not
         prepended with 'wxPG_PROP_'.
     */