Fixed compilation error on OS/2 (strnlen declaration was not visible).

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

diff --git a/include/wx/propgrid/propgridiface.h b/include/wx/propgrid/propgridiface.h
index a43aa0201abd47d7bd26941d0ef49a9fb33de3fb..ca8a678be9aadc470119f60827d8fed81689afa3 100644 (file)
--- a/include/wx/propgrid/propgridiface.h
+++ b/include/wx/propgrid/propgridiface.h
@@ -4,7 +4,7 @@
 // Author:      Jaakko Salli
 // Modified by:
 // Created:     2008-08-24
 // Author:      Jaakko Salli
 // Modified by:
 // Created:     2008-08-24

-// RCS-ID:      $Id:
+// RCS-ID:      $Id$

 // Copyright:   (c) Jaakko Salli
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) Jaakko Salli
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////


@@ -76,7 +76,7 @@ public:
     /** This constructor is required for NULL. */
     wxPGPropArgCls( int )
     {
     /** This constructor is required for NULL. */
     wxPGPropArgCls( int )
     {

-        m_ptr.property = (wxPGProperty*) NULL;
+        m_ptr.property = NULL;

         m_flags = IsProperty;
     }
     wxPGProperty* GetPtr( wxPropertyGridInterface* iface ) const;
         m_flags = IsProperty;
     }
     wxPGProperty* GetPtr( wxPropertyGridInterface* iface ) const;


@@ -95,7 +95,7 @@ private:
         IsWxString      = 0x01,
         IsCharPtr       = 0x02,
         IsWCharPtr      = 0x04,
         IsWxString      = 0x01,
         IsCharPtr       = 0x02,
         IsWCharPtr      = 0x04,

-        OwnsWxString    = 0x10,
+        OwnsWxString    = 0x10

     };
 
     union
     };
 
     union


@@ -200,17 +200,22 @@ public:
     */
     virtual void Clear() = 0;
 
     */
     virtual void Clear() = 0;
 

-    /** Deselect current selection, if any. Returns true if success
-        (ie. validator did not intercept). */
-    bool ClearSelection();
+    /**
+        Clears current selection, if any.
+
+        @param validation
+            If set to @false, deselecting the property will always work,
+            even if its editor had invalid value in it.
+
+        @return Returns @true if successful or if there was no selection. May
+                fail if validation was enabled and active editor had invalid
+                value.
+    */
+    bool ClearSelection( bool validation = false);

 
     /** Resets modified status of all properties.
     */
 
     /** Resets modified status of all properties.
     */

-    void ClearModifiedStatus()
-    {
-        SetPropertyModifiedStatus(m_pState->m_properties, false);
-        m_pState->m_anyModified = false;
-    }
+    void ClearModifiedStatus();

 
     /** Collapses given category or property with children.
         Returns true if actually collapses.
 
     /** Collapses given category or property with children.
         Returns true if actually collapses.


@@ -234,21 +239,22 @@ public:
     */
     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 
     */
     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 

-    /** Resets value of a property to its default. */
-    bool ClearPropertyValue( wxPGPropArg id )
-    {
-        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
-        p->SetValue(p->GetDefaultValue());
-        RefreshProperty(p);
-        return true;
-    }
-

     /**
         Deletes a property by id. If category is deleted, all children are
         automatically deleted as well.
      */
     void DeleteProperty( wxPGPropArg id );
 
     /**
         Deletes a property by id. If category is deleted, all children are
         automatically deleted as well.
      */
     void DeleteProperty( wxPGPropArg id );
 

+    /**
+        Removes and returns a property.
+
+        @param id
+            Pointer or name of a property.
+
+        @remarks Removed property cannot have any children.
+    */
+    wxPGProperty* RemoveProperty( wxPGPropArg id );
+

     /** Disables property. */
     bool DisableProperty( wxPGPropArg id ) { return EnableProperty(id,false); }
 
     /** Disables property. */
     bool DisableProperty( wxPGPropArg id ) { return EnableProperty(id,false); }
 


