///////////////////////////////////////////////////////////////////////////// // Name: property.h // Purpose: interface of wxPGProperty // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// // ----------------------------------------------------------------------- /** @class wxPropertyGridInterface Most of the shared property manipulation interface shared by wxPropertyGrid, wxPropertyGridPage, and wxPropertyGridManager is defined in this class. @remarks - In separate wxPropertyGrid component this class was known as wxPropertyContainerMethods. - wxPropertyGridInterface's property operation member functions all accept a special wxPGPropArg id argument, using which you can refer to properties either by their pointer (for performance) or by their name (for conveniency). @library{wxpropgrid} @category{propgrid} */ class WXDLLIMPEXP_PROPGRID wxPropertyGridInterface { public: /** Destructor */ virtual ~wxPropertyGridInterface() { } /** Appends property to the list. wxPropertyGrid assumes ownership of the object. Becomes child of most recently added category. @remarks - wxPropertyGrid takes the ownership of the property pointer. - If appending a category with name identical to a category already in the wxPropertyGrid, then newly created category is deleted, and most recently added category (under which properties are appended) is set to the one with same name. This allows easier adding of items to same categories in multiple passes. - Does not automatically redraw the control, so you may need to call Refresh() when calling this function after control has been shown for the first time. - This functions deselects selected property, if any. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value. */ wxPGProperty* Append( wxPGProperty* property ); /** Same as Append(), but appends under given parent property. @param id Name or pointer to parent property. @param newProperty Property to be added. */ wxPGProperty* AppendIn( wxPGPropArg id, wxPGProperty* newProperty ); /** In order to add new items into a property with private children (for instance, wxFlagsProperty), you need to call this method. After populating has been finished, you need to call EndAddChildren(). @see EndAddChildren() */ void BeginAddChildren( wxPGPropArg id ); /** Deletes all properties. @remarks This functions deselects selected property, if any. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value. */ virtual void Clear() = 0; /** 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. */ void ClearModifiedStatus(); /** Collapses given category or property with children. @return Returns @true if actually collapsed. @remarks This function may deselect selected property, if any. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value. */ bool Collapse( wxPGPropArg id ); /** Collapses all items that can be collapsed. @remarks This functions clears selection. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value. */ bool CollapseAll(); /** Changes value of a property, as if by user. Use this instead of SetPropertyValue() if you need the value to run through validation process, and also send the property change event. @return Returns @true if value was successfully changed. */ bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue ); /** Deletes a property. @remarks This functions deselects selected property, if any. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value. */ void DeleteProperty( wxPGPropArg id ); /** Disables a property. */ bool DisableProperty( wxPGPropArg id ); /** Returns @true if all property grid data changes have been committed. Usually only returns @false if value in active editor has been invalidated by a wxValidator. */ bool EditorValidate(); /** Enables or disables property. @param id Name or pointer to a property. @param enable If @false, property is disabled instead. */ bool EnableProperty( wxPGPropArg id, bool enable = true ); /** Called after population of property with fixed children has finished. @see BeginAddChildren() */ void EndAddChildren( wxPGPropArg id ); /** Expands given category or property with children. @return Returns @true if actually expanded. @remarks This function may deselect selected property, if any. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value. */ bool Expand( wxPGPropArg id ); /** Expands all items that can be expanded. @remarks This functions clears selection. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value. */ bool ExpandAll( bool expand = true ); /** Returns id of first child of given property. @remarks Does not return private children! */ wxPGProperty* GetFirstChild( wxPGPropArg id ); //@{ /** Returns iterator class instance. @param flags See @ref propgrid_iterator_flags. Value wxPG_ITERATE_DEFAULT causes iteration over everything except private child properties. @param firstProp Property to start iteration from. If @NULL, then first child of root is used. @beginWxPythonOnly wxPython Note: Instead of ++ operator, use Next() method, and instead of * operator, use GetProperty() method. @endWxPythonOnly */ wxPropertyGridIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT, wxPGProperty* firstProp = NULL ); wxPropertyGridConstIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT, wxPGProperty* firstProp = NULL ) const; //@} //@{ /** Returns iterator class instance. @param flags See @ref propgrid_iterator_flags. Value wxPG_ITERATE_DEFAULT causes iteration over everything except private child properties. @param startPos Either wxTOP or wxBOTTOM. wxTOP will indicate that iterations start from the first property from the top, and wxBOTTOM means that the iteration will instead begin from bottommost valid item. @beginWxPythonOnly wxPython Note: Instead of ++ operator, use Next() method, and instead of * operator, use GetProperty() method. @endWxPythonOnly */ wxPropertyGridIterator GetIterator( int flags, int startPos ); wxPropertyGridConstIterator GetIterator( int flags, int startPos ) const; //@} /** Returns id of first item that matches given criteria. @param flags See @ref propgrid_iterator_flags. */ wxPGProperty* GetFirst( int flags = wxPG_ITERATE_ALL ); /** Returns id of property with given name (case-sensitive). */ wxPGProperty* GetProperty( const wxString& name ) const; /** Adds to 'targetArr' pointers to properties that have given flags 'flags' set. However, if @a 'inverse' is set to @true, then only properties without given flags are stored. @param targetArr @todo docme @param flags Property flags to use. @param inverse @todo docme @param iterFlags Iterator flags to use. Default is everything expect private children. See @ref propgrid_iterator_flags. */ void GetPropertiesWithFlag( wxArrayPGProperty* targetArr, wxPGProperty::FlagType flags, bool inverse = false, int iterFlags = (wxPG_ITERATE_PROPERTIES|wxPG_ITERATE_HIDDEN|wxPG_ITERATE_CATEGORIES) ) const; /** Returns value of given attribute. If none found, returns wxNullVariant. */ wxVariant GetPropertyAttribute( wxPGPropArg id, const wxString& attrName ) const; /** Returns background colour of first cell of a property. */ wxColour GetPropertyBackgroundColour( wxPGPropArg id ) const; /** Returns pointer of property's nearest parent category. If no category found, returns @NULL. */ wxPropertyCategory* GetPropertyCategory( wxPGPropArg id ) const; /** Returns client data (void*) of a property. */ void* GetPropertyClientData( wxPGPropArg id ) const; /** Returns first property which label matches given string. @NULL if none found. Note that this operation is very slow when compared to GetPropertyByName(). */ wxPGProperty* GetPropertyByLabel( const wxString& label ) const; /** Returns property with given name. @NULL if none found. */ wxPGProperty* GetPropertyByName( const wxString& name ) const; /** Returns child property 'subname' of property 'name'. Same as calling GetPropertyByName("name.subname"), albeit slightly faster. */ wxPGProperty* GetPropertyByName( const wxString& name, const wxString& subname ) const; /** Returns property's editor. */ const wxPGEditor* GetPropertyEditor( wxPGPropArg id ) const; /** Returns help string associated with a property. */ wxString GetPropertyHelpString( wxPGPropArg id ) const; /** Returns property's custom value image (@NULL of none). */ wxBitmap* GetPropertyImage( wxPGPropArg id ) const; /** Returns label of a property. */ const wxString& GetPropertyLabel( wxPGPropArg id ); /** Returns property's name, by which it is globally accessible. */ wxString GetPropertyName( wxPGProperty* property ); /** Returns text colour of first cell of a property. */ wxColour GetPropertyTextColour( wxPGPropArg id ) const; /** Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator. */ wxValidator* GetPropertyValidator( wxPGPropArg id ); /** Returns property's value as wxVariant. If property value is unspecified, Null variant is returned. */ wxVariant GetPropertyValue( wxPGPropArg id ); /** Return's property's value as wxArrayInt. */ wxArrayInt GetPropertyValueAsArrayInt( wxPGPropArg id ) const; /** Returns property's value as wxArrayString. */ wxArrayString GetPropertyValueAsArrayString( wxPGPropArg id ) const; /** Returns property's value as bool */ bool GetPropertyValueAsBool( wxPGPropArg id ) const; /** Return's property's value as wxDateTime. */ wxDateTime GetPropertyValueAsDateTime( wxPGPropArg id ) const; /** Returns property's value as double-precision floating point number. */ double GetPropertyValueAsDouble( wxPGPropArg id ) const; /** Returns property's value as integer */ int GetPropertyValueAsInt( wxPGPropArg id ) const; /** Returns property's value as integer */ long GetPropertyValueAsLong( wxPGPropArg id ) const; /** Returns property's value as native signed 64-bit integer. */ wxLongLong_t GetPropertyValueAsLongLong( wxPGPropArg id ) const; /** Returns property's value as wxString. If property does not use string value type, then its value is converted using wxPGProperty::GetValueAsString(). */ wxString GetPropertyValueAsString( wxPGPropArg id ) const; /** Returns property's value as unsigned integer */ unsigned long GetPropertyValueAsULong( wxPGPropArg id ) const; /** Returns property's value as native unsigned 64-bit integer. */ wxULongLong_t GetPropertyValueAsULongLong( wxPGPropArg id ) const; /** Returns a wxVariant list containing wxVariant versions of all property values. Order is not guaranteed. @param listname @todo docme @param baseparent @todo docme @param flags Use wxPG_KEEP_STRUCTURE to retain category structure; each sub category will be its own wxVariantList of wxVariant. Use wxPG_INC_ATTRIBUTES to include property attributes as well. Each attribute will be stored as list variant named "@@@@attr." */ wxVariant GetPropertyValues( const wxString& listname = wxEmptyString, wxPGProperty* baseparent = NULL, long flags = 0 ) const; /** Returns currently selected property. */ wxPGProperty* GetSelection() const; /** Similar to GetIterator(), but instead returns wxPGVIterator instance, which can be useful for forward-iterating through arbitrary property containers. @param flags See @ref propgrid_iterator_flags. wxPython Note: Instead of ++ operator, use Next() method, and instead of * operator, use GetProperty() method. */ virtual wxPGVIterator GetVIterator( int flags ) const; /** Hides or reveals a property. @param id @todo docme @param hide If @true, hides property, otherwise reveals it. @param flags By default changes are applied recursively. Set this parameter wxPG_DONT_RECURSE to prevent this. */ bool HideProperty( wxPGPropArg id, bool hide = true, int flags = wxPG_RECURSE ); /** Initializes *all* property types. Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library. */ static void InitAllTypeHandlers(); /** Inserts property to the property container. @param priorThis New property is inserted just prior to this. Available only in the first variant. There are two versions of this function to allow this parameter to be either an id or name to a property. @param newProperty Pointer to the inserted property. wxPropertyGrid will take ownership of this object. @return Returns newProperty. @remarks - wxPropertyGrid takes the ownership of the property pointer. - While Append may be faster way to add items, make note that when both types of data storage (categoric and non-categoric) are active, Insert becomes even more slow. This is especially true if current mode is non-categoric. - This functions deselects selected property, if any. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value. Example of use: @code // append category wxPGProperty* my_cat_id = propertygrid->Append( new wxPropertyCategory("My Category") ); ... // insert into category - using second variant wxPGProperty* my_item_id_1 = propertygrid->Insert( my_cat_id, 0, new wxStringProperty("My String 1") ); // insert before to first item - using first variant wxPGProperty* my_item_id_2 = propertygrid->Insert( my_item_id, new wxStringProperty("My String 2") ); @endcode */ wxPGProperty* Insert( wxPGPropArg priorThis, wxPGProperty* newProperty ); /** Inserts property to the property container. See the other overload for more details. @param parent New property is inserted under this category. Available only in the second variant. There are two versions of this function to allow this parameter to be either an id or name to a property. @param index Index under category. Available only in the second variant. If index is < 0, property is appended in category. @param newProperty Pointer to the inserted property. wxPropertyGrid will take ownership of this object. @return Returns newProperty. */ wxPGProperty* Insert( wxPGPropArg parent, int index, wxPGProperty* newProperty ); /** Returns @true if property is a category. */ bool IsPropertyCategory( wxPGPropArg id ) const; /** Returns @true if property is enabled. */ bool IsPropertyEnabled( wxPGPropArg id ) const; /** Returns @true if given property is expanded. Naturally, always returns @false for properties that cannot be expanded. */ bool IsPropertyExpanded( wxPGPropArg id ) const; /** Returns @true if property has been modified after value set or modify flag clear by software. */ bool IsPropertyModified( wxPGPropArg id ) const; /** Returns @true if property is shown (ie. HideProperty() with @true not called for it). */ bool IsPropertyShown( wxPGPropArg id ) const; /** Returns @true if property value is set to unspecified. */ bool IsPropertyValueUnspecified( wxPGPropArg id ) const; /** Disables (limit = @true) or enables (limit = @false) wxTextCtrl editor of a property, if it is not the sole mean to edit the value. */ void LimitPropertyEditing( wxPGPropArg id, bool limit = true ); /** Initializes additional property editors (SpinCtrl etc.). Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library. */ static void RegisterAdditionalEditors(); /** Replaces property with id with newly created one. For example, this code replaces existing property named "Flags" with one that will have different set of items: @code pg->ReplaceProperty("Flags", wxFlagsProperty("Flags", wxPG_LABEL, newItems)) @endcode @see Insert() */ wxPGProperty* ReplaceProperty( wxPGPropArg id, wxPGProperty* property ); /** @anchor propgridinterface_editablestate_flags Flags for wxPropertyGridInterface::SaveEditableState() and wxPropertyGridInterface::RestoreEditableState(). */ enum EditableStateFlags { /** Include selected property. */ SelectionState = 0x01, /** Include expanded/collapsed property information. */ ExpandedState = 0x02, /** Include scrolled position. */ ScrollPosState = 0x04, /** Include selected page information. Only applies to wxPropertyGridManager. */ 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. This is usually the default value. */ AllStates = SelectionState | ExpandedState | ScrollPosState | PageState | SplitterPosState | DescBoxState }; /** Restores user-editable state. See also wxPropertyGridInterface::SaveEditableState(). @param src String generated by SaveEditableState. @param restoreStates Which parts to restore from source string. See @ref propgridinterface_editablestate_flags "list of editable state flags". @return Returns @false if there was problem reading the string. @remarks If some parts of state (such as scrolled or splitter position) fail to restore correctly, please make sure that you call this function after wxPropertyGrid size has been set (this may sometimes be tricky when sizers are used). */ bool RestoreEditableState( const wxString& src, int restoreStates = AllStates ); /** Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions). @param includedStates Which parts of state to include. See @ref propgridinterface_editablestate_flags "list of editable state flags". */ wxString SaveEditableState( int includedStates = AllStates ) const; /** Sets strings listed in the choice dropdown of a wxBoolProperty. Defaults are "True" and "False", so changing them to, say, "Yes" and "No" may be useful in some less technical applications. */ static void SetBoolChoices( const wxString& trueChoice, const wxString& falseChoice ); /** Sets an attribute for this property. @param id @todo docme @param attrName Text identifier of attribute. See @ref propgrid_property_attributes. @param value Value of attribute. @param argFlags Optional. Use wxPG_RECURSE to set the attribute to child properties recursively. @remarks Setting attribute's value to Null variant will simply remove it from property's set of attributes. */ void SetPropertyAttribute( wxPGPropArg id, const wxString& attrName, wxVariant value, long argFlags = 0 ); /** 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 SetPropertyBackgroundColour( wxPGPropArg id, const wxColour& colour, bool recursively = true ); /** Sets text, bitmap, and colours for given column's cell. @remarks - You can set label cell by using column 0. - You can use wxPG_LABEL as text to use default text for column. */ void SetPropertyCell( wxPGPropArg id, int column, const wxString& text = wxEmptyString, const wxBitmap& bitmap = wxNullBitmap, const wxColour& fgCol = wxNullColour, const wxColour& bgCol = wxNullColour ); /** Sets client data (void*) of a property. @remarks This untyped client data has to be deleted manually. */ void SetPropertyClientData( wxPGPropArg id, void* clientData ); /** Resets text and background colours of given property. */ void SetPropertyColoursToDefault( wxPGPropArg id ); /** Sets editor for a property. @param id @todo docme @param editor For builtin editors, use wxPGEditor_X, where X is builtin editor's name (TextCtrl, Choice, etc. see wxPGEditor documentation for full list). For custom editors, use pointer you received from wxPropertyGrid::RegisterEditorClass(). */ void SetPropertyEditor( wxPGPropArg id, const wxPGEditor* editor ); /** Sets editor control of a property. As editor argument, use editor name string, such as "TextCtrl" or "Choice". */ void SetPropertyEditor( wxPGPropArg id, const wxString& editorName ); /** Sets label of a property. @remarks - Properties under same parent may have same labels. However, property names must still remain unique. */ void SetPropertyLabel( wxPGPropArg id, const wxString& newproplabel ); /** Sets name of a property. @param id Name or pointer of property which name to change. @param newName New name for property. */ void SetPropertyName( wxPGPropArg id, const wxString& newName ); /** Sets property (and, recursively, its children) to have read-only value. In other words, user cannot change the value in the editor, but they can still copy it. @remarks This is mainly for use with textctrl editor. Only some other editors fully support it. @param id Property name or pointer. @param set Use @true to enable read-only, @false to disable it. @param flags By default changes are applied recursively. Set this parameter wxPG_DONT_RECURSE to prevent this. */ void SetPropertyReadOnly( wxPGPropArg id, bool set = true, int flags = wxPG_RECURSE ); /** Sets property's value to unspecified. If it has children (it may be category), then the same thing is done to them. */ void SetPropertyValueUnspecified( wxPGPropArg id ); /** Sets various property values from a list of wxVariants. If property with name is missing from the grid, new property is created under given default category (or root if omitted). */ void SetPropertyValues( const wxVariantList& list, wxPGPropArg defaultCategory = wxNullProperty ); void SetPropertyValues( const wxVariant& list, wxPGPropArg defaultCategory = wxNullProperty ); /** Associates the help string with property. @remarks By default, text is shown either in the manager's "description" text box or in the status bar. If extra window style wxPG_EX_HELP_AS_TOOLTIPS is used, then the text will appear as a tooltip. */ void SetPropertyHelpString( wxPGPropArg id, const wxString& helpString ); /** Set wxBitmap in front of the value. @remarks Bitmap will be scaled to a size returned by wxPropertyGrid::GetImageSize(); */ void SetPropertyImage( wxPGPropArg id, wxBitmap& bmp ); /** Sets max length of property's text. */ bool SetPropertyMaxLength( wxPGPropArg id, int maxLen ); /** 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& colour, bool recursively = true ); /** Sets validator of a property. */ void SetPropertyValidator( wxPGPropArg id, const wxValidator& validator ); /** Sets value (integer) of a property. */ void SetPropertyValue( wxPGPropArg id, long value ); /** Sets value (integer) of a property. */ void SetPropertyValue( wxPGPropArg id, int value ); /** Sets value (floating point) of a property. */ void SetPropertyValue( wxPGPropArg id, double value ); /** Sets value (bool) of a property. */ void SetPropertyValue( wxPGPropArg id, bool value ); /** Sets value (string) of a property. */ void SetPropertyValue( wxPGPropArg id, const wxString& value ); /** Sets value (wxArrayString) of a property. */ void SetPropertyValue( wxPGPropArg id, const wxArrayString& value ); /** Sets value (wxDateTime) of a property. */ void SetPropertyValue( wxPGPropArg id, const wxDateTime& value ); /** Sets value (wxObject*) of a property. */ void SetPropertyValue( wxPGPropArg id, wxObject* value ); /** Sets value (wxObject&) of a property. */ void SetPropertyValue( wxPGPropArg id, wxObject& value ); /** Sets value (native 64-bit int) of a property. */ void SetPropertyValue( wxPGPropArg id, wxLongLong_t value ); /** Sets value (native 64-bit unsigned int) of a property. */ void SetPropertyValue( wxPGPropArg id, wxULongLong_t value ); /** Sets value (wxArrayInt&) of a property. */ void SetPropertyValue( wxPGPropArg id, const wxArrayInt& value ); /** Sets value (wxString) of a property. @remarks This method uses wxPGProperty::SetValueFromString(), which all properties should implement. This means that there should not be a type error, and instead the string is converted to property's actual value type. */ void SetPropertyValueString( wxPGPropArg id, const wxString& value ); /** Sets value (wxVariant&) of a property. @remarks Use wxPropertyGrid::ChangePropertyValue() instead if you need to run through validation process and send property change event. */ void SetPropertyValue( wxPGPropArg id, wxVariant value ); /** Adjusts how wxPropertyGrid behaves when invalid value is entered in a property. @param vfbFlags See @ref propgrid_vfbflags for possible values. */ void SetValidationFailureBehavior( int vfbFlags ); /** Returns editor pointer of editor with given name; */ static wxPGEditor* GetEditorByName( const wxString& editorName ); };