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

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

diff --git a/include/wx/propgrid/propgriddefs.h b/include/wx/propgrid/propgriddefs.h
index e5c1236f4b1ed9c1ebd3ffd66a3277215095d137..cff40b5048d6319fb330f60b41ee536741b4c18b 100644 (file)
--- a/include/wx/propgrid/propgriddefs.h
+++ b/include/wx/propgrid/propgriddefs.h
@@ -4,7 +4,7 @@
 // Author:      Jaakko Salli
 // Modified by:
 // Created:     2008-08-31
 // Author:      Jaakko Salli
 // Modified by:
 // Created:     2008-08-31

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

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


@@ -12,7 +12,10 @@
 #ifndef _WX_PROPGRID_PROPGRIDDEFS_H_
 #define _WX_PROPGRID_PROPGRIDDEFS_H_
 
 #ifndef _WX_PROPGRID_PROPGRIDDEFS_H_
 #define _WX_PROPGRID_PROPGRIDDEFS_H_
 

+#if wxUSE_PROPGRID
+

 #include "wx/dynarray.h"
 #include "wx/dynarray.h"

+#include "wx/vector.h"

 #include "wx/hashmap.h"
 #include "wx/variant.h"
 #include "wx/longlong.h"
 #include "wx/hashmap.h"
 #include "wx/variant.h"
 #include "wx/longlong.h"


@@ -81,7 +84,7 @@
     // comment to use bitmap buttons
     #define wxPG_ICON_WIDTH             9
     // 1 if wxRendererNative should be employed
     // comment to use bitmap buttons
     #define wxPG_ICON_WIDTH             9
     // 1 if wxRendererNative should be employed

-    #define wxPG_USE_RENDERER_NATIVE    0
+    #define wxPG_USE_RENDERER_NATIVE    1

 
     // 1 to use double-buffer that guarantees flicker-free painting
     #define wxPG_DOUBLE_BUFFER          1
 
     // 1 to use double-buffer that guarantees flicker-free painting
     #define wxPG_DOUBLE_BUFFER          1


@@ -117,7 +120,7 @@
     #define wxPG_XBEFOREWIDGET          1
 
     // x position adjustment for wxTextCtrl (and like)
     #define wxPG_XBEFOREWIDGET          1
 
     // x position adjustment for wxTextCtrl (and like)

-    #define wxPG_TEXTCTRLXADJUST        3
+    #define wxPG_TEXTCTRLXADJUST        0

 
     // comment to use bitmap buttons
     #define wxPG_ICON_WIDTH             11
 
     // comment to use bitmap buttons
     #define wxPG_ICON_WIDTH             11


@@ -226,6 +229,12 @@
 // (for tree buttons)
 //#undef wxPG_ICON_WIDTH
 
 // (for tree buttons)
 //#undef wxPG_ICON_WIDTH
 

+#if WXWIN_COMPATIBILITY_2_6 || WXWIN_COMPATIBILITY_2_8
+    #define wxPG_COMPATIBILITY_1_4      1
+#else
+    #define wxPG_COMPATIBILITY_1_4      0
+#endif
+

 // Need to force disable tooltips?
 #if !wxUSE_TOOLTIPS
     #undef wxPG_SUPPORT_TOOLTIPS
 // Need to force disable tooltips?
 #if !wxUSE_TOOLTIPS
     #undef wxPG_SUPPORT_TOOLTIPS


@@ -243,14 +252,6 @@
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------
 
 

-// wxPG_CHECK_FOO_DBG - debug check with message that does not
-//                      interrupt program flow.
-#define wxPG_CHECK_RET_DBG(A,B) \
-    if ( !(A) ) { wxLogWarning(B); return; }
-#define wxPG_CHECK_MSG_DBG(A,B,C) \
-    if ( !(A) ) { wxLogWarning(C); return B; }
-
-

 class wxPGEditor;
 class wxPGProperty;
 class wxPropertyCategory;
 class wxPGEditor;
 class wxPGProperty;
 class wxPropertyCategory;


@@ -265,9 +266,8 @@ class wxPropertyGrid;
 class wxPropertyGridEvent;
 class wxPropertyGridManager;
 class wxPGOwnerDrawnComboBox;
 class wxPropertyGridEvent;
 class wxPropertyGridManager;
 class wxPGOwnerDrawnComboBox;

-class wxPGCustomComboControl;

 class wxPGEditorDialogAdapter;
 class wxPGEditorDialogAdapter;

-struct wxPGValidationInfo;
+class wxPGValidationInfo;

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


@@ -301,6 +301,29 @@ struct wxPGValidationInfo;
 #define wxPG_DEFAULT_IMAGE_SIZE             wxSize(-1, -1)
 
 
 #define wxPG_DEFAULT_IMAGE_SIZE             wxSize(-1, -1)
 
 