@@ -279,16 +285,6 @@ public:
     */
     bool ExpandAll( bool expand = true );
 
     */
     bool ExpandAll( bool expand = true );
 

-    /** Returns list of expanded properties.
-    */
-    wxArrayPGProperty GetExpandedProperties() const
-    {
-        wxArrayPGProperty array;
-        GetPropertiesWithFlag(&array, wxPG_PROP_COLLAPSED, true,
-            wxPG_ITERATE_ALL_PARENTS_RECURSIVELY|wxPG_ITERATE_HIDDEN);
-        return array;
-    }
-

     /** Returns id of first child of given property.
         @remarks
         Does not return sub-properties!
     /** Returns id of first child of given property.
         @remarks
         Does not return sub-properties!


@@ -377,7 +373,10 @@ public:
     */
     const wxPGAttributeStorage& GetPropertyAttributes( wxPGPropArg id ) const
     {
     */
     const wxPGAttributeStorage& GetPropertyAttributes( wxPGPropArg id ) const
     {

-        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(*((const wxPGAttributeStorage*)NULL));
+        // If 'id' refers to invalid property, then we will return dummy
+        // attributes (ie. root property's attributes, which contents should
+        // should always be empty and of no consequence).
+        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(m_pState->DoGetRoot()->GetAttributes());

         return p->GetAttributes();
     }
 
         return p->GetAttributes();
     }
 


@@ -540,6 +539,7 @@ public:
         return value.GetArrayString();
     }
 
         return value.GetArrayString();
     }
 

