Add EVT_RIBBONBAR_TAB_LEFT_DCLICK event.

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

diff --git a/include/wx/propgrid/property.h b/include/wx/propgrid/property.h
index 75ed5a4ba78dc771f0360d53c7374416351c5695..5ef99831b92bc5ab728cc9ecaa3843b930ddc36f 100644 (file)
--- a/include/wx/propgrid/property.h
+++ b/include/wx/propgrid/property.h
@@ -6,12 +6,14 @@
 // Created:     2008-08-23
 // RCS-ID:      $Id$
 // Copyright:   (c) Jaakko Salli
 // Created:     2008-08-23
 // RCS-ID:      $Id$
 // Copyright:   (c) Jaakko Salli

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_PROPGRID_PROPERTY_H_
 #define _WX_PROPGRID_PROPERTY_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_PROPGRID_PROPERTY_H_
 #define _WX_PROPGRID_PROPERTY_H_
 

+#include "wx/defs.h"
+

 #if wxUSE_PROPGRID
 
 #include "wx/propgrid/propgriddefs.h"
 #if wxUSE_PROPGRID
 
 #include "wx/propgrid/propgriddefs.h"


@@ -47,9 +49,6 @@ struct wxPGPaintData
 };
 
 
 };
 
 

-#ifndef SWIG
-
-

 // space between vertical sides of a custom image
 #define wxPG_CUSTOM_IMAGE_SPACINGY      1
 
 // space between vertical sides of a custom image
 #define wxPG_CUSTOM_IMAGE_SPACINGY      1
 


@@ -98,7 +97,11 @@ public:
                               DontUseCellBgCol
     };
 
                               DontUseCellBgCol
     };
 