+/** This callback function is used for sorting properties.
+
+    Call wxPropertyGrid::SetSortFunction() to set it.
+
+    Sort function should return a value greater than 0 if position of p1 is
+    after p2. So, for instance, when comparing property names, you can use
+    following implementation:
+
+        @code
+            int MyPropertySortFunction(wxPropertyGrid* propGrid,
+                                       wxPGProperty* p1,
+                                       wxPGProperty* p2)
+            {
+                return p1->GetBaseName().compare( p2->GetBaseName() );
+            }
+        @endcode
+*/
+typedef int (*wxPGSortCallback)(wxPropertyGrid* propGrid,
+                                wxPGProperty* p1,
+                                wxPGProperty* p2);
+
+
+

 typedef wxString wxPGCachedString;
 
 /** @}
 typedef wxString wxPGCachedString;
 
 /** @}


@@ -329,7 +352,10 @@ WX_DECLARE_STRING_HASH_MAP_WITH_DECL(void*,
                                      wxPGHashMapS2P,
                                      class WXDLLIMPEXP_PROPGRID);
 
                                      wxPGHashMapS2P,
                                      class WXDLLIMPEXP_PROPGRID);
 

-
+WX_DECLARE_STRING_HASH_MAP_WITH_DECL(wxString,
+                                     wxPGHashMapS2S,
+                                     class WXDLLIMPEXP_PROPGRID);
+ 

 WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL(void*,
                                       wxPGHashMapP2P,
                                       class WXDLLIMPEXP_PROPGRID);
 WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL(void*,
                                       wxPGHashMapP2P,
                                       class WXDLLIMPEXP_PROPGRID);


@@ -361,7 +387,12 @@ wxPG_INC_ATTRIBUTES               = 0x00000040,
 wxPG_RECURSE_STARTS               = 0x00000080,
 
 /** Force value change. */
 wxPG_RECURSE_STARTS               = 0x00000080,
 
 /** Force value change. */

-wxPG_FORCE                        = 0x00000100
+wxPG_FORCE                        = 0x00000100,
+
+/** Only sort categories and their immediate children.
+    Sorting done by wxPG_AUTO_SORT option uses this.
+*/
+wxPG_SORT_TOP_LEVEL_ONLY          = 0x00000200

 
 };
 
 
 };
 


@@ -389,7 +420,14 @@ enum wxPG_MISC_ARG_FLAGS
 
     // Means property for which final string value is for can not really be
     // edited.
 
     // Means property for which final string value is for can not really be
     // edited.

-    wxPG_UNEDITABLE_COMPOSITE_FRAGMENT  = 0x00000020
+    wxPG_UNEDITABLE_COMPOSITE_FRAGMENT  = 0x00000020,
+
+    // ValueToString() called from GetValueAsString()
+    // (guarantees that input wxVariant value is current own value)
+    wxPG_VALUE_IS_CURRENT               = 0x00000040,
+
+    // Value is being set programmatically (ie. not by user)
+    wxPG_PROGRAMMATIC_VALUE             = 0x00000080

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


@@ -424,7 +462,7 @@ enum wxPG_SETVALUE_FLAGS
 
 #ifndef SWIG
 
 
 #ifndef SWIG
 

-// Editor accessor.
+// Editor accessor (for backwards compatiblity use only).

 #define wxPG_EDITOR(T)          wxPGEditor_##T
 
 // Declare editor class, with optional part.
 #define wxPG_EDITOR(T)          wxPGEditor_##T
 
 // Declare editor class, with optional part.


@@ -511,7 +549,9 @@ extern expdecl const char* classname##_VariantType;
 #define WX_PG_IMPLEMENT_VARIANT_DATA(classname) \
     WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
 
 #define WX_PG_IMPLEMENT_VARIANT_DATA(classname) \
     WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
 

