Added documentation for wxPGEditor::SetControlAppearance()

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

diff --git a/interface/wx/propgrid/editors.h b/interface/wx/propgrid/editors.h
index 29738a5c22ee858211196d9d47c76d035dacd49f..248c45fb3c446cdeebfb057420c1b89579ae757e 100644 (file)
--- a/interface/wx/propgrid/editors.h
+++ b/interface/wx/propgrid/editors.h
@@ -114,6 +114,30 @@ public:
     virtual void SetValueToUnspecified( wxPGProperty* property,
                                         wxWindow* ctrl ) const = 0;
 
     virtual void SetValueToUnspecified( wxPGProperty* property,
                                         wxWindow* ctrl ) const = 0;
 

+    /**
+        Called by property grid to set new appearance for the control.
+        Default implementation  sets foreground colour, background colour,
+        font, plus text for wxTextCtrl and wxComboCtrl.
+
+        @param appearance
+            New appearance to be applied.
+
+        @param oldAppearance
+            Previously applied appearance. Used to detect which
+            control attributes need to be changed (e.g. so we only
+            change background colour if really needed).
+
+        @param unspecified
+            @true if the new appearance represents an unspecified
+            property value.
+    */
+    virtual void SetControlAppearance( wxPropertyGrid* pg,
+                                       wxPGProperty* property,
+                                       wxWindow* ctrl,
+                                       const wxPGCell& appearance,
+                                       const wxPGCell& oldAppearance,
+                                       bool unspecified ) const;
+

     /** Sets control's value specifically from string. */
     virtual void SetControlStringValue( wxPGProperty* property,
                                         wxWindow* ctrl, const wxString& txt ) const;
     /** Sets control's value specifically from string. */
     virtual void SetControlStringValue( wxPGProperty* property,
                                         wxWindow* ctrl, const wxString& txt ) const;