Applied minor documentation corrections to wxRegKey from charles (fixes #10407).

[wxWidgets.git] / interface / wx / propgrid / property.h

diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h
index 235d7dc0979ce0683bc5c8c24d5bdc319ca3d1d9..372e6d401e33df9e119938ee594ef99886cb2c3f 100644 (file)
--- a/interface/wx/propgrid/property.h
+++ b/interface/wx/propgrid/property.h
@@ -115,7 +115,8 @@
 #define wxPG_DATE_FORMAT                    wxS("DateFormat")
 
 /** Sets wxDatePickerCtrl window style used with wxDateProperty. Default
 #define wxPG_DATE_FORMAT                    wxS("DateFormat")
 
 /** Sets wxDatePickerCtrl window style used with wxDateProperty. Default

-    is wxDP_DEFAULT | wxDP_SHOWCENTURY.
+    is wxDP_DEFAULT | wxDP_SHOWCENTURY. Using wxDP_ALLOWNONE will enable
+    better unspecified value support in the editor.

 */
 #define wxPG_DATE_PICKER_STYLE              wxS("PickerStyle")
 
 */
 #define wxPG_DATE_PICKER_STYLE              wxS("PickerStyle")
 


@@ -128,6 +129,11 @@
 */
 #define wxPG_ATTR_SPINCTRL_WRAP             wxS("Wrap")
 
 */
 #define wxPG_ATTR_SPINCTRL_WRAP             wxS("Wrap")
 

+/** SpinCtrl editor, bool. If @true, value can also by changed by moving
+    mouse when left mouse button is being pressed.
+*/
+#define wxPG_ATTR_SPINCTRL_MOTIONSPIN       wxS("MotionSpin")
+

 /** wxMultiChoiceProperty, int. If 0, no user strings allowed. If 1, user strings
     appear before list strings. If 2, user strings appear after list string.
 */
 /** wxMultiChoiceProperty, int. If 0, no user strings allowed. If 1, user strings
     appear before list strings. If 2, user strings appear after list string.
 */


@@ -305,6 +311,7 @@
     string wxDateTime::Format uses (altough default is recommended as it is
     locale-dependant), and wxPG_DATE_PICKER_STYLE allows changing window
     style given to DatePickerCtrl (default is wxDP_DEFAULT|wxDP_SHOWCENTURY).
     string wxDateTime::Format uses (altough default is recommended as it is
     locale-dependant), and wxPG_DATE_PICKER_STYLE allows changing window
     style given to DatePickerCtrl (default is wxDP_DEFAULT|wxDP_SHOWCENTURY).

+    Using wxDP_ALLOWNONE will enable better unspecified value support.

 
     @subsection wxEditEnumProperty
 
 
     @subsection wxEditEnumProperty
 


@@ -848,10 +855,13 @@ public:
     virtual wxPGEditorDialogAdapter* GetEditorDialog() const;
 
     /**
     virtual wxPGEditorDialogAdapter* GetEditorDialog() const;
 
     /**

-        Returns wxPGCell of given column, @NULL if none. If valid
-        object is returned, caller will gain its ownership.
+        Called whenever validation has failed with given pending value.
+
+        @remarks If you implement this in your custom property class, please
+                 remember to call the baser implementation as well, since they
+                 may use it to revert property into pre-change state.

     */
     */

-    wxPGCell* AcquireCell( unsigned int column );
+    virtual void OnValidationFailure( wxVariant& pendingValue );

 
     /**
         Append a new choice to property's list of choices.
 
     /**
         Append a new choice to property's list of choices.


@@ -908,6 +918,11 @@ public:
     */
     bool AreChildrenComponents() const;
 
     */
     bool AreChildrenComponents() const;
 

+    /**
+        Deletes children of the property.
+    */
+    void DeleteChildren();
+

     /**
         Removes entry from property's wxPGChoices and editor control (if it is active).
 
     /**
         Removes entry from property's wxPGChoices and editor control (if it is active).
 


@@ -954,10 +969,9 @@ public:
     const wxString& GetBaseName() const;
 
     /**
     const wxString& GetBaseName() const;
 
     /**

-        Returns wxPGCell of given column, @NULL if none. wxPGProperty
-        will retain ownership of the cell object.
+        Returns wxPGCell of given column.

     */
     */

-    wxPGCell* GetCell( unsigned int column ) const;
+    const wxPGCell& GetCell( unsigned int column ) const;

 
     /**
         Returns number of child properties.
 
     /**
         Returns number of child properties.


@@ -1218,6 +1232,19 @@ public:
     */
     void SetAttribute( const wxString& name, wxVariant value );
 
     */
     void SetAttribute( const wxString& name, wxVariant value );
 

+    /**
+        Sets property's background colour.
+
+        @param colour
+            Background colour to use.
+
+        @param recursively
+            If @true, children are affected recursively, and any categories
+            are not.
+    */
+    void SetBackgroundColour( const wxColour& colour,
+                              bool recursively = false );
+

     /**
         Sets editor for a property.
 
     /**
         Sets editor for a property.
 


@@ -1236,10 +1263,8 @@ public:
 
     /**
         Sets cell information for given column.
 
     /**
         Sets cell information for given column.

-
-        Note that the property takes ownership of given wxPGCell instance.

     */
     */

-    void SetCell( int column, wxPGCell* cellObj );
+    void SetCell( int column, const wxPGCell& cell );

 
     /**
         Sets new set of choices for property.
 
     /**
         Sets new set of choices for property.


@@ -1319,6 +1344,19 @@ public:
     */
     void SetParentalType( int flag );
 
     */
     void SetParentalType( int flag );
 

+    /**
+        Sets property's text colour.
+
+        @param colour
+            Text colour to use.
+
+        @param recursively
+            If @true, children are affected recursively, and any categories
+            are not.
+    */
+    void SetTextColour( const wxColour& colour,
+                        bool recursively = false );
+

     /** Sets wxValidator for a property */
     void SetValidator( const wxValidator& validator );
 
     /** Sets wxValidator for a property */
     void SetValidator( const wxValidator& validator );