fix wxSocket notifications under MSW after the last change

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

diff --git a/include/wx/propgrid/propgridiface.h b/include/wx/propgrid/propgridiface.h
index 60aeb2d72a02e414ee375c6ad358d6f572d7b409..a2139e45e945eb05e04f432309e9d441d2865844 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
 /////////////////////////////////////////////////////////////////////////////


@@ -169,20 +169,6 @@ public:
     /** Destructor */
     virtual ~wxPropertyGridInterface() { }
 
     /** Destructor */
     virtual ~wxPropertyGridInterface() { }
 

-    /** Adds choice to a property that can accept one.
-        @remarks
-        - If you need to make sure that you modify only the set of choices of
-          a single property (and not also choices of other properties with
-          initially identical set), call
-          wxPropertyGrid::SetPropertyChoicesPrivate.
-        - This usually only works for wxEnumProperty and derivatives
-          (wxFlagsProperty can get accept new items but its items may not get
-          updated).
-    */
-    void AddPropertyChoice( wxPGPropArg id,
-                            const wxString& label,
-                            int value = wxPG_INVALID_VALUE );
-

     /**
         Appends property to the list.
 
     /**
         Appends property to the list.
 


@@ -214,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.


@@ -248,29 +239,12 @@ 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 );
 

-    /** Deletes choice from a property.
-
-        If selected item is deleted, then the value is set to unspecified.
-
-        See AddPropertyChoice for more details.
-    */
-    void DeletePropertyChoice( wxPGPropArg id, int index );
-

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


@@ -301,16 +275,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!


@@ -399,7 +363,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();
     }
 


@@ -463,12 +430,6 @@ public:
     wxPGProperty* GetPropertyByName( const wxString& name,
                                      const wxString& subname ) const;
 
     wxPGProperty* GetPropertyByName( const wxString& name,
                                      const wxString& subname ) const;
 

-    /** Returns writable reference to property's list of choices (and relevant
-        values). If property does not have any choices, will return reference
-        to an invalid set of choices that will return false on IsOk call.
-    */
-    wxPGChoices& GetPropertyChoices( wxPGPropArg id );
-

     /** Returns property's editor. */
     const wxPGEditor* GetPropertyEditor( wxPGPropArg id ) const
     {
     /** Returns property's editor. */
     const wxPGEditor* GetPropertyEditor( wxPGPropArg id ) const
     {


@@ -490,13 +451,6 @@ public:
         return p->GetValueImage();
     }
 
         return p->GetValueImage();
     }
 

-    /** Returns property's position under its parent. */
-    unsigned int GetPropertyIndex( wxPGPropArg id )
-    {
-        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(INT_MAX)
-        return p->GetIndexInParent();
-    }
-

     /** Returns label of a property. */
     const wxString& GetPropertyLabel( wxPGPropArg id )
     {
     /** Returns label of a property. */
     const wxString& GetPropertyLabel( wxPGPropArg id )
     {


@@ -505,10 +459,9 @@ public:
     }
 
     /** Returns name of a property, by which it is globally accessible. */
     }
 
     /** Returns name of a property, by which it is globally accessible. */

-    wxString GetPropertyName( wxPGPropArg id )
+    wxString GetPropertyName( wxPGProperty* property )

     {
     {

-        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(m_emptyString)
-        return p->GetName();
+        return property->GetName();

     }
 
     /** Returns parent item of a property. */
     }
 
     /** Returns parent item of a property. */


@@ -552,7 +505,6 @@ public:
 #endif
     bool GetPropertyValueAsBool( wxPGPropArg id ) const;
     double GetPropertyValueAsDouble( wxPGPropArg id ) const;
 #endif
     bool GetPropertyValueAsBool( wxPGPropArg id ) const;
     double GetPropertyValueAsDouble( wxPGPropArg id ) const;

-    void* GetPropertyValueAsVoidPtr( wxPGPropArg id ) const;

 
 #define wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL(TYPENAME, DEFVAL) \
     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(DEFVAL) \
 
 #define wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL(TYPENAME, DEFVAL) \
     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(DEFVAL) \


@@ -577,22 +529,7 @@ public:
         return value.GetArrayString();
     }
 
         return value.GetArrayString();
     }
 