-#define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ(classname,expdecl) \
+// Add getter (ie. classname << variant) separately to allow
+// custom implementations.
+#define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,expdecl) \

 const char* classname##_VariantType = #classname; \
 class classname##VariantData: public wxVariantData \
 { \
 const char* classname##_VariantType = #classname; \
 class classname##VariantData: public wxVariantData \
 { \


@@ -520,16 +560,14 @@ public:\
     classname##VariantData( const classname &value ) { m_value = value; } \
 \
     classname &GetValue() { return m_value; } \
     classname##VariantData( const classname &value ) { m_value = value; } \
 \
     classname &GetValue() { return m_value; } \

+\
+    const classname &GetValue() const { return m_value; } \

 \
     virtual bool Eq(wxVariantData& data) const; \
 \
     virtual wxString GetType() const; \
 \
     virtual wxVariantData* Clone() const { return new classname##VariantData(m_value); } \
 \
     virtual bool Eq(wxVariantData& data) const; \
 \
     virtual wxString GetType() const; \
 \
     virtual wxVariantData* Clone() const { return new classname##VariantData(m_value); } \

-\
-    classname& GetValueRef() { return m_value; } \
-\
-    const classname& GetValueRef() const { return m_value; } \

 \
 protected:\
     classname m_value; \
 \
 protected:\
     classname m_value; \


@@ -540,15 +578,6 @@ wxString classname##VariantData::GetType() const\
     return wxS(#classname);\
 }\
 \
     return wxS(#classname);\
 }\
 \

-expdecl classname& operator << ( classname &value, const wxVariant &variant )\
-{\
-    wxASSERT( variant.GetType() == #classname );\
-    \
-    classname##VariantData *data = (classname##VariantData*) variant.GetData();\
-    value = data->GetValue();\
-    return value;\
-}\
-\

 expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\
 {\
     classname##VariantData *data = new classname##VariantData( value );\
 expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\
 {\
     classname##VariantData *data = new classname##VariantData( value );\


@@ -559,20 +588,26 @@ expdecl classname& classname##RefFromVariant( wxVariant& variant ) \
 { \
     wxASSERT( variant.GetType() == #classname );\
     classname##VariantData *data = (classname##VariantData*) variant.GetData();\
 { \
     wxASSERT( variant.GetType() == #classname );\
     classname##VariantData *data = (classname##VariantData*) variant.GetData();\

-    return data->GetValueRef();\
+    return data->GetValue();\

 } \
 expdecl const classname& classname##RefFromVariant( const wxVariant& variant ) \
 { \
     wxASSERT( variant.GetType() == #classname );\
     classname##VariantData *data = (classname##VariantData*) variant.GetData();\
 } \
 expdecl const classname& classname##RefFromVariant( const wxVariant& variant ) \
 { \
     wxASSERT( variant.GetType() == #classname );\
     classname##VariantData *data = (classname##VariantData*) variant.GetData();\

-    return data->GetValueRef();\
+    return data->GetValue();\

 }
 
 }
 

-// implements a wxVariantData-derived class using for the Eq() method the
-// operator== which must have been provided by "classname"
-#define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname,expdecl) \
-WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
-\
+#define WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname, expdecl) \
+expdecl classname& operator << ( classname &value, const wxVariant &variant )\
+{\
+    wxASSERT( variant.GetType() == #classname );\
+    \
+    classname##VariantData *data = (classname##VariantData*) variant.GetData();\
+    value = data->GetValue();\
+    return value;\
+}
+
+#define WX_PG_IMPLEMENT_VARIANT_DATA_EQ(classname, expdecl) \

 bool classname##VariantData::Eq(wxVariantData& data) const \
 {\
     wxASSERT( GetType() == data.GetType() );\
 bool classname##VariantData::Eq(wxVariantData& data) const \
 {\
     wxASSERT( GetType() == data.GetType() );\


@@ -582,12 +617,20 @@ bool classname##VariantData::Eq(wxVariantData& data) const \
     return otherData.m_value == m_value;\
 }
 
     return otherData.m_value == m_value;\
 }
 

+// implements a wxVariantData-derived class using for the Eq() method the
+// operator== which must have been provided by "classname"
+#define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname,expdecl) \
+WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
+WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
+WX_PG_IMPLEMENT_VARIANT_DATA_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl)
+

 #define WX_PG_IMPLEMENT_VARIANT_DATA(classname) \
 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
 
 // with Eq() implementation that always returns false
 #define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_DUMMY_EQ(classname,expdecl) \
 #define WX_PG_IMPLEMENT_VARIANT_DATA(classname) \
 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
 
 // with Eq() implementation that always returns false
 #define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_DUMMY_EQ(classname,expdecl) \

-WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
+WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
+WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \

 \
 bool classname##VariantData::Eq(wxVariantData& WXUNUSED(data)) const \
 {\
 \
 bool classname##VariantData::Eq(wxVariantData& WXUNUSED(data)) const \
 {\


@@ -617,6 +660,27 @@ template<> inline wxVariant WXVARIANT( const wxColour& value )
     return variant;
 }
 
     return variant;
 }
 

+#if wxUSE_LONGLONG_NATIVE
+
+template<> inline wxVariant WXVARIANT( const wxLongLong_t& value )
+{
+    wxVariant variant;
+    variant << wxLongLong(value);
+    return variant;
+}
+
+template<> inline wxVariant WXVARIANT( const wxULongLong_t& value )
+{
+    wxVariant variant;
+    variant << wxULongLong(value);
+    return variant;
+}
+
+WXDLLIMPEXP_PROPGRID wxLongLong_t& operator << ( wxLongLong_t &value, const wxVariant &variant );
+WXDLLIMPEXP_PROPGRID wxULongLong_t& operator << ( wxULongLong_t &value, const wxVariant &variant );
+
+#endif  // wxUSE_LONGLONG_NATIVE
+

 // Define constants for common wxVariant type strings
 
 #define wxPG_VARIANT_TYPE_STRING        wxPGGlobalVars->m_strstring
 // Define constants for common wxVariant type strings
 
 #define wxPG_VARIANT_TYPE_STRING        wxPGGlobalVars->m_strstring


@@ -710,4 +774,6 @@ protected:
 
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------
 

+#endif // wxUSE_PROPGRID
+

 #endif // _WX_PROPGRID_PROPGRIDDEFS_H_
 #endif // _WX_PROPGRID_PROPGRIDDEFS_H_