Fixed RefreshRect() call in wxPropertyGrid::DrawItems() to use physical window coordi...

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

diff --git a/include/wx/propgrid/propgridiface.h b/include/wx/propgrid/propgridiface.h
index 29d0116aad92fcd2aeba263b40432f14986b3669..7b4041b4caa6d1188a8a3c4f40880e95ecf4b336 100644 (file)
--- a/include/wx/propgrid/propgridiface.h
+++ b/include/wx/propgrid/propgridiface.h
@@ -19,8 +19,6 @@
 
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------
 

-#ifndef SWIG
-

 /** @section wxPGPropArgCls
 
     Most property grid functions have this type as their argument, as it can
 /** @section wxPGPropArgCls
 
     Most property grid functions have this type as their argument, as it can


@@ -110,8 +108,6 @@ private:
     unsigned char m_flags;
 };
 
     unsigned char m_flags;
 };
 

-#endif
-

 typedef const wxPGPropArgCls& wxPGPropArg;
 
 // -----------------------------------------------------------------------
 typedef const wxPGPropArgCls& wxPGPropArg;
 
 // -----------------------------------------------------------------------


@@ -244,18 +240,34 @@ public:
     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 
     /**
     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 
     /**

-        Deletes a property by id. If category is deleted, all children are
-        automatically deleted as well.
-     */
+        Removes and deletes a property and any children.
+
+        @param id
+            Pointer or name of a property.
+
+        @remarks If you delete a property in a wxPropertyGrid event
+                 handler, the actual deletion is postponed until the next
+                 idle event.
+
+                 This functions deselects selected property, if any.
+                 Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not
+                 respected, ie. selection is cleared even if editor had
+                 invalid value.
+    */

     void DeleteProperty( wxPGPropArg id );
 
     /**
     void DeleteProperty( wxPGPropArg id );
 
     /**

-        Removes and returns a property.
+        Removes a property. Does not delete the property object, but
+        instead returns it.

 
         @param id
             Pointer or name of a property.
 
         @remarks Removed property cannot have any children.
 
         @param id
             Pointer or name of a property.
 
         @remarks Removed property cannot have any children.

+
+                 Also, if you remove property in a wxPropertyGrid event
+                 handler, the actual removal is postponed until the next
+                 idle event.

     */
     wxPGProperty* RemoveProperty( wxPGPropArg id );
 
     */
     wxPGProperty* RemoveProperty( wxPGPropArg id );
 


@@ -415,14 +427,12 @@ public:
         return m_pState->GetPropertyCategory(p);
     }
 
         return m_pState->GetPropertyCategory(p);
     }
 

-#ifndef SWIG

     /** Returns client data (void*) of a property. */
     void* GetPropertyClientData( wxPGPropArg id ) const
     {
         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(NULL)
         return p->GetClientData();
     }
     /** Returns client data (void*) of a property. */
     void* GetPropertyClientData( wxPGPropArg id ) const
     {
         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(NULL)
         return p->GetClientData();
     }