-    wxPoint GetPropertyValueAsPoint( wxPGPropArg id ) const
-    {
-        wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL("wxPoint", wxPoint())
-        wxPoint pt;
-        pt << value;
-        return pt;
-    }
-
-    wxSize GetPropertyValueAsSize( wxPGPropArg id ) const
-    {
-        wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL("wxSize", wxSize())
-        wxSize sz;
-        sz << value;
-        return sz;
-    }
-
+#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",


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

+#endif

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


@@ -647,12 +585,6 @@ public:
     }
 #endif
 
     }
 #endif
 

-    wxString GetPropertyValueType( wxPGPropArg id )
-    {
-        wxPG_PROP_ARG_CALL_PROLOG_RETVAL(m_emptyString)
-        return p->GetValueType();
-    }
-

     /** Returns currently selected property. */
     wxPGProperty* GetSelection() const
     {
     /** Returns currently selected property. */
     wxPGProperty* GetSelection() const
     {


@@ -762,15 +694,6 @@ public:
         return p->IsCategory();
     }
 
         return p->IsCategory();
     }
 

-    /** Inserts choice to a property that can accept one.
-
-        See AddPropertyChoice for more details.
-    */
-    void InsertPropertyChoice( wxPGPropArg id,
-                               const wxString& label,
-                               int index,
-                               int value = wxPG_INVALID_VALUE );
-

     /** Returns true if property is enabled. */
     bool IsPropertyEnabled( wxPGPropArg id ) const
     {
     /** Returns true if property is enabled. */
     bool IsPropertyEnabled( wxPGPropArg id ) const
     {


@@ -864,6 +787,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.


@@ -872,7 +798,8 @@ public:
                            ExpandedState |
                            ScrollPosState |
                            PageState |
                            ExpandedState |
                            ScrollPosState |
                            PageState |

-                           SplitterPosState
+                           SplitterPosState |
+                           DescBoxState

     };
 
     /**
     };
 
     /**


@@ -918,16 +845,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.


@@ -945,13 +862,66 @@ public:
         DoSetPropertyAttribute(id,attrName,value,argFlags);
     }
 
         DoSetPropertyAttribute(id,attrName,value,argFlags);
     }
 

-    /** Sets attributes from a wxPGAttributeStorage.
+    /** Sets property attribute for all applicapple properties.
+        Be sure to use this method only after all properties have been
+        added to the grid.
+    */
+    void SetPropertyAttributeAll( const wxString& attrName, wxVariant value );
+
+    /**
+        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 SetPropertyAttributes( wxPGPropArg id,
-                                const wxPGAttributeStorage& attributes )
+    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 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.


@@ -965,33 +935,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) );
-    }
-
-    /** Set choices of a property to specified set of labels and values.
-
-        @remarks
-        This operation clears the property value.
-    */
-    void SetPropertyChoices( wxPGPropArg id, wxPGChoices& choices)
-    {
-        wxPG_PROP_ARG_CALL_PROLOG()
-        p->SetChoices(choices);
-    }
-
-
-    /**
-        If property's set of choices is shared, then calling this method
-        converts it to private.
-    */
-    void SetPropertyChoicesExclusive( wxPGPropArg id )
-    {
-        wxPG_PROP_ARG_CALL_PROLOG()
-        p->SetChoicesExclusive();
-    }
+                          const wxColour& bgCol = wxNullColour );

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


@@ -1035,12 +979,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 );

     }
 
     /**
     }
 
     /**


@@ -1161,7 +1112,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) );
     }


@@ -1200,20 +1157,7 @@ public:
         SetPropVal( id, v );
     }
 
         SetPropVal( id, v );
     }
 

-    /** Sets value (wxPoint&) of a property.
-    */
-    void SetPropertyValue( wxPGPropArg id, const wxPoint& value )
-    {
-        wxVariant v = WXVARIANT(value);
-        SetPropVal( id, v );
-    }
-    /** Sets value (wxSize&) of a property.
-    */
-    void SetPropertyValue( wxPGPropArg id, const wxSize& value )
-    {
-        wxVariant v = WXVARIANT(value);
-        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 )


@@ -1228,6 +1172,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 )


@@ -1519,6 +1465,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
     {