-    virtual void Render( wxDC& dc,
+    /**
+        Returns @true if rendered something in the foreground (text or
+        bitmap.
+    */
+    virtual bool Render( wxDC& dc,

                          const wxRect& rect,
                          const wxPropertyGrid* propertyGrid,
                          wxPGProperty* property,
                          const wxRect& rect,
                          const wxPropertyGrid* propertyGrid,
                          wxPGProperty* property,


@@ -171,7 +174,7 @@ public:
 class WXDLLIMPEXP_PROPGRID wxPGDefaultRenderer : public wxPGCellRenderer
 {
 public:
 class WXDLLIMPEXP_PROPGRID wxPGDefaultRenderer : public wxPGCellRenderer
 {
 public:

-    virtual void Render( wxDC& dc,
+    virtual bool Render( wxDC& dc,

                          const wxRect& rect,
                          const wxPropertyGrid* propertyGrid,
                          wxPGProperty* property,
                          const wxRect& rect,
                          const wxPropertyGrid* propertyGrid,
                          wxPGProperty* property,


@@ -216,7 +219,6 @@ protected:
     bool        m_hasValidText;
 };
 
     bool        m_hasValidText;
 };
 

-#endif  // !SWIG

 
 /**
     @class wxPGCell
 
 /**
     @class wxPGCell


@@ -313,8 +315,6 @@ private:
 
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------
 

-#ifndef SWIG
-

 /** @class wxPGAttributeStorage
 
     wxPGAttributeStorage is somewhat optimized storage for
 /** @class wxPGAttributeStorage
 
     wxPGAttributeStorage is somewhat optimized storage for


@@ -362,7 +362,6 @@ protected:
     wxPGHashMapS2P  m_map;
 };
 
     wxPGHashMapS2P  m_map;
 };
 

-#endif  // !SWIG

 
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------
 


@@ -370,7 +369,7 @@ protected:
     @{
 */
 
     @{
 */
 

-enum wxPG_PROPERTY_FLAGS
+enum wxPGPropertyFlags

 {
 
 /** Indicates bold font.
 {
 
 /** Indicates bold font.


@@ -447,7 +446,9 @@ wxPG_PROP_CATEGORY                  = 0x2000,
 */
 wxPG_PROP_MISC_PARENT               = 0x4000,
 
 */
 wxPG_PROP_MISC_PARENT               = 0x4000,
 

-/** Property is read-only. Editor is still created.
+/** Property is read-only. Editor is still created for wxTextCtrl-based
+    property editors. For others, editor is not usually created because
+    they do implement wxTE_READONLY style or equivalent.

 */
 wxPG_PROP_READONLY                  = 0x8000,
 
 */
 wxPG_PROP_READONLY                  = 0x8000,
 


@@ -474,6 +475,8 @@ wxPG_PROP_USES_COMMON_VALUE         = 0x00020000,
 
     @remarks
     This flag cannot be used with property iterators.
 
     @remarks
     This flag cannot be used with property iterators.

+
+    @see wxPGProperty::SetAutoUnspecified()

 */
 wxPG_PROP_AUTO_UNSPECIFIED          = 0x00040000,
 
 */
 wxPG_PROP_AUTO_UNSPECIFIED          = 0x00040000,
 


@@ -500,7 +503,9 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
     Code should automatically take care of this, however.
 */
 #define wxPG_PROP_PARENTAL_FLAGS \
     Code should automatically take care of this, however.
 */
 #define wxPG_PROP_PARENTAL_FLAGS \

-    (wxPG_PROP_AGGREGATE|wxPG_PROP_CATEGORY|wxPG_PROP_MISC_PARENT)
+    ((wxPGPropertyFlags)(wxPG_PROP_AGGREGATE | \
+                         wxPG_PROP_CATEGORY | \
+                         wxPG_PROP_MISC_PARENT))

 
 /** @}
 */
 
 /** @}
 */


@@ -511,8 +516,6 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
 
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------
 

-#ifndef SWIG
-

 /**
     @section propgrid_property_attributes wxPropertyGrid Property Attribute
     Identifiers.
 /**
     @section propgrid_property_attributes wxPropertyGrid Property Attribute
     Identifiers.


@@ -553,7 +556,7 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
 
 #if wxPG_COMPATIBILITY_1_4
 /**
 
 #if wxPG_COMPATIBILITY_1_4
 /**

-    @deprecated Use "Hint" (wxPG_ATTR_INLINE_HELP) instead.
+    @deprecated Use "Hint" (wxPG_ATTR_HINT) instead.

 */
 #define wxPG_ATTR_INLINE_HELP               wxS("InlineHelp")
 #endif
 */
 #define wxPG_ATTR_INLINE_HELP               wxS("InlineHelp")
 #endif


@@ -645,6 +648,15 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
 */
 #define wxPG_DIR_DIALOG_MESSAGE             wxS("DialogMessage")
 
 */
 #define wxPG_DIR_DIALOG_MESSAGE             wxS("DialogMessage")
 

+/**
+    wxArrayStringProperty's string delimiter character. If this is aquotation
+    mark or hyphen, then strings will be quoted instead (with given
+    character).
+
+    Default delimiter is quotation mark.
+*/
+#define wxPG_ARRAY_DELIMITER                wxS("Delimiter")
+

 /** Sets displayed date format for wxDateProperty.
 */
 #define wxPG_DATE_FORMAT                    wxS("DateFormat")
 /** Sets displayed date format for wxDateProperty.
 */
 #define wxPG_DATE_FORMAT                    wxS("DateFormat")


@@ -697,12 +709,8 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
 #define wxPG_ATTR_INLINE_HELP             wxPGGlobalVars->m_strInlineHelp
 #endif
 
 #define wxPG_ATTR_INLINE_HELP             wxPGGlobalVars->m_strInlineHelp
 #endif
 

-#endif  // !SWIG
-

 // -----------------------------------------------------------------------
 
 // -----------------------------------------------------------------------
 

-#ifndef SWIG
-

 /** @class wxPGChoiceEntry
     Data of a single wxPGChoices choice.
 */
 /** @class wxPGChoiceEntry
     Data of a single wxPGChoices choice.
 */


@@ -783,7 +791,6 @@ private:
 
 #define wxPGChoicesEmptyData    ((wxPGChoicesData*)NULL)
 
 
 #define wxPGChoicesEmptyData    ((wxPGChoicesData*)NULL)
 

-#endif // SWIG

 
 /** @class wxPGChoices
 
 
 /** @class wxPGChoices
 


@@ -1008,14 +1015,14 @@ public:
     /** Removes count items starting at position nIndex. */
     void RemoveAt(size_t nIndex, size_t count = 1);
 
     /** Removes count items starting at position nIndex. */
     void RemoveAt(size_t nIndex, size_t count = 1);
 

-#ifndef SWIG
-    /** Does not create copies for itself. */
+    /** Does not create copies for itself.
+        TODO: Deprecate.
+    */

     void Set( const wxChar* const* labels, const long* values = NULL )
     {
         Free();
         Add(labels,values);
     }
     void Set( const wxChar* const* labels, const long* values = NULL )
     {
         Free();
         Add(labels,values);
     }

-#endif // SWIG

 
     /** Version that works with wxArrayString and wxArrayInt. */
     void Set( const wxArrayString& labels,
 
     /** Version that works with wxArrayString and wxArrayInt. */
     void Set( const wxArrayString& labels,


@@ -1052,7 +1059,6 @@ public:
 
     wxArrayString GetLabels() const;
 
 
     wxArrayString GetLabels() const;
 

-#ifndef SWIG

     void operator= (const wxPGChoices& a)
     {
         if (this != &a)
     void operator= (const wxPGChoices& a)
     {
         if (this != &a)


@@ -1074,7 +1080,6 @@ protected:
 
     void Init();
     void Free();
 
     void Init();
     void Free();

-#endif  // !SWIG

 };
 
 // -----------------------------------------------------------------------
 };
 
 // -----------------------------------------------------------------------


@@ -1137,7 +1142,6 @@ public:
     */
     virtual wxVariant DoGetValue() const { return m_value; }
 
     */
     virtual wxVariant DoGetValue() const { return m_value; }
 

-#if !defined(SWIG) || defined(CREATE_VCW)

     /** Implement this function in derived class to check the value.
         Return true if it is ok. Returning false prevents property change events
         from occurring.
     /** Implement this function in derived class to check the value.
         Return true if it is ok. Returning false prevents property change events
         from occurring.


@@ -1209,7 +1213,7 @@ public:
     virtual bool IntToValue( wxVariant& value,
                              int number,
                              int argFlags = 0 ) const;
     virtual bool IntToValue( wxVariant& value,
                              int number,
                              int argFlags = 0 ) const;

-#endif  // !defined(SWIG) || defined(CREATE_VCW)
+

     /**
         Converts property value into a text representation.
 
     /**
         Converts property value into a text representation.
 


@@ -1452,12 +1456,16 @@ public:
     */
     virtual void RefreshChildren();
 
     */
     virtual void RefreshChildren();
 

-    /** Special handling for attributes of this property.
+    /**
+        Reimplement this member function to add special handling for
+        attributes of this property.

 
 

-        If returns false, then the attribute will be automatically stored in
-        m_attributes.
+        @return Return @false to have the attribute automatically stored in
+                m_attributes. Default implementation simply does that and
+                nothing else.

 
 

-        Default implementation simply returns false.
+        @remarks To actually set property attribute values from the
+                 application, use wxPGProperty::SetAttribute() instead.

     */
     virtual bool DoSetAttribute( const wxString& name, wxVariant& value );
 
     */
     virtual bool DoSetAttribute( const wxString& name, wxVariant& value );
 


@@ -1519,6 +1527,17 @@ public:
     */
     void DeleteChoice( int index );
 
     */
     void DeleteChoice( int index );
 

+    /**
+        Enables or disables the property. Disabled property usually appears
+        as having grey text.
+
+        @param enable
+            If @false, property is disabled instead.
+
+        @see wxPropertyGridInterface::EnableProperty()
+    */
+    void Enable( bool enable = true );
+

     /**
         Call to enable or disable usage of common value (integer value that can
         be selected for properties instead of their normal values) for this
     /**
         Call to enable or disable usage of common value (integer value that can
         be selected for properties instead of their normal values) for this


@@ -1686,7 +1705,12 @@ public:
         return m_value.IsNull();
     }
 
         return m_value.IsNull();
     }
 

-    FlagType HasFlag( FlagType flag ) const
+    /**
+        Returns non-zero if property has given flag set.
+
+        @see propgrid_propflags
+    */
+    FlagType HasFlag( wxPGPropertyFlags flag ) const

     {
         return ( m_flags & flag );
     }
     {
         return ( m_flags & flag );
     }


@@ -1702,6 +1726,9 @@ public:
     */
     wxVariant GetAttributesAsList() const;
 
     */
     wxVariant GetAttributesAsList() const;
 

+    /**
+        Returns property flags.
+    */

     FlagType GetFlags() const
     {
         return m_flags;
     FlagType GetFlags() const
     {
         return m_flags;


@@ -1855,7 +1882,7 @@ public:
             By default changes are applied recursively. Set this paramter
             wxPG_DONT_RECURSE to prevent this.
     */
             By default changes are applied recursively. Set this paramter
             wxPG_DONT_RECURSE to prevent this.
     */

-    inline bool Hide( bool hide, int flags = wxPG_RECURSE );
+    bool Hide( bool hide, int flags = wxPG_RECURSE );

 
     bool IsExpanded() const
         { return (!(m_flags & wxPG_PROP_COLLAPSED) && GetChildCount()); }
 
     bool IsExpanded() const
         { return (!(m_flags & wxPG_PROP_COLLAPSED) && GetChildCount()); }


@@ -1885,6 +1912,21 @@ public:
 
     void SetAttributes( const wxPGAttributeStorage& attributes );
 
 
     void SetAttributes( const wxPGAttributeStorage& attributes );
 

+    /**
+        Set if user can change the property's value to unspecified by
+        modifying the value of the editor control (usually by clearing
+        it).  Currently, this can work with following properties:
+        wxIntProperty, wxUIntProperty, wxFloatProperty, wxEditEnumProperty.
+        
+        @param enable
+            Whether to enable or disable this behavior (it is disabled by
+            default).
+    */
+    void SetAutoUnspecified( bool enable = true )
+    {
+        ChangeFlag(wxPG_PROP_AUTO_UNSPECIFIED, enable);
+    }
+

     /**
         Sets property's background colour.
 
     /**
         Sets property's background colour.
 


@@ -1921,7 +1963,6 @@ public:
     */
     void SetDefaultValue( wxVariant& value );
 
     */
     void SetDefaultValue( wxVariant& value );
 

-#ifndef SWIG

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


@@ -1936,7 +1977,6 @@ public:
     {
         m_customEditor = editor;
     }
     {
         m_customEditor = editor;
     }

-#endif

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


@@ -2018,14 +2058,16 @@ public:
     }
 
     /**
     }
 
     /**

-        Sets given property flag(s).
-    */
-    void SetFlag( FlagType flag ) { m_flags |= flag; }
+        Sets or clears given property flag. Mainly for internal use.

 
 

-    /**
-        Sets or clears given property flag(s).
+        @remarks Setting a property flag never has any side-effect, and is
+                 intended almost exclusively for internal use. So, for
+                 example, if you want to disable a property, call
+                 Enable(false) instead of setting wxPG_PROP_DISABLED flag.
+
+        @see HasFlag(), GetFlags()

     */
     */

-    void ChangeFlag( FlagType flag, bool set )
+    void ChangeFlag( wxPGPropertyFlags flag, bool set )

     {
         if ( set )
             m_flags |= flag;
     {
         if ( set )
             m_flags |= flag;


@@ -2033,7 +2075,13 @@ public:
             m_flags &= ~flag;
     }
 
             m_flags &= ~flag;
     }
 

-    void SetFlagRecursively( FlagType flag, bool set );
+    /**
+        Sets or clears given property flag, recursively. This function is
+        primarily intended for internal use.
+
+        @see ChangeFlag()
+    */
+    void SetFlagRecursively( wxPGPropertyFlags flag, bool set );

 
     void SetHelpString( const wxString& helpString )
     {
 
     void SetHelpString( const wxString& helpString )
     {


@@ -2090,7 +2138,6 @@ public:
     }
 #endif // wxUSE_VALIDATORS
 
     }
 #endif // wxUSE_VALIDATORS
 

-#ifndef SWIG

     /** Returns client data (void*) of a property.
     */
     void* GetClientData() const
     /** Returns client data (void*) of a property.
     */
     void* GetClientData() const


@@ -2118,14 +2165,14 @@ public:
     /** Sets managed client object of a property.
     */
     wxClientData *GetClientObject() const { return m_clientObject; }
     /** Sets managed client object of a property.
     */
     wxClientData *GetClientObject() const { return m_clientObject; }

-#endif

 
 

-    /** Sets new set of choices for property.
+    /**
+        Sets new set of choices for the property.

 
 

-        @remarks
-        This operation clears the property value.
+        @remarks This operation deselects the property and clears its
+                 value.

     */
     */

-    bool SetChoices( wxPGChoices& choices );
+    bool SetChoices( const wxPGChoices& choices );

 
     /** Set max length of text in text editor.
     */
 
     /** Set max length of text in text editor.
     */


@@ -2145,8 +2192,6 @@ public:
         return m_helpString;
     }
 
         return m_helpString;
     }
 

-    void ClearFlag( FlagType flag ) { m_flags &= ~(flag); }
-

     // Use, for example, to detect if item is inside collapsed section.
     bool IsSomeParent( wxPGProperty* candidate_parent ) const;
 
     // Use, for example, to detect if item is inside collapsed section.
     bool IsSomeParent( wxPGProperty* candidate_parent ) const;
 


@@ -2216,16 +2261,12 @@ public:
     */
     int GetImageOffset( int imageWidth ) const;
 
     */
     int GetImageOffset( int imageWidth ) const;
 

-#ifndef SWIG

     // Returns wxPropertyGridPageState in which this property resides.
     wxPropertyGridPageState* GetParentState() const { return m_parentState; }
     // Returns wxPropertyGridPageState in which this property resides.
     wxPropertyGridPageState* GetParentState() const { return m_parentState; }

-#endif

 
 

-#ifndef SWIG

     wxPGProperty* GetItemAtY( unsigned int y,
                               unsigned int lh,
                               unsigned int* nextItemY ) const;
     wxPGProperty* GetItemAtY( unsigned int y,
                               unsigned int lh,
                               unsigned int* nextItemY ) const;

-#endif

 
     /** Returns property at given virtual y coordinate.
     */
 
     /** Returns property at given virtual y coordinate.
     */


@@ -2235,8 +2276,6 @@ public:
     */
     wxPGProperty* GetPropertyByName( const wxString& name ) const;
 
     */
     wxPGProperty* GetPropertyByName( const wxString& name ) const;
 

-#ifndef SWIG
-

     // Returns various display-related information for given column
     void GetDisplayInfo( unsigned int column,
                          int choiceIndex,
     // Returns various display-related information for given column
     void GetDisplayInfo( unsigned int column,
                          int choiceIndex,


@@ -2318,6 +2357,8 @@ protected:
                                   const wxVariantList* valueOverrides = NULL,
                                   wxPGHashMapS2S* childResults = NULL ) const;
 
                                   const wxVariantList* valueOverrides = NULL,
                                   wxPGHashMapS2S* childResults = NULL ) const;
 

+    bool DoHide( bool hide, int flags );
+

     void DoSetName(const wxString& str) { m_name = str; }
 
     /** Deletes all sub-properties. */
     void DoSetName(const wxString& str) { m_name = str; }
 
     /** Deletes all sub-properties. */


@@ -2336,11 +2377,24 @@ protected:
     // Removes child property with given pointer. Does not delete it.
     void RemoveChild( wxPGProperty* p );
 
     // Removes child property with given pointer. Does not delete it.
     void RemoveChild( wxPGProperty* p );
 

+    void DoEnable( bool enable );
+

     void DoPreAddChild( int index, wxPGProperty* prop );
 
     void SetParentState( wxPropertyGridPageState* pstate )
         { m_parentState = pstate; }
 
     void DoPreAddChild( int index, wxPGProperty* prop );
 
     void SetParentState( wxPropertyGridPageState* pstate )
         { m_parentState = pstate; }
 

+    void SetFlag( wxPGPropertyFlags flag )
+    {
+        //
+        // NB: While using wxPGPropertyFlags here makes it difficult to
+        //     combine different flags, it usefully prevents user from
+        //     using incorrect flags (say, wxWindow styles).
+        m_flags |= flag;
+    }
+
+    void ClearFlag( FlagType flag ) { m_flags &= ~(flag); }
+

     // Call after fixed sub-properties added/removed after creation.
     // if oldSelInd >= 0 and < new max items, then selection is
     // moved to it.
     // Call after fixed sub-properties added/removed after creation.
     // if oldSelInd >= 0 and < new max items, then selection is
     // moved to it.


@@ -2404,7 +2458,6 @@ private:
     // Called in constructors.
     void Init();
     void Init( const wxString& label, const wxString& name );
     // Called in constructors.
     void Init();
     void Init( const wxString& label, const wxString& name );

-#endif // #ifndef SWIG

 };
 
 // -----------------------------------------------------------------------
 };
 
 // -----------------------------------------------------------------------


@@ -2417,14 +2470,12 @@ private:
 #define WX_PG_DECLARE_DOGETEDITORCLASS \
     virtual const wxPGEditor* DoGetEditorClass() const;
 
 #define WX_PG_DECLARE_DOGETEDITORCLASS \
     virtual const wxPGEditor* DoGetEditorClass() const;
 

-#ifndef SWIG
+#ifndef WX_PG_DECLARE_PROPERTY_CLASS

     #define WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME) \
         public: \
             DECLARE_DYNAMIC_CLASS(CLASSNAME) \
             WX_PG_DECLARE_DOGETEDITORCLASS \
         private:
     #define WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME) \
         public: \
             DECLARE_DYNAMIC_CLASS(CLASSNAME) \
             WX_PG_DECLARE_DOGETEDITORCLASS \
         private:

-#else
-    #define WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME)

 #endif
 
 // Implements sans constructor function. Also, first arg is class name, not
 #endif
 
 // Implements sans constructor function. Also, first arg is class name, not


@@ -2437,8 +2488,6 @@ const wxPGEditor* PROPNAME::DoGetEditorClass() const \
 
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------
 

-#ifndef SWIG
-

 /** @class wxPGRootProperty
     @ingroup classes
     Root parent property.
 /** @class wxPGRootProperty
     @ingroup classes
     Root parent property.


@@ -2484,6 +2533,7 @@ public:
     int GetTextExtent( const wxWindow* wnd, const wxFont& font ) const;
 
     virtual wxString ValueToString( wxVariant& value, int argFlags ) const;
     int GetTextExtent( const wxWindow* wnd, const wxFont& font ) const;
 
     virtual wxString ValueToString( wxVariant& value, int argFlags ) const;

+    virtual wxString GetValueAsString( int argFlags = 0 ) const;

 
 protected:
     void SetTextColIndex( unsigned int colInd )
 
 protected:
     void SetTextColIndex( unsigned int colInd )


@@ -2500,8 +2550,6 @@ private:
     void Init();
 };
 
     void Init();
 };
 

-#endif  // !SWIG
-

 // -----------------------------------------------------------------------
 
 #endif // wxUSE_PROPGRID
 // -----------------------------------------------------------------------
 
 #endif // wxUSE_PROPGRID