Replaced 'InlineHelp' property attribute with 'Hint'; Use SetHint() wxTextCtrl and...

[wxWidgets.git] / include / wx / propgrid / propgrid.h

diff --git a/include/wx/propgrid/propgrid.h b/include/wx/propgrid/propgrid.h
index db6c2bb94ddf3b0bee74685a543cbe5725c00034..90b8ba90041de9eef71938050cba5be5fc7ae7e2 100644 (file)
--- a/include/wx/propgrid/propgrid.h
+++ b/include/wx/propgrid/propgrid.h
@@ -87,7 +87,10 @@ public:
     wxPGCachedString    m_strMin;
     wxPGCachedString    m_strMax;
     wxPGCachedString    m_strUnits;
     wxPGCachedString    m_strMin;
     wxPGCachedString    m_strMax;
     wxPGCachedString    m_strUnits;

+    wxPGCachedString    m_strHint;
+#if wxPG_COMPATIBILITY_1_4

     wxPGCachedString    m_strInlineHelp;
     wxPGCachedString    m_strInlineHelp;

+#endif

 
     // If true then some things are automatically translated
     bool                m_autoGetTranslation;
 
     // If true then some things are automatically translated
     bool                m_autoGetTranslation;


@@ -1239,6 +1242,41 @@ public:
         return m_sortFunction;
     }
 
         return m_sortFunction;
     }
 

+    /**
+        Sets appearance of value cells representing an unspecified property
+        value. Default appearance is blank.
+
+        @remarks If you set the unspecified value to have any
+                 textual representation, then that will override
+                 "InlineHelp" attribute.
+
+        @see wxPGProperty::SetValueToUnspecified(),
+             wxPGProperty::IsValueUnspecified()
+    */
+    void SetUnspecifiedValueAppearance( const wxPGCell& cell )
+    {
+        m_unspecifiedAppearance = m_propertyDefaultCell;
+        m_unspecifiedAppearance.MergeFrom(cell);
+    }
+
+    /**
+        Returns current appearance of unspecified value cells.
+
+        @see SetUnspecifiedValueAppearance()
+    */
+    const wxPGCell& GetUnspecifiedValueAppearance() const
+    {
+        return m_unspecifiedAppearance;
+    }
+
+    /**
+        Returns (visual) text representation of the unspecified
+        property value.
+
+        @param argFlags For internal use only.
+    */
+    wxString GetUnspecifiedValueText( int argFlags = 0 ) const;
+

     /** Set virtual width for this particular page. Width -1 indicates that the
         virtual width should be disabled. */
     void SetVirtualWidth( int width );
     /** Set virtual width for this particular page. Width -1 indicates that the
         virtual width should be disabled. */
     void SetVirtualWidth( int width );


@@ -1756,6 +1794,12 @@ protected:
     /** Actions and keys that trigger them. */
     wxPGHashMapI2I      m_actionTriggers;
 
     /** Actions and keys that trigger them. */
     wxPGHashMapI2I      m_actionTriggers;
 

+    /** Appearance of currently active editor. */
+    wxPGCell            m_editorAppearance;
+
+    /** Appearance of a unspecified value cell. */
+    wxPGCell            m_unspecifiedAppearance;
+

     //
     // Temporary values
     //
     //
     // Temporary values
     //


@@ -2054,6 +2098,16 @@ protected:
     */
     void RecalculateVirtualSize( int forceXPos = -1 );
 
     */
     void RecalculateVirtualSize( int forceXPos = -1 );
 

+    void SetEditorAppearance( const wxPGCell& cell,
+                              bool unspecified = false );
+
+    void ResetEditorAppearance()
+    {
+        wxPGCell cell;
+        cell.SetEmptyData();
+        SetEditorAppearance(cell, false);
+    }
+

     void PrepareAfterItemsAdded();
 
     /**
     void PrepareAfterItemsAdded();
 
     /**


@@ -2095,6 +2149,22 @@ inline unsigned int wxPropertyGridPageState::GetActualVirtualHeight() const
 }
 #endif
 
 }
 #endif
 

+wxString wxPGProperty::GetHintText() const
+{
+    wxVariant vHintText = GetAttribute(wxPGGlobalVars->m_strHint);
+
+#if wxPG_COMPATIBILITY_1_4
+    // Try the old, deprecated "InlineHelp"
+    if ( vHintText.IsNull() )
+        vHintText = GetAttribute(wxPGGlobalVars->m_strInlineHelp);
+#endif
+
+    if ( !vHintText.IsNull() )
+        return vHintText.GetString();
+
+    return wxEmptyString;
+}
+

 inline int wxPGProperty::GetDisplayedCommonValueCount() const
 {
     if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE) )
 inline int wxPGProperty::GetDisplayedCommonValueCount() const
 {
     if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE) )