+#if wxUSE_LONGLONG_NATIVE

     wxLongLong_t GetPropertyValueAsLongLong( wxPGPropArg id ) const
     {
         wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL_WFALLBACK("wxLongLong",
     wxLongLong_t GetPropertyValueAsLongLong( wxPGPropArg id ) const
     {
         wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL_WFALLBACK("wxLongLong",


@@ -557,6 +557,7 @@ public:
         ull << value;
         return ull.GetValue();
     }
         ull << value;
         return ull.GetValue();
     }

+#endif

 
     wxArrayInt GetPropertyValueAsArrayInt( wxPGPropArg id ) const
     {
 
     wxArrayInt GetPropertyValueAsArrayInt( wxPGPropArg id ) const
     {


@@ -796,6 +797,9 @@ public:
         PageState        = 0x08,
         /** Include splitter position. Stored for each page. */
         SplitterPosState = 0x10,
         PageState        = 0x08,
         /** Include splitter position. Stored for each page. */
         SplitterPosState = 0x10,

+        /** Include description box size.
+            Only applies to wxPropertyGridManager. */
+        DescBoxState     = 0x20,

 
         /**
             Include all supported user editable state information.
 
         /**
             Include all supported user editable state information.


@@ -804,7 +808,8 @@ public:
                            ExpandedState |
                            ScrollPosState |
                            PageState |
                            ExpandedState |
                            ScrollPosState |
                            PageState |

-                           SplitterPosState
+                           SplitterPosState |
+                           DescBoxState

     };
 
     /**
     };
 
     /**


@@ -850,16 +855,6 @@ public:
     static void SetBoolChoices( const wxString& trueChoice,
                                 const wxString& falseChoice );
 
     static void SetBoolChoices( const wxString& trueChoice,
                                 const wxString& falseChoice );
 

-    /** Sets or clears flag(s) of all properties in given array.
-        @param flags
-        Property flags to set or clear.
-        @param inverse
-        Set to true if you want to clear flag instead of setting them.
-    */
-    void SetPropertiesFlag( const wxArrayPGProperty& srcArr,
-                            wxPGProperty::FlagType flags,
-                            bool inverse = false );
-

     /** 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.


@@ -883,13 +878,60 @@ public:
     */
     void SetPropertyAttributeAll( const wxString& attrName, wxVariant value );
 
     */
     void SetPropertyAttributeAll( const wxString& attrName, wxVariant value );
 

-    /** Sets attributes from a wxPGAttributeStorage.
+    /**
+        Sets background colour of a property.
+
+        @param id
+            Property name or pointer.
+
+        @param colour
+            New background colour.
+
+        @param recursively
+            If True, child properties are affected recursively. Property
+            categories are skipped if this flag is used.
+    */
+    void SetPropertyBackgroundColour( wxPGPropArg id,
+                                      const wxColour& colour,
+                                      bool recursively = true );
+
+    /** Resets text and background colours of given property.
+    */
+    void SetPropertyColoursToDefault( wxPGPropArg id );
+
+    /**
+        Sets text colour of a property.
+
+        @param id
+            Property name or pointer.
+
+        @param colour
+            New background colour.
+
+        @param recursively
+            If True, child properties are affected recursively. Property
+            categories are skipped if this flag is used.

     */
     */

-    void SetPropertyAttributes( wxPGPropArg id,
-                                const wxPGAttributeStorage& attributes )
+    void SetPropertyTextColour( wxPGPropArg id,
+                                const wxColour& col,
+                                bool recursively = true );
+
+    /**
+        Returns background colour of first cell of a property.
+    */
+    wxColour GetPropertyBackgroundColour( wxPGPropArg id ) const

     {
     {

-        wxPG_PROP_ARG_CALL_PROLOG()
-        p->SetAttributes(attributes);
+        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxColour())
+        return p->GetCell(0).GetBgCol();
+    }
+
+    /**
+        Returns text colour of first cell of a property.
+    */
+    wxColour GetPropertyTextColour( wxPGPropArg id ) const
+    {
+        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxColour())
+        return p->GetCell(0).GetFgCol();

     }
 
     /** Sets text, bitmap, and colours for given column's cell.
     }
 
     /** Sets text, bitmap, and colours for given column's cell.


@@ -903,11 +945,7 @@ public:
                           const wxString& text = wxEmptyString,
                           const wxBitmap& bitmap = wxNullBitmap,
                           const wxColour& fgCol = wxNullColour,
                           const wxString& text = wxEmptyString,
                           const wxBitmap& bitmap = wxNullBitmap,
                           const wxColour& fgCol = wxNullColour,

-                          const wxColour& bgCol = wxNullColour )
-    {
-        wxPG_PROP_ARG_CALL_PROLOG()
-        p->SetCell( column, new wxPGCell(text, bitmap, fgCol, bgCol) );
-    }
+                          const wxColour& bgCol = wxNullColour );

 
 #ifndef SWIG
     /** Sets client data (void*) of a property.
 
 #ifndef SWIG
     /** Sets client data (void*) of a property.


@@ -951,12 +989,19 @@ public:
     */
     void SetPropertyLabel( wxPGPropArg id, const wxString& newproplabel );
 
     */
     void SetPropertyLabel( wxPGPropArg id, const wxString& newproplabel );
 

-    /** Set modified status of a property and all its children.
+    /**
+        Sets name of a property.
+
+        @param id
+            Name or pointer of property which name to change.
+
+        @param newName
+            New name for property.

     */
     */

-    void SetPropertyModifiedStatus( wxPGPropArg id, bool modified )
+    void SetPropertyName( wxPGPropArg id, const wxString& newName )

     {
         wxPG_PROP_ARG_CALL_PROLOG()
     {
         wxPG_PROP_ARG_CALL_PROLOG()

-        p->SetModifiedStatus(modified);
+        m_pState->DoSetPropertyName( p, newName );

     }
 
     /**
     }
 
     /**


@@ -985,7 +1030,12 @@ public:
         If it has children (it may be category), then the same thing is done to
         them.
     */
         If it has children (it may be category), then the same thing is done to
         them.
     */

-    void SetPropertyValueUnspecified( wxPGPropArg id );
+    void SetPropertyValueUnspecified( wxPGPropArg id )
+    {
+        wxPG_PROP_ARG_CALL_PROLOG()
+        wxVariant nullVariant;
+        SetPropVal(p, nullVariant);
+    }

 
 #ifndef SWIG
     /** Sets various property values from a list of wxVariants. If property with
 
 #ifndef SWIG
     /** Sets various property values from a list of wxVariants. If property with


@@ -1077,7 +1127,13 @@ public:
         wxVariant v(value);
         SetPropVal( id, v );
     }
         wxVariant v(value);
         SetPropVal( id, v );
     }

-    void SetPropertyValue( wxPGPropArg id, const wxChar* value )
+#if wxUSE_WCHAR_T
+    void SetPropertyValue( wxPGPropArg id, const wchar_t* value )
+    {
+        SetPropertyValueString( id, wxString(value) );
+    }
+#endif
+    void SetPropertyValue( wxPGPropArg id, const char* value )

     {
         SetPropertyValueString( id, wxString(value) );
     }
     {
         SetPropertyValueString( id, wxString(value) );
     }


@@ -1116,6 +1172,7 @@ public:
         SetPropVal( id, v );
     }
 
         SetPropVal( id, v );
     }
 

+#if wxUSE_LONGLONG_NATIVE

     /** Sets value (wxLongLong&) of a property.
     */
     void SetPropertyValue( wxPGPropArg id, wxLongLong_t value )
     /** Sets value (wxLongLong&) of a property.
     */
     void SetPropertyValue( wxPGPropArg id, wxLongLong_t value )


@@ -1130,6 +1187,8 @@ public:
         wxVariant v = WXVARIANT(wxULongLong(value));
         SetPropVal( id, v );
     }
         wxVariant v = WXVARIANT(wxULongLong(value));
         SetPropVal( id, v );
     }

+#endif
+

     /** Sets value (wxArrayInt&) of a property.
     */
     void SetPropertyValue( wxPGPropArg id, const wxArrayInt& value )
     /** Sets value (wxArrayInt&) of a property.
     */
     void SetPropertyValue( wxPGPropArg id, const wxArrayInt& value )


@@ -1172,6 +1231,37 @@ public:
     */
     void SetValidationFailureBehavior( int vfbFlags );
 
     */
     void SetValidationFailureBehavior( int vfbFlags );
 

+    /**
+        Sorts all properties recursively.
+
+        @param flags
+            This can contain any of the following options:
+              wxPG_SORT_TOP_LEVEL_ONLY: Only sort categories and their
+                immediate children. Sorting done by wxPG_AUTO_SORT option
+                uses this.
+
+        @see SortChildren, wxPropertyGrid::SetSortFunction
+    */
+    void Sort( int flags = 0 );
+
+    /**
+        Sorts children of a property.
+
+        @param id
+            Name or pointer to a property.
+
+        @param flags
+            This can contain any of the following options:
+              wxPG_RECURSE: Sorts recursively.
+
+        @see Sort, wxPropertyGrid::SetSortFunction
+    */
+    void SortChildren( wxPGPropArg id, int flags = 0 )
+    {
+        wxPG_PROP_ARG_CALL_PROLOG()
+        m_pState->DoSortChildren(p, flags);
+    }
+

 #ifdef SWIG
     %pythoncode {
         def MapType(class_,factory):
 #ifdef SWIG
     %pythoncode {
         def MapType(class_,factory):


@@ -1421,6 +1511,27 @@ public:
 
 protected:
 
 
 protected:
 

+    /**
+        In derived class, implement to set editable state component with
+        given name to given value.
+    */
+    virtual bool SetEditableStateItem( const wxString& name, wxVariant value )
+    {
+        wxUnusedVar(name);
+        wxUnusedVar(value);
+        return false;
+    }
+
+    /**
+        In derived class, implement to return editable state component with
+        given name.
+    */
+    virtual wxVariant GetEditableStateItem( const wxString& name ) const
+    {
+        wxUnusedVar(name);
+        return wxNullVariant;
+    }
+

     // Returns page state data for given (sub) page (-1 means current page).
     virtual wxPropertyGridPageState* GetPageState( int pageIndex ) const
     {
     // Returns page state data for given (sub) page (-1 means current page).
     virtual wxPropertyGridPageState* GetPageState( int pageIndex ) const
     {