]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/propgrid/property.h
avoid infinite recursion for richtooltops, (hopefully) fixes #15070
[wxWidgets.git] / interface / wx / propgrid / property.h
index bf6bd0d8a4b5178551a1ae3646b03aebbf2d49b1..b3a77c696517ad298b01d5ca4ce8224669f6357c 100644 (file)
 */
 #define wxPG_FILE_DIALOG_TITLE              wxS("DialogTitle")
 
+/** Specific to wxFileProperty and derivatives, long, default is 0.
+    Sets a specific wxFileDialog style for the file dialog, e.g. ::wxFD_SAVE.
+
+    @since 2.9.4
+*/
+#define wxPG_FILE_DIALOG_STYLE              wxS("DialogStyle")
+
 /** Specific to wxDirProperty, wxString, default is empty.
     Sets a specific message for the dir dialog.
 */
@@ -222,8 +229,8 @@ wxPG_PROP_COLLAPSED                 = 0x0020,
     value.
 
     If property is not selected, then indicates that the actual property
-    value has failed validation (NB: this behavior is not currently supported,
-    but may be used in future).
+    value has failed validation (NB: this behaviour is not currently supported,
+    but may be used in the future).
 */
 wxPG_PROP_INVALID_VALUE             = 0x0040,
 
@@ -417,15 +424,15 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
 
     Note that when displaying the value, sign is omitted if the resulting
     textual representation is effectively zero (for example, -0.0001 with
-    precision of 3 will become 0.0 instead of -0.0). This behavior is unlike 
+    precision of 3 will become 0.0 instead of -0.0). This behaviour is unlike 
     what C standard library does, but should result in better end-user
     experience in almost all cases.
 
     @subsection wxBoolProperty
 
     Represents a boolean value. wxChoice is used as editor control, by the
-    default. wxPG_BOOL_USE_CHECKBOX attribute can be set to true in order to use
-    check box instead.
+    default. wxPG_BOOL_USE_CHECKBOX attribute can be set to true in order to
+    use check box instead.
 
     @subsection wxLongStringProperty
 
@@ -474,7 +481,7 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
     Like wxLongStringProperty, but the button triggers file selector instead.
     Default wildcard is "All files..." but this can be changed by setting
     wxPG_FILE_WILDCARD attribute (see wxFileDialog for format details).
-    Attribute wxPG_FILE_SHOW_FULL_PATH can be set to @false inorder to show
+    Attribute wxPG_FILE_SHOW_FULL_PATH can be set to @false in order to show
     only the filename, not the entire path.
 
     @subsection wxEnumProperty
@@ -505,7 +512,7 @@ wxPG_PROP_BEING_DELETED             = 0x00200000
     wxDateTime property. Default editor is DatePickerCtrl, although TextCtrl
     should work as well. wxPG_DATE_FORMAT attribute can be used to change
     string wxDateTime::Format uses (although default is recommended as it is
-    locale-dependant), and wxPG_DATE_PICKER_STYLE allows changing window
+    locale-dependent), and wxPG_DATE_PICKER_STYLE allows changing window
     style given to DatePickerCtrl (default is wxDP_DEFAULT|wxDP_SHOWCENTURY).
     Using wxDP_ALLOWNONE will enable better unspecified value support.
 
@@ -767,7 +774,7 @@ public:
 
                 You might want to take into account that m_value is Null variant
                 if property value is unspecified (which is usually only case if
-                you explicitly enabled that sort behavior).
+                you explicitly enabled that sort behaviour).
     */
     virtual bool StringToValue( wxVariant& variant, const wxString& text, int argFlags = 0 ) const;
 
@@ -795,7 +802,7 @@ public:
           instead of OnEvent.
         - You might want to take into account that m_value is Mull variant if
           property value is unspecified (which is usually only case if you
-          explicitly enabled that sort behavior).
+          explicitly enabled that sort behaviour).
     */
     virtual bool IntToValue( wxVariant& variant, int number, int argFlags = 0 ) const;
 
@@ -818,7 +825,7 @@ public:
 
     /**
         Converts string to a value, and if successful, calls SetValue() on it.
-        Default behavior is to do nothing.
+        Default behaviour is to do nothing.
 
         @param text
             String to get the value from.
@@ -831,7 +838,7 @@ public:
 
     /**
         Converts integer to a value, and if successful, calls SetValue() on it.
-        Default behavior is to do nothing.
+        Default behaviour is to do nothing.
 
         @param value
             Int to get the value from.
@@ -851,7 +858,7 @@ public:
             Normally -1, but can be an index to the property's list of items.
 
         @remarks
-        - Default behavior is to return wxSize(0,0), which means no image.
+        - Default behaviour is to return wxSize(0,0), which means no image.
         - Default image width or height is indicated with dimension -1.
         - You can also return wxPG_DEFAULT_IMAGE_SIZE which equals wxSize(-1, -1).
     */
@@ -1181,9 +1188,6 @@ public:
     */
     void DeleteChoice( int index );
 
-    /** Deletes all child properties. */
-    void Empty();
-
     /**
         Enables or disables the property. Disabled property usually appears
         as having grey text.
@@ -1540,7 +1544,7 @@ public:
         wxIntProperty, wxUIntProperty, wxFloatProperty, wxEditEnumProperty.
 
         @param enable
-            Whether to enable or disable this behavior (it is disabled by
+            Whether to enable or disable this behaviour (it is disabled by
             default).
     */
     void SetAutoUnspecified( bool enable = true );
@@ -1741,6 +1745,10 @@ public:
         Returns @true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
     */
     bool UsesAutoUnspecified() const;
+
+protected:
+    /** Deletes all child properties. */
+    void Empty();
 };
 
 
@@ -1862,9 +1870,6 @@ public:
     */
     void Add( const wxChar** labels, const ValArrItem* values = NULL );
 
-    /** Version that works with wxArrayString. */
-    void Add( const wxArrayString& arr, const ValArrItem* values = NULL );
-
     /** Version that works with wxArrayString and wxArrayInt. */
     void Add( const wxArrayString& arr, const wxArrayInt& arrint );
 
@@ -1930,15 +1935,6 @@ public:
     wxArrayInt GetIndicesForStrings( const wxArrayString& strings,
                                      wxArrayString* unmatched = NULL ) const;
 
-    /** Returns property at given virtual y coordinate.
-    */
-    wxPGProperty* GetItemAtY( unsigned int y ) const;
-
-    /**
-        Returns @true if item at given index has a valid value;
-    */
-    bool HasValue( unsigned int i ) const;
-
     /**
         Returns index of item with given label.
     */