-#endif

 
     /**
         Returns first property which label matches given string.
 
     /**
         Returns first property which label matches given string.


@@ -511,10 +521,8 @@ public:
     {
         return (unsigned long) GetPropertyValueAsLong(id);
     }
     {
         return (unsigned long) GetPropertyValueAsLong(id);
     }

-#ifndef SWIG

     int GetPropertyValueAsInt( wxPGPropArg id ) const
         { return (int)GetPropertyValueAsLong(id); }
     int GetPropertyValueAsInt( wxPGPropArg id ) const
         { return (int)GetPropertyValueAsLong(id); }

-#endif

     bool GetPropertyValueAsBool( wxPGPropArg id ) const;
     double GetPropertyValueAsDouble( wxPGPropArg id ) const;
 
     bool GetPropertyValueAsBool( wxPGPropArg id ) const;
     double GetPropertyValueAsDouble( wxPGPropArg id ) const;
 


@@ -573,7 +581,6 @@ public:
     }
 #endif
 
     }
 #endif
 

-#ifndef SWIG

     /** Returns a wxVariant list containing wxVariant versions of all
         property values. Order is not guaranteed.
         @param flags
     /** Returns a wxVariant list containing wxVariant versions of all
         property values. Order is not guaranteed.
         @param flags


@@ -589,7 +596,6 @@ public:
     {
         return m_pState->DoGetPropertyValues(listname, baseparent, flags);
     }
     {
         return m_pState->DoGetPropertyValues(listname, baseparent, flags);
     }

-#endif

 
     /**
         Returns currently selected property. NULL if none.
 
     /**
         Returns currently selected property. NULL if none.


@@ -610,9 +616,7 @@ public:
         return m_pState->m_selection;
     }
 
         return m_pState->m_selection;
     }
 

-#ifndef SWIG

     wxPropertyGridPageState* GetState() const { return m_pState; }
     wxPropertyGridPageState* GetState() const { return m_pState; }

-#endif

 
     /** Similar to GetIterator(), but instead returns wxPGVIterator instance,
         which can be useful for forward-iterating through arbitrary property
 
     /** Similar to GetIterator(), but instead returns wxPGVIterator instance,
         which can be useful for forward-iterating through arbitrary property


@@ -873,6 +877,30 @@ public:
     static void SetBoolChoices( const wxString& trueChoice,
                                 const wxString& falseChoice );
 
     static void SetBoolChoices( const wxString& trueChoice,
                                 const wxString& falseChoice );
 

+    /**
+        Set proportion of a auto-stretchable column. wxPG_SPLITTER_AUTO_CENTER
+        window style needs to be used to indicate that columns are auto-
+        resizeable.
+
+        @returns Returns @false on failure.
+
+        @remarks You should call this for individual pages of
+                 wxPropertyGridManager (if used).
+
+        @see GetColumnProportion()
+    */
+    bool SetColumnProportion( unsigned int column, int proportion );
+
+    /**
+        Returns auto-resize proportion of the given column.
+
+        @see SetColumnProportion()
+    */
+    int GetColumnProportion( unsigned int column ) const
+    {
+        return m_pState->DoGetColumnProportion(column);
+    }
+

     /** Sets an attribute for this property.
         @param name
             Text identifier of attribute. See @ref propgrid_property_attributes.
     /** Sets an attribute for this property.
         @param name
             Text identifier of attribute. See @ref propgrid_property_attributes.


@@ -905,13 +933,14 @@ public:
         @param colour
             New background colour.
 
         @param colour
             New background colour.
 

-        @param recursively
-            If True, child properties are affected recursively. Property
-            categories are skipped if this flag is used.
+        @param flags
+            Default is wxPG_RECURSE which causes colour to be set recursively.
+            Omit this flag to only set colour for the property in question
+            and not any of its children.

     */
     void SetPropertyBackgroundColour( wxPGPropArg id,
                                       const wxColour& colour,
     */
     void SetPropertyBackgroundColour( wxPGPropArg id,
                                       const wxColour& colour,

-                                      bool recursively = true );
+                                      int flags = wxPG_RECURSE );

 
     /** Resets text and background colours of given property.
     */
 
     /** Resets text and background colours of given property.
     */


@@ -926,13 +955,14 @@ public:
         @param colour
             New background colour.
 
         @param colour
             New background colour.
 

-        @param recursively
-            If True, child properties are affected recursively. Property
-            categories are skipped if this flag is used.
+        @param flags
+            Default is wxPG_RECURSE which causes colour to be set recursively.
+            Omit this flag to only set colour for the property in question
+            and not any of its children.

     */
     void SetPropertyTextColour( wxPGPropArg id,
                                 const wxColour& col,
     */
     void SetPropertyTextColour( wxPGPropArg id,
                                 const wxColour& col,

-                                bool recursively = true );
+                                int flags = wxPG_RECURSE );

 
     /**
         Returns background colour of first cell of a property.
 
     /**
         Returns background colour of first cell of a property.


@@ -965,7 +995,6 @@ public:
                           const wxColour& fgCol = wxNullColour,
                           const wxColour& bgCol = wxNullColour );
 
                           const wxColour& fgCol = wxNullColour,
                           const wxColour& bgCol = wxNullColour );
 

-#ifndef SWIG

     /** Sets client data (void*) of a property.
         @remarks
         This untyped client data has to be deleted manually.
     /** Sets client data (void*) of a property.
         @remarks
         This untyped client data has to be deleted manually.


@@ -993,7 +1022,6 @@ public:
         p->SetEditor(editor);
         RefreshProperty(p);
     }
         p->SetEditor(editor);
         RefreshProperty(p);
     }

-#endif

 
     /** Sets editor control of a property. As editor argument, use
         editor name string, such as "TextCtrl" or "Choice".
 
     /** Sets editor control of a property. As editor argument, use
         editor name string, such as "TextCtrl" or "Choice".


@@ -1051,11 +1079,9 @@ public:
     void SetPropertyValueUnspecified( wxPGPropArg id )
     {
         wxPG_PROP_ARG_CALL_PROLOG()
     void SetPropertyValueUnspecified( wxPGPropArg id )
     {
         wxPG_PROP_ARG_CALL_PROLOG()

-        wxVariant nullVariant;
-        SetPropVal(p, nullVariant);
+        p->SetValueToUnspecified();

     }
 
     }
 

-#ifndef SWIG

     /**
         Sets property values from a list of wxVariants.
     */
     /**
         Sets property values from a list of wxVariants.
     */


@@ -1076,7 +1102,6 @@ public:
     {
         SetPropertyValues(list.GetList(),defaultCategory);
     }
     {
         SetPropertyValues(list.GetList(),defaultCategory);
     }

-#endif

 
     /** Associates the help string with property.
         @remarks
 
     /** Associates the help string with property.
         @remarks


@@ -1117,7 +1142,6 @@ public:
     }
 #endif
 
     }
 #endif
 

-#ifndef SWIG

     /** Sets value (long integer) of a property.
     */
     void SetPropertyValue( wxPGPropArg id, long value )
     /** Sets value (long integer) of a property.
     */
     void SetPropertyValue( wxPGPropArg id, long value )


@@ -1216,7 +1240,6 @@ public:
         wxVariant v = WXVARIANT(value);
         SetPropVal( id, v );
     }
         wxVariant v = WXVARIANT(value);
         SetPropVal( id, v );
     }

-#endif  // !SWIG

 
     /** Sets value (wxString) of a property.
 
 
     /** Sets value (wxString) of a property.
 


@@ -1238,11 +1261,9 @@ public:
         SetPropVal( id, value );
     }
 
         SetPropVal( id, value );
     }
 

-#ifndef SWIG

     /** Sets value (wxVariant&) of a property. Same as SetPropertyValue, but
         accepts reference. */
     void SetPropVal( wxPGPropArg id, wxVariant& value );
     /** Sets value (wxVariant&) of a property. Same as SetPropertyValue, but
         accepts reference. */
     void SetPropVal( wxPGPropArg id, wxVariant& value );

-#endif

 
     /** Adjusts how wxPropertyGrid behaves when invalid value is entered
         in a property.
 
     /** Adjusts how wxPropertyGrid behaves when invalid value is entered
         in a property.


@@ -1331,8 +1352,6 @@ protected:
     // Default call's m_pState's BaseGetPropertyByName
     virtual wxPGProperty* DoGetPropertyByName( const wxString& name ) const;
 
     // Default call's m_pState's BaseGetPropertyByName
     virtual wxPGProperty* DoGetPropertyByName( const wxString& name ) const;
 

-#ifndef SWIG
-

     // Deriving classes must set this (it must be only or current page).
     wxPropertyGridPageState*         m_pState;
 
     // Deriving classes must set this (it must be only or current page).
     wxPropertyGridPageState*         m_pState;
 


@@ -1361,7 +1380,6 @@ private:
             return NULL;
         return static_cast<const wxPropertyGrid*>(m_pState->GetGrid());
     }
             return NULL;
         return static_cast<const wxPropertyGrid*>(m_pState->GetGrid());
     }

-#endif // #ifndef SWIG

 
     friend class wxPropertyGrid;
     friend class wxPropertyGridManager;
 
     friend class wxPropertyGrid;
     friend class wxPropertyGridManager;