// Name: property.h
// Purpose: interface of wxPGProperty
// Author: wxWidgets team
-// RCS-ID: $Id:
+// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
#define wxNullProperty ((wxPGProperty*)NULL)
-/** wxPGPaintData
+/**
+ @section propgrid_property_attributes wxPropertyGrid Property Attribute Identifiers
- Contains information relayed to property's OnCustomPaint.
-*/
-struct wxPGPaintData
-{
- /** wxPropertyGrid. */
- const wxPropertyGrid* m_parent;
-
- /** Normally -1, otherwise index to drop-down list item that has to be drawn. */
- int m_choiceItem;
-
- /** Set to drawn width in OnCustomPaint (optional). */
- int m_drawnWidth;
-
- /** In a measure item call, set this to the height of item at m_choiceItem index. */
- int m_drawnHeight;
-};
-
-
-// Structure for relaying choice/list info.
-struct wxPGChoiceInfo
-{
- wxPGChoices* m_choices;
-};
+ wxPGProperty::SetAttribute() and wxPropertyGridInterface::SetPropertyAttribute()
+ accept one of these as attribute name argument.
-
-/** @section propgrid_property_attributes wxPropertyGrid Property Attribute Identifiers
-
- wxPGProperty::SetAttribute() and wxPropertyGridInterfaces::SetPropertyAttribute()
- accept one of these as attribute name argument .
-
- You can use strings instead of constants. However, some of these
- constants are redefined to use cached strings which may reduce
- your binary size by some amount.
+ You can use strings instead of constants.
+ However, some of these constants are redefined to use cached strings which
+ may reduce your binary size by some amount.
@{
*/
*/
#define wxPG_ATTR_SPINCTRL_STEP wxS("Step")
-/** SpinCtrl editor, bool. If true, value wraps at Min/Max.
+/** SpinCtrl editor, bool. If @true, value wraps at Min/Max.
*/
#define wxPG_ATTR_SPINCTRL_WRAP wxS("Wrap")
+/** SpinCtrl editor, bool. If @true, value can also by changed by moving
+ mouse when left mouse button is being pressed.
+*/
+#define wxPG_ATTR_SPINCTRL_MOTIONSPIN wxS("MotionSpin")
+
/** wxMultiChoiceProperty, int. If 0, no user strings allowed. If 1, user strings
appear before list strings. If 2, user strings appear after list string.
*/
*/
#define wxPG_COLOUR_ALLOW_CUSTOM wxS("AllowCustom")
-/** First attribute id that is guaranteed not to be used built-in
- properties.
-*/
-//#define wxPG_USER_ATTRIBUTE 192
-
/** @}
*/
-// -----------------------------------------------------------------------
-/** @class wxPGProperty
+
+/**
+ @class wxPGProperty
wxPGProperty is base class for all wxPropertyGrid properties. In
sections below we cover few related topics.
Simple string property. wxPG_STRING_PASSWORD attribute may be used
to echo value as asterisks and use wxTE_PASSWORD for wxTextCtrl.
- @remarks
- * wxStringProperty has a special trait: if it has value of "<composed>",
- and also has child properties, then its displayed value becomes
- composition of child property values, similar as with wxFontProperty,
- for instance.
+ @remarks wxStringProperty has a special trait: if it has value of
+ "<composed>", and also has child properties, then its displayed
+ value becomes composition of child property values, similar as
+ with wxFontProperty, for instance.
@subsection wxIntProperty
Like wxStringProperty, but converts text to a signed long integer.
wxIntProperty seamlessly supports 64-bit integers (ie. wxLongLong).
+ To safely convert variant to integer, use code like this:
+
+ @code
+ wxLongLong ll;
+ ll << property->GetValue();
+
+ // or
+ wxLongLong ll = propertyGrid->GetPropertyValueAsLong(property);
+ @endcode
@subsection wxUIntProperty
To set the globally used base, manipulate wxPG_UINT_BASE int
attribute. Regardless of current prefix, understands (hex) values starting
with both "0x" and "$".
- wxUIntProperty seamlessly supports 64-bit unsigned integers (ie. wxULongLong).
+ Like wxIntProperty, wxUIntProperty seamlessly supports 64-bit unsigned
+ integers (ie. wxULongLong). Same wxVariant safety rules apply.
@subsection wxFloatProperty
dialog. Note that in long string values, tabs are represented by "\t" and
line break by "\n".
+ To display custom dialog on button press, you can subclass
+ wxLongStringProperty and implement OnButtonClick, like this:
+
+ @code
+ virtual bool OnButtonClick( wxPropertyGrid* propGrid, wxString& value )
+ {
+ wxSize dialogSize(...size of your dialog...);
+
+ wxPoint dlgPos = propGrid->GetGoodEditorDialogPosition(this,
+ dialogSize)
+
+ // Create dialog dlg at dlgPos. Use value as initial string
+ // value.
+ ...
+
+ if ( dlg.ShowModal() == wxID_OK )
+ {
+ value = dlg.GetStringValue);
+ return true;
+ }
+ return false;
+ }
+ @endcode
+
+ Also, if you wish not to have line breaks and tabs translated to
+ escape sequences, then do following in constructor of your subclass:
+
+ @code
+ m_flags |= wxPG_PROP_NO_ESCAPE;
+ @endcode
+
@subsection wxDirProperty
Like wxLongStringProperty, but the button triggers dir selector instead.
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 inorder to show
only the filename, not the entire path.
@subsection wxEnumProperty
the flags as a text; a continous sequence of spaces, commas and semicolons
is considered as a flag id separator.
<b>Note: </b> When changing "choices" (ie. flag labels) of wxFlagsProperty, you
- will need to use SetPropertyChoices - otherwise they will not get updated properly.
+ will need to use wxPGProperty::SetChoices() - otherwise they will not get updated
+ properly.
@subsection wxArrayStringProperty
<b>Useful alternate editor:</b> Choice.
Represents wxColour. wxButton is used to trigger a colour picker dialog.
+ There are various sub-classing opportunities with this class. See
+ below in wxSystemColourProperty section for details.
@subsection wxFontProperty
Represents wxColour and a system colour index. wxChoice is used to edit
the value. Drop-down list has color images. Note that value type
- is wxColourPropertyValue instead of wxColour.
+ is wxColourPropertyValue instead of wxColour (which wxColourProperty
+ uses).
+
@code
class wxColourPropertyValue : public wxObject
{
};
@endcode
+ in wxSystemColourProperty, and its derived class wxColourProperty, there
+ are various sub-classing features. To set basic list list of colour
+ names, call wxPGProperty::SetChoices().
+
+ @code
+ // Override in derived class to customize how colours are translated
+ // to strings.
+ virtual wxString ColourToString( const wxColour& col, int index ) const;
+
+ // Returns index of entry that triggers colour picker dialog
+ // (default is last).
+ virtual int GetCustomColourIndex() const;
+
+ // Helper function to show the colour dialog
+ bool QueryColourFromUser( wxVariant& variant ) const;
+
+ // Returns colour for given choice.
+ // Default function returns wxSystemSettings::GetColour(index).
+ virtual wxColour GetColour( int index ) const;
+ @endcode
+
@subsection wxCursorProperty
Represents a wxCursor. wxChoice is used to edit the value.
return wxPGEditor_TextCtrl;
}
- virtual wxString GetValueAsString( int argFlags ) const
+ virtual wxString ValueToString( wxVariant& value,
+ int argFlags ) const
{
- // TODO: Return property value in string format
+ // TODO: Convert given property value to a string
}
virtual bool StringToValue( wxVariant& variant, const wxString& text, int argFlags )
they are only really needed if you need to use wxRTTI with your
property class.
- You can change the 'value type' of a property by simply assigning different type
- of variant with SetValue. <b>It is mandatory to implement wxVariantData class
- for all data types used as property values.</b> Also, it is further recommended
- to derive your class from wxPGVariantData, like this:
+ You can change the 'value type' of a property by simply assigning different
+ type of variant with SetValue. <b>It is mandatory to implement
+ wxVariantData class for all data types used as property values.</b>
+ You can use macros declared in wxPropertyGrid headers. For instance:
@code
// In header file:
- // (replace DECL with required data declaration, wxEMPTY_PARAMETER_VALUE if none)
- WX_PG_DECLARE_VARIANT_DATA(wxPGVariantMyDataClass, MyDataClass, DECL)
+ // (If you need to have export declaration, use version of macros
+ // with _EXPORTED postfix)
+ WX_PG_DECLARE_VARIANT_DATA(MyDataClass)
// In sources file:
- WX_PG_IMPLEMENT_VARIANT_DATA(wxPGVariantMyDataClass, MyDataClass)
+ WX_PG_IMPLEMENT_VARIANT_DATA(MyDataClass)
+
+ // Or, if you don't have valid == operator:
+ WX_PG_IMPLEMENT_VARIANT_DATA_DUMMY_EQ(MyDataClass)
@endcode
@library{wxpropgrid}
public:
typedef wxUint32 FlagType;
- /** Basic constructor.
+ /**
+ Default constructor.
*/
wxPGProperty();
- /** Constructor.
+ /**
+ Constructor.
Non-abstract property classes should have constructor of this style:
@code
- // If T is a class, then it should be a constant reference
- // (e.g. const T& ) instead.
- MyProperty( const wxString& label, const wxString& name, T value )
+ MyProperty( const wxString& label, const wxString& name, const T& value )
: wxPGProperty()
{
// Generally recommended way to set the initial value
*/
wxPGProperty( const wxString& label, const wxString& name );
- /** Virtual destructor. It is customary for derived properties to implement this. */
+ /**
+ Virtual destructor. It is customary for derived properties to implement this.
+ */
virtual ~wxPGProperty();
- /** This virtual function is called after m_value has been set.
+ /**
+ This virtual function is called after m_value has been set.
@remarks
- If m_value was set to Null variant (ie. unspecified value), OnSetValue()
*/
virtual void OnSetValue();
- /** Override this to return something else than m_value as the value.
+ /**
+ Override this to return something else than m_value as the value.
*/
- virtual wxVariant DoGetValue() const { return m_value; }
+ virtual wxVariant DoGetValue() const;
- /** Implement this function in derived class to check the value.
- Return true if it is ok. Returning false prevents property change events
+ /**
+ Implement this function in derived class to check the value.
+ Return @true if it is ok. Returning @false prevents property change events
from occurring.
@remarks
- - Default implementation always returns true.
+ - Default implementation always returns @true.
*/
virtual bool ValidateValue( wxVariant& value, wxPGValidationInfo& validationInfo ) const;
- /** Converts 'text' into proper value 'variant'. Returns true if new (different than
- m_value) value could be interpreted from the text.
+ /**
+ Converts text into wxVariant value appropriate for this property.
+
+ @param variant
+ On function entry this is the old value (should not be wxNullVariant
+ in normal cases). Translated value must be assigned back to it.
+
+ @param text
+ Text to be translated into variant.
+
@param argFlags
- If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable
- one (they may be different).
- If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite
- property string value (as generated by GetValueAsString() called with this same
- flag).
+ If wxPG_FULL_VALUE is set, returns complete, storable value instead
+ of displayable one (they may be different).
+ If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of
+ composite property string value (as generated by ValueToString()
+ called with this same flag).
- @remarks
- Default implementation converts semicolon delimited tokens into child values. Only
- works for properties with children.
+ @return Returns @true if resulting wxVariant value was different.
+
+ @remarks Default implementation converts semicolon delimited tokens into
+ child values. Only works for properties with children.
+
+ 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).
*/
virtual bool StringToValue( wxVariant& variant, const wxString& text, int argFlags = 0 ) const;
- /** Converts 'number' (including choice selection) into proper value 'variant'.
- Returns true if new (different than m_value) value could be interpreted from the integer.
+ /**
+ Converts integer (possibly a choice selection) into wxVariant value
+ appropriate for this property.
+
+ @param variant
+ On function entry this is the old value (should not be wxNullVariant
+ in normal cases). Translated value must be assigned back to it.
+ @param number
+ Integer to be translated into variant.
@param argFlags
- If wxPG_FULL_VALUE is set, returns complete, storable value instead of displayable one.
+ If wxPG_FULL_VALUE is set, returns complete, storable value instead
+ of displayable one.
+
+ @return Returns @true if resulting wxVariant value was different.
@remarks
- If property is not supposed to use choice or spinctrl or other editor
with int-based value, it is not necessary to implement this method.
- Default implementation simply assign given int to m_value.
- - If property uses choice control, and displays a dialog on some choice items,
- then it is preferred to display that dialog in IntToValue instead of OnEvent.
+ - If property uses choice control, and displays a dialog on some choice
+ items, then it is preferred to display that dialog in IntToValue
+ 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).
*/
- virtual bool IntToValue( wxVariant& value, int number, int argFlags = 0 ) const;
+ virtual bool IntToValue( wxVariant& variant, int number, int argFlags = 0 ) const;
-public:
-
- /** Returns text representation of property's value.
+ /**
+ Converts property value into a text representation.
+ @param value
+ Value to be converted.
@param argFlags
- If wxPG_FULL_VALUE is set, returns complete, storable string value instead of displayable.
- If wxPG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl.
- If wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display
- as a part of composite property string value.
+ If 0 (default value), then displayed string is returned.
+ If wxPG_FULL_VALUE is set, returns complete, storable string value
+ instead of displayable. If wxPG_EDITABLE_VALUE is set, returns
+ string value that must be editable in textctrl.
+ If wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to
+ display as a part of string property's composite text representation.
- @remarks
- Default implementation returns string composed from text representations of
- child properties.
+ @remarks Default implementation calls GenerateComposedValue().
*/
- virtual wxString GetValueAsString( int argFlags = 0 ) const;
+ virtual wxString ValueToString( wxVariant& value, int argFlags = 0 ) const;
- /** Converts string to a value, and if successful, calls SetValue() on it.
+ /**
+ Converts string to a value, and if successful, calls SetValue() on it.
Default behavior is to do nothing.
+
@param text
- String to get the value from.
- @retval
- true if value was changed.
+ String to get the value from.
+ @param flags
+ @todo docme
+
+ @return @true if value was changed.
*/
bool SetValueFromString( const wxString& text, int flags = 0 );
- /** Converts integer to a value, and if succesful, calls SetValue() on it.
+ /**
+ Converts integer to a value, and if succesful, calls SetValue() on it.
Default behavior is to do nothing.
+
@param value
- Int to get the value from.
+ Int to get the value from.
@param flags
- If has wxPG_FULL_VALUE, then the value given is a actual value and not an index.
- @retval
- True if value was changed.
+ If has wxPG_FULL_VALUE, then the value given is a actual value and not an index.
+
+ @return @true if value was changed.
*/
bool SetValueFromInt( long value, int flags = 0 );
- /** Returns size of the custom painted image in front of property. This method
+ /**
+ Returns size of the custom painted image in front of property. This method
must be overridden to return non-default value if OnCustomPaint is to be
called.
+
@param item
- Normally -1, but can be an index to the property's list of items.
+ 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 image width or height is indicated with dimension -1.
*/
virtual wxSize OnMeasureImage( int item = -1 ) const;
- /** Events received by editor widgets are processed here. Note that editor class
+ /**
+ Events received by editor widgets are processed here. Note that editor class
usually processes most events. Some, such as button press events of
TextCtrlAndButton class, can be handled here. Also, if custom handling
for regular events is desired, then that can also be done (for example,
wxSystemColourProperty custom handles wxEVT_COMMAND_CHOICE_SELECTED
to display colour picker dialog when 'custom' selection is made).
- If the event causes value to be changed, SetValueInEvent()
- should be called to set the new value.
+ If the event causes value to be changed, SetValueInEvent() should be called
+ to set the new value.
+
+ The parameter @a event is the associated wxEvent.
- @param event
- Associated wxEvent.
@retval
- Should return true if any changes in value should be reported.
+ Should return @true if any changes in value should be reported.
+
@remarks
- If property uses choice control, and displays a dialog on some choice items,
then it is preferred to display that dialog in IntToValue instead of OnEvent.
*/
virtual bool OnEvent( wxPropertyGrid* propgrid, wxWindow* wnd_primary, wxEvent& event );
- /** Called after value of a child property has been altered. Note that this function is
+ /**
+ Called after value of a child property has been altered. Note that this function is
usually called at the time that value of this property, or given child property, is
still pending for change.
@endcode
@param thisValue
- Value of this property, that should be altered.
+ Value of this property, that should be altered.
@param childIndex
- Index of child changed (you can use Item(childIndex) to get).
+ Index of child changed (you can use Item(childIndex) to get).
@param childValue
- Value of the child property.
+ Value of the child property.
*/
virtual void ChildChanged( wxVariant& thisValue, int childIndex, wxVariant& childValue ) const;
- /** Returns pointer to an instance of used editor.
+ /**
+ Returns pointer to an instance of used editor.
*/
virtual const wxPGEditor* DoGetEditorClass() const;
- /** Returns pointer to the wxValidator that should be used
- with the editor of this property (NULL for no validator).
+ /**
+ Returns pointer to the wxValidator that should be used
+ with the editor of this property (@NULL for no validator).
Setting validator explicitly via SetPropertyValidator
will override this.
*/
virtual wxValidator* DoGetValidator () const;
- /** Returns current value's index to the choice control. May also return,
- through pointer arguments, strings that should be inserted to that control.
- Irrelevant to classes which do not employ wxPGEditor_Choice or similar.
- @remarks
- - If returns NULL in choiceinfo.m_choices, then this class must be
- derived from wxBaseEnumProperty.
- - Must be able to cope situation where property's set of choices is
- uninitialized.
- */
- virtual int GetChoiceInfo( wxPGChoiceInfo* choiceinfo );
-
- /** Override to paint an image in front of the property value text or drop-down
+ /**
+ Override to paint an image in front of the property value text or drop-down
list item (but only if wxPGProperty::OnMeasureImage is overridden as well).
If property's OnMeasureImage() returns size that has height != 0 but less than
Box reserved for custom graphics. Includes surrounding rectangle, if any.
If x is < 0, then this is a measure item call (see above).
@param paintdata
- wxPGPaintData structure with much useful data.
+ wxPGPaintData structure with much useful data about painted item.
+ @code
+ struct wxPGPaintData
+ {
+ // wxPropertyGrid.
+ const wxPropertyGrid* m_parent;
+
+ // Normally -1, otherwise index to drop-down list item that has to be drawn.
+ int m_choiceItem;
+
+ // Set to drawn width in OnCustomPaint (optional).
+ int m_drawnWidth;
+
+ // In a measure item call, set this to the height of item at m_choiceItem index
+ int m_drawnHeight;
+ };
+ @endcode
@remarks
- You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth
- Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for
drawing framing rectangle. It can be changed as well.
- @see GetValueAsString()
+ @see ValueToString()
*/
virtual void OnCustomPaint( wxDC& dc, const wxRect& rect, wxPGPaintData& paintdata );
- /** Returns used wxPGCellRenderer instance for given property column (label=0, value=1).
+ /**
+ Returns used wxPGCellRenderer instance for given property column (label=0, value=1).
Default implementation returns editor's renderer for all columns.
*/
virtual wxPGCellRenderer* GetCellRenderer( int column ) const;
- /** Refresh values of child properties. Automatically called after value is set.
+ /**
+ Returns which choice is currently selected. Only applies to properties
+ which have choices.
+
+ Needs to reimplemented in derived class if property value does not
+ map directly to a choice. Integer as index, bool, and string usually do.
+ */
+ virtual int GetChoiceSelection() const;
+
+ /**
+ Refresh values of child properties. Automatically called after value is set.
*/
virtual void RefreshChildren();
- /** Special handling for attributes of this property.
+ /**
+ Special handling for attributes of this property.
- If returns false, then the attribute will be automatically stored in
+ If returns @false, then the attribute will be automatically stored in
m_attributes.
- Default implementation simply returns false.
+ Default implementation simply returns @false.
*/
virtual bool DoSetAttribute( const wxString& name, wxVariant& value );
- /** Returns value of an attribute.
+ /**
+ Returns value of an attribute.
Override if custom handling of attributes is needed.
- Default implementation simply return NULL variant.
+ Default implementation simply return @NULL variant.
*/
virtual wxVariant DoGetAttribute( const wxString& name ) const;
- /** Returns instance of a new wxPGEditorDialogAdapter instance, which is
+ /**
+ Returns instance of a new wxPGEditorDialogAdapter instance, which is
used when user presses the (optional) button next to the editor control;
- Default implementation returns NULL (ie. no action is generated when
+ Default implementation returns @NULL (ie. no action is generated when
button is pressed).
*/
virtual wxPGEditorDialogAdapter* GetEditorDialog() const;
- /** Adds entry to property's wxPGChoices and editor control (if it is active).
- Returns index of item added.
+ /**
+ Append a new choice to property's list of choices.
+
+ @param label
+ Label for added choice.
+
+ @param value
+ Value for new choice. Do not specify if you wish this
+ to equal choice index.
+
+ @return
+ Index to added choice.
*/
- int AppendChoice( const wxString& label, int value = wxPG_INVALID_VALUE )
- {
- return InsertChoice(label,-1,value);
- }
+ int AddChoice( const wxString& label, int value = wxPG_INVALID_VALUE );
- /** Returns wxPGCell of given column, NULL if none. If valid
- object is returned, caller will gain its ownership.
+ /**
+ Adds a child property. If you use this instead of
+ wxPropertyGridInterface::Insert() or
+ wxPropertyGridInterface::AppendIn(), then you must set up
+ property's parental type before making the call. To do this,
+ call property's SetParentalType() function with either
+ wxPG_PROP_MISC_PARENT (normal, public children) or with
+ wxPG_PROP_AGGREGATE (private children for subclassed property).
+ For instance:
+
+ @code
+ wxPGProperty* prop = new wxStringProperty(wxS("Property"));
+ prop->SetParentalType(wxPG_PROP_MISC_PARENT);
+ wxPGProperty* prop2 = new wxStringProperty(wxS("Property2"));
+ prop->AddChild(prop2);
+ @endcode
+ */
+ void AddChild( wxPGProperty* property );
+
+ /**
+ Adapts list variant into proper value using consecutive
+ ChildChanged() calls.
*/
- wxPGCell* AcquireCell( unsigned int column )
- {
- if ( column >= m_cells.size() )
- return NULL;
+ void AdaptListToValue( wxVariant& list, wxVariant* value ) const;
- wxPGCell* cell = (wxPGCell*) m_cells[column];
- m_cells[column] = NULL;
- return cell;
- }
+ /**
+ Determines, recursively, if all children are not unspecified.
- /** Returns true if children of this property are component values (for instance,
- points size, face name, and is_underlined are component values of a font).
+ @param pendingList
+ Assumes members in this wxVariant list as pending
+ replacement values.
*/
- bool AreChildrenComponents() const
- {
- if ( m_flags & (wxPG_PROP_COMPOSED_VALUE|wxPG_PROP_AGGREGATE) )
- return true;
+ bool AreAllChildrenSpecified( wxVariant* pendingList = NULL ) const;
- return false;
- }
+ /**
+ Returns @true if children of this property are component values (for instance,
+ points size, face name, and is_underlined are component values of a font).
+ */
+ bool AreChildrenComponents() const;
- /** Removes entry from property's wxPGChoices and editor control (if it is active).
+ /**
+ Removes entry from property's wxPGChoices and editor control (if it is active).
If selected item is deleted, then the value is set to unspecified.
*/
void DeleteChoice( int index );
- /** Call to enable or disable usage of common value (integer value that can be selected for
- properties instead of their normal values) for this property.
+ /** Deletes all child properties. */
+ void Empty();
- Common values are disabled by the default for all properties.
+ /**
+ Composes text from values of child properties.
*/
- void EnableCommonValue( bool enable = true )
- {
- if ( enable ) SetFlag( wxPG_PROP_USES_COMMON_VALUE );
- else ClearFlag( wxPG_PROP_USES_COMMON_VALUE );
- }
+ wxString GenerateComposedValue() const;
- /** Composes text from values of child properties. */
- void GenerateComposedValue( wxString& text, int argFlags = 0 ) const;
+ /**
+ Returns property attribute value, null variant if not found.
+ */
+ wxVariant GetAttribute( const wxString& name ) const;
- /** Returns property's label. */
- const wxString& GetLabel() const { return m_label; }
+ /** Returns named attribute, as string, if found. Otherwise defVal is returned.
+ */
+ wxString GetAttribute( const wxString& name, const wxString& defVal ) const;
- /** Returns property's name with all (non-category, non-root) parents. */
- wxString GetName() const;
+ /** Returns named attribute, as long, if found. Otherwise defVal is returned.
+ */
+ long GetAttributeAsLong( const wxString& name, long defVal ) const;
- /** Returns property's base name (ie. parent's name is not added in any case) */
- const wxString& GetBaseName() const { return m_name; }
+ /** Returns named attribute, as double, if found. Otherwise defVal is returned.
+ */
+ double GetAttributeAsDouble( const wxString& name, double defVal ) const;
- wxPGChoices& GetChoices();
+ /**
+ Returns attributes as list wxVariant.
+ */
+ wxVariant GetAttributesAsList() const;
- const wxPGChoices& GetChoices() const;
+ /**
+ Returns editor used for given column. @NULL for no editor.
+ */
+ const wxPGEditor* GetColumnEditor( int column ) const;
- const wxPGChoiceEntry* GetCurrentChoice() const;
+ /** Returns property's base name (ie. parent's name is not added in any case) */
+ const wxString& GetBaseName() const;
- /** Returns coordinate to the top y of the property. Note that the
- position of scrollbars is not taken into account.
+ /**
+ Returns wxPGCell of given column.
*/
- int GetY() const;
-
- wxVariant GetValue() const
- {
- return DoGetValue();
- }
+ const wxPGCell& GetCell( unsigned int column ) const;
- /** Returns reference to the internal stored value. GetValue is preferred
- way to get the actual value, since GetValueRef ignores DoGetValue,
- which may override stored value.
+ /**
+ Returns number of child properties.
*/
- wxVariant& GetValueRef()
- {
- return m_value;
- }
+ unsigned int GetChildCount() const;
- const wxVariant& GetValueRef() const
- {
- return m_value;
- }
+ /**
+ Returns height of children, recursively, and
+ by taking expanded/collapsed status into account.
- /** Same as GetValueAsString, except takes common value into account.
- */
- wxString GetValueString( int argFlags = 0 ) const;
+ @param lh
+ Line height. Pass result of GetGrid()->GetRowHeight() here.
- void UpdateControl( wxWindow* primary );
+ @param iMax
+ Only used (internally) when finding property y-positions.
+ */
+ int GetChildrenHeight( int lh, int iMax = -1 ) const;
- /** Returns wxPGCell of given column, NULL if none. wxPGProperty
- will retain ownership of the cell object.
+ /**
+ Returns read-only reference to property's list of choices.
*/
- wxPGCell* GetCell( unsigned int column ) const
- {
- if ( column >= m_cells.size() )
- return NULL;
+ const wxPGChoices& GetChoices() const;
- return (wxPGCell*) m_cells[column];
- }
+ /**
+ Returns client data (void*) of a property.
+ */
+ void* GetClientData() const;
- unsigned int GetChoiceCount() const;
+ /** Sets managed client object of a property.
+ */
+ wxClientData *GetClientObject() const;
- wxString GetChoiceString( unsigned int index );
+ /**
+ Returns property's default value. If property's value type is not
+ a built-in one, and "DefaultValue" attribute is not defined, then
+ this function usually returns Null variant.
+ */
+ wxVariant GetDefaultValue() const;
- /** Return number of displayed common values for this property.
+ /** Returns property's displayed text.
*/
- int GetDisplayedCommonValueCount() const;
+ wxString GetDisplayedString() const;
- wxString GetDisplayedString() const
- {
- return GetValueString(0);
- }
+ /**
+ Returns wxPGEditor that will be used and created when
+ property becomes selected. Returns more accurate value
+ than DoGetEditorClass().
+ */
+ const wxPGEditor* GetEditorClass() const;
/** Returns property grid where property lies. */
wxPropertyGrid* GetGrid() const;
- /** Returns owner wxPropertyGrid, but only if one is currently on a page
- displaying this property. */
+ /**
+ Returns owner wxPropertyGrid, but only if one is currently on a page
+ displaying this property.
+ */
wxPropertyGrid* GetGridIfDisplayed() const;
- /** Returns highest level non-category, non-root parent. Useful when you
- have nested wxCustomProperties/wxParentProperties.
- @remarks
- Thus, if immediate parent is root or category, this will return the
- property itself.
+ /**
+ Returns property's help or description text.
+
+ @see SetHelpString()
*/
- wxPGProperty* GetMainParent() const;
+ const wxString& GetHelpString() const;
- /** Return parent of property */
- wxPGProperty* GetParent() const { return m_parent; }
+ /**
+ Returns position in parent's array.
+ */
+ unsigned int GetIndexInParent() const;
- /** Returns true if property has editable wxTextCtrl when selected.
+ /** Returns property's label. */
+ const wxString& GetLabel() const;
- @remarks
- Altough disabled properties do not displayed editor, they still
- return True here as being disabled is considered a temporary
- condition (unlike being read-only or having limited editing enabled).
+ /**
+ Returns last visible child property, recursively.
*/
- bool IsTextEditable() const;
-
- bool IsValueUnspecified() const
- {
- return m_value.IsNull();
- }
+ const wxPGProperty* GetLastVisibleSubItem() const;
- FlagType HasFlag( FlagType flag ) const
- {
- return ( m_flags & flag );
- }
+ /**
+ Returns highest level non-category, non-root parent. Useful when you
+ have nested properties with children.
- /** Returns comma-delimited string of property attributes.
+ @remarks If immediate parent is root or category, this will return the
+ property itself.
*/
- const wxPGAttributeStorage& GetAttributes() const
- {
- return m_attributes;
- }
+ wxPGProperty* GetMainParent() const;
- /** Returns m_attributes as list wxVariant.
+ /** Returns maximum allowed length of property's text value.
*/
- wxVariant GetAttributesAsList() const;
+ int GetMaxLength() const;
- FlagType GetFlags() const
- {
- return m_flags;
- }
-
- const wxPGEditor* GetEditorClass() const;
+ /** Returns property's name with all (non-category, non-root) parents. */
+ wxString GetName() const;
- wxString GetValueType() const
- {
- return m_value.GetType();
- }
+ /** Return parent of property */
+ wxPGProperty* GetParent() const;
- /** Returns editor used for given column. NULL for no editor.
+ /**
+ Returns (direct) child property with given name (or @NULL if not found).
*/
- const wxPGEditor* GetColumnEditor( int column ) const
- {
- if ( column == 1 )
- return GetEditorClass();
+ wxPGProperty* GetPropertyByName( const wxString& name ) const;
- return NULL;
- }
+ /** Gets assignable version of property's validator. */
+ wxValidator* GetValidator() const;
- /** Returns common value selected for this property. -1 for none.
+ /**
+ Returns property's value.
*/
- int GetCommonValue() const
- {
- return m_commonValue;
- }
+ wxVariant GetValue() const;
- /** Returns true if property has even one visible child.
+ /**
+ Returns bitmap that appears next to value text. Only returns non-@NULL
+ bitmap if one was set with SetValueImage().
*/
- bool HasVisibleChildren() const;
+ wxBitmap* GetValueImage() const;
- /** Adds entry to property's wxPGChoices and editor control (if it is active).
- Returns index of item added.
- */
- int InsertChoice( const wxString& label, int index, int value = wxPG_INVALID_VALUE );
+ /** Returns text representation of property's value.
- /** Returns true if this property is actually a wxPropertyCategory.
+ @param argFlags
+ If 0 (default value), then displayed string is returned.
+ If wxPG_FULL_VALUE is set, returns complete, storable string value
+ instead of displayable. If wxPG_EDITABLE_VALUE is set, returns
+ string value that must be editable in textctrl. If
+ wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to
+ display as a part of string property's composite text
+ representation.
+
+ @remarks In older versions, this function used to be overridden to convert
+ property's value into a string representation. This function is
+ now handled by ValueToString(), and overriding this function now
+ will result in run-time assertion failure.
*/
- bool IsCategory() const { return HasFlag(wxPG_PROP_CATEGORY)?true:false; }
+ virtual wxString GetValueAsString( int argFlags = 0 ) const;
- /** Returns true if this property is actually a wxRootProperty.
- */
- bool IsRoot() const { return (m_parent == NULL); }
+ /** Synonymous to GetValueAsString().
- /** Returns true if this is a sub-property. */
- bool IsSubProperty() const
- {
- wxPGProperty* parent = (wxPGProperty*)m_parent;
- if ( parent && !parent->IsCategory() )
- return true;
- return false;
- }
+ @deprecated Use GetValueAsString() instead.
- /** Returns last visible sub-property, recursively.
+ @see GetValueAsString()
*/
- const wxPGProperty* GetLastVisibleSubItem() const;
+ wxDEPRECATED( wxString GetValueString( int argFlags = 0 ) const );
- wxVariant GetDefaultValue() const;
+ /**
+ Returns value type used by this property.
+ */
+ wxString GetValueType() const;
- int GetMaxLength() const
- {
- return (int) m_maxLen;
- }
+ /**
+ Returns coordinate to the top y of the property. Note that the
+ position of scrollbars is not taken into account.
+ */
+ int GetY() const;
- /** Determines, recursively, if all children are not unspecified. Takes values in given list into account.
+ /**
+ Returns @true if property has even one visible child.
*/
- bool AreAllChildrenSpecified( wxVariant* pendingList = NULL ) const;
+ bool HasVisibleChildren() const;
- /** Updates composed values of parent non-category properties, recursively.
- Returns topmost property updated.
+ /**
+ Hides or reveals the property.
- @remarks
- - Must not call SetValue() (as can be called in it).
+ @param hide
+ @true for hide, @false for reveal.
+
+ @param flags
+ By default changes are applied recursively. Set this parameter wxPG_DONT_RECURSE to prevent this.
*/
- wxPGProperty* UpdateParentValues();
+ bool Hide( bool hide, int flags = wxPG_RECURSE );
- /** Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
+ /**
+ Returns index of given child property. wxNOT_FOUND if
+ given property is not child of this.
*/
- FlagType UsesAutoUnspecified() const
- {
- return HasFlag(wxPG_PROP_AUTO_UNSPECIFIED);
- }
+ int Index( const wxPGProperty* p ) const;
- wxBitmap* GetValueImage() const
- {
- return m_valueBitmap;
- }
+ /**
+ Inserts a new choice to property's list of choices.
- wxVariant GetAttribute( const wxString& name ) const;
+ @param label
+ Text for new choice
- /** Returns named attribute, as string, if found. Otherwise defVal is returned.
+ @param index
+ Insertion position. Use wxNOT_FOUND to append.
+
+ @param value
+ Value for new choice. Do not specify if you wish this
+ to equal choice index.
*/
- wxString GetAttribute( const wxString& name, const wxString& defVal ) const;
+ int InsertChoice( const wxString& label, int index, int value = wxPG_INVALID_VALUE );
- /** Returns named attribute, as long, if found. Otherwise defVal is returned.
+ /**
+ Returns @true if this property is actually a wxPropertyCategory.
*/
- long GetAttributeAsLong( const wxString& name, long defVal ) const;
+ bool IsCategory() const;
- /** Returns named attribute, as double, if found. Otherwise defVal is returned.
+ /**
+ Returns @true if property is enabled.
*/
- double GetAttributeAsDouble( const wxString& name, double defVal ) const;
+ bool IsEnabled() const;
- inline unsigned int GetArrIndex() const { return m_arrIndex; }
+ /**
+ Returns @true if property has visible children.
+ */
+ bool IsExpanded() const;
- inline unsigned int GetDepth() const { return (unsigned int)m_depth; }
+ /**
+ Returns @true if this property is actually a wxRootProperty.
+ */
+ bool IsRoot() const;
- /** Gets flags as a'|' delimited string. Note that flag names are not
- prepended with 'wxPG_PROP_'.
- @param flagsMask
- String will only be made to include flags combined by this parameter.
+ /**
+ Returns @true if candidateParent is some parent of this property.
*/
- wxString GetFlagsAsString( FlagType flagsMask ) const;
+ bool IsSomeParent( wxPGProperty* candidateParent ) const;
- /** Returns position in parent's array. */
- unsigned int GetIndexInParent() const
- {
- return (unsigned int)m_arrIndex;
- }
+ /**
+ Returns true if property has editable wxTextCtrl when selected.
- /** Hides or reveals the property.
- @param hide
- true for hide, false for reveal.
- @param flags
- By default changes are applied recursively. Set this paramter wxPG_DONT_RECURSE to prevent this.
+ @remarks Altough disabled properties do not displayed editor, they still
+ return @true here as being disabled is considered a temporary
+ condition (unlike being read-only or having limited editing enabled).
*/
- inline bool Hide( bool hide, int flags = wxPG_RECURSE );
+ bool IsTextEditable() const;
- bool IsExpanded() const { return (!(m_flags & wxPG_PROP_COLLAPSED) && GetChildCount()); }
+ /**
+ Returns @true if property's value is considered unspecified. This
+ usually means that value is Null variant.
+ */
+ bool IsValueUnspecified() const;
- /** Returns true if all parents expanded.
+ /**
+ Returns true if all parents expanded.
*/
bool IsVisible() const;
- bool IsEnabled() const
- {
- return ( m_flags & wxPG_PROP_DISABLED ) ? false : true;
- }
-
- /** If property's editor is created this forces its recreation. Useful
- in SetAttribute etc. Returns true if actually did anything.
+ /**
+ Returns child property at index i.
*/
- bool RecreateEditor();
+ wxPGProperty* Item( unsigned int i ) const;
- /** If property's editor is active, then update it's value.
+ /**
+ If property's editor is active, then update it's value.
*/
void RefreshEditor();
- /** Sets an attribute for this property.
- @param name
- Text identifier of attribute. See @ref propgrid_property_attributes.
- @param value
- Value of attribute.
- */
- void SetAttribute( const wxString& name, wxVariant value );
+ /**
+ Sets an attribute for this property.
- void SetAttributes( const wxPGAttributeStorage& attributes );
-
- /** Sets editor for a property.
+ @param name
+ Text identifier of attribute. See @ref propgrid_property_attributes.
- @param editor
- For builtin editors, use wxPGEditor_X, where X is builtin editor's
- name (TextCtrl, Choice, etc. see wxPGEditor documentation for full list).
+ @param value
+ Value of attribute.
- For custom editors, use pointer you received from wxPropertyGrid::RegisterEditorClass().
+ @remarks Setting attribute's value to Null variant will simply remove it
+ from property's set of attributes.
*/
- void SetEditor( const wxPGEditor* editor )
- {
- m_customEditor = editor;
- }
+ void SetAttribute( const wxString& name, wxVariant value );
- /** Sets editor for a property.
- */
- inline void SetEditor( const wxString& editorName );
+ /**
+ Sets property's background colour.
- /** Sets cell information for given column.
+ @param colour
+ Background colour to use.
- Note that the property takes ownership of given wxPGCell instance.
+ @param recursively
+ If @true, children are affected recursively, and any categories
+ are not.
*/
- void SetCell( int column, wxPGCell* cellObj );
+ void SetBackgroundColour( const wxColour& colour,
+ bool recursively = false );
- /** Changes value of a property with choices, but only
- works if the value type is long or string. */
- void SetChoiceSelection( int newValue, const wxPGChoiceInfo& choiceInfo );
+ /**
+ Sets editor for a property.
- /** Sets common value selected for this property. -1 for none.
- */
- void SetCommonValue( int commonValue )
- {
- m_commonValue = commonValue;
- }
+ @param editor
+ For builtin editors, use wxPGEditor_X, where X is builtin editor's
+ name (TextCtrl, Choice, etc. see wxPGEditor documentation for full list).
- /** Sets flags from a '|' delimited string. Note that flag names are not
- prepended with 'wxPG_PROP_'.
+ For custom editors, use pointer you received from wxPropertyGrid::RegisterEditorClass().
*/
- void SetFlagsFromString( const wxString& str );
+ void SetEditor( const wxPGEditor* editor );
- /** Sets property's "is it modified?" flag. Affects children recursively.
+ /**
+ Sets editor for a property, by editor name.
*/
- void SetModifiedStatus( bool modified )
- {
- SetFlagRecursively(wxPG_PROP_MODIFIED, modified);
- }
-
- /** Call in OnEvent(), OnButtonClick() etc. to change the property value
- based on user input.
+ void SetEditor( const wxString& editorName );
- @remarks
- This method is const since it doesn't actually modify value, but posts
- given variant as pending value, stored in wxPropertyGrid.
+ /**
+ Sets cell information for given column.
*/
- void SetValueInEvent( wxVariant value ) const;
+ void SetCell( int column, const wxPGCell& cell );
- /** Call this to set value of the property. Unlike methods in wxPropertyGrid,
- this does not automatically update the display.
-
- @remarks
- Use wxPropertyGrid::ChangePropertyValue() instead if you need to run through
- validation process and send property change event.
-
- If you need to change property value in event, based on user input, use
- SetValueInEvent() instead.
-
- @param pList
- Pointer to list variant that contains child values. Used to indicate
- which children should be marked as modified.
- @param flags
- Various flags (for instance, wxPG_SETVAL_REFRESH_EDITOR).
- */
- void SetValue( wxVariant value, wxVariant* pList = NULL, int flags = 0 );
+ /**
+ Sets new set of choices for property.
- /** Set wxBitmap in front of the value. This bitmap may be ignored
- by custom cell renderers.
+ @remarks This operation clears the property value.
*/
- void SetValueImage( wxBitmap& bmp );
+ bool SetChoices( wxPGChoices& choices );
- /** If property has choices and they are not yet exclusive, new such copy
+ /**
+ If property has choices and they are not yet exclusive, new such copy
of them will be created.
*/
void SetChoicesExclusive();
- void SetExpanded( bool expanded )
- {
- if ( !expanded ) m_flags |= wxPG_PROP_COLLAPSED;
- else m_flags &= ~wxPG_PROP_COLLAPSED;
- }
+ /**
+ Sets client data (void*) of a property.
- void SetFlag( FlagType flag ) { m_flags |= flag; }
-
- void SetFlagRecursively( FlagType flag, bool set );
+ @remarks This untyped client data has to be deleted manually.
+ */
+ void SetClientData( void* clientData );
- void SetHelpString( const wxString& helpString )
- {
- m_helpString = helpString;
- }
+ /** Returns client object of a property.
+ */
+ void SetClientObject(wxClientData* clientObject);
- void SetLabel( const wxString& label ) { m_label = label; }
+ /**
+ Sets selected choice and changes property value.
- inline void SetName( const wxString& newName );
+ Tries to retain value type, although currently if it is not string,
+ then it is forced to integer.
+ */
+ void SetChoiceSelection( int newValue );
- void SetValueToUnspecified()
- {
- wxVariant val; // Create NULL variant
- SetValue(val);
- }
+ /**
+ Sets property's help string, which is shown, for example, in
+ wxPropertyGridManager's description text box.
+ */
+ void SetHelpString( const wxString& helpString );
- /** Sets wxValidator for a property*/
- void SetValidator( const wxValidator& validator )
- {
- m_validator = wxDynamicCast(validator.Clone(),wxValidator);
- }
+ /**
+ Sets property's label.
- /** Gets assignable version of property's validator. */
- wxValidator* GetValidator() const
- {
- if ( m_validator )
- return m_validator;
- return DoGetValidator();
- }
-
- /** Updates property value in case there were last minute
- changes. If value was unspecified, it will be set to default.
- Use only for properties that have TextCtrl-based editor.
- @remarks
- If you have code similar to
- @code
- // Update the value in case of last minute changes
- if ( primary && propgrid->IsEditorsValueModified() )
- GetEditorClass()->CopyValueFromControl( this, primary );
- @endcode
- in wxPGProperty::OnEvent wxEVT_COMMAND_BUTTON_CLICKED handler,
- then replace it with call to this method.
- @retval
- True if value changed.
+ @remarks Properties under same parent may have same labels. However,
+ property names must still remain unique.
*/
- bool PrepareValueForDialogEditing( wxPropertyGrid* propgrid );
+ void SetLabel( const wxString& label );
- /** Returns client data (void*) of a property.
+ /**
+ Set max length of text in text editor.
*/
- void* GetClientData() const
- {
- return m_clientData;
- }
+ bool SetMaxLength( int maxLen );
- /** Sets client data (void*) of a property.
- @remarks
- This untyped client data has to be deleted manually.
+ /**
+ Sets property's "is it modified?" flag. Affects children recursively.
*/
- void SetClientData( void* clientData )
- {
- m_clientData = clientData;
- }
+ void SetModifiedStatus( bool modified );
- /** Returns client object of a property.
+ /**
+ Sets new (base) name for property.
*/
- void SetClientObject(wxClientData* clientObject)
- {
- delete m_clientObject;
- m_clientObject = clientObject;
- }
+ void SetName( const wxString& newName );
- /** Sets managed client object of a property.
- */
- wxClientData *GetClientObject() const { return m_clientObject; }
+ /**
+ Changes what sort of parent this property is for its children.
- /** Sets new set of choices for property.
+ @param flag
+ Use one of the following values: wxPG_PROP_MISC_PARENT (for generic
+ parents), wxPG_PROP_CATEGORY (for categories), or
+ wxPG_PROP_AGGREGATE (for derived property classes with private
+ children).
- @remarks
- This operation clears the property value.
+ @remarks You only need to call this if you use AddChild() to add
+ child properties. Adding properties with
+ wxPropertyGridInterface::Insert() or
+ wxPropertyGridInterface::AppendIn() will automatically set
+ property to use wxPG_PROP_MISC_PARENT style.
*/
- bool SetChoices( wxPGChoices& choices );
+ void SetParentalType( int flag );
- /** Sets new set of choices for property.
- */
- inline bool SetChoices( const wxArrayString& labels,
- const wxArrayInt& values = wxArrayInt() );
+ /**
+ Sets property's text colour.
- /** Set max length of text in text editor.
- */
- inline bool SetMaxLength( int maxLen );
+ @param colour
+ Text colour to use.
- /** Call with 'false' in OnSetValue to cancel value changes after all
- (ie. cancel 'true' returned by StringToValue() or IntToValue()).
+ @param recursively
+ If @true, children are affected recursively, and any categories
+ are not.
*/
- void SetWasModified( bool set = true )
- {
- if ( set ) m_flags |= wxPG_PROP_WAS_MODIFIED;
- else m_flags &= ~wxPG_PROP_WAS_MODIFIED;
- }
+ void SetTextColour( const wxColour& colour,
+ bool recursively = false );
- const wxString& GetHelpString() const
- {
- return m_helpString;
- }
+ /** Sets wxValidator for a property */
+ void SetValidator( const wxValidator& validator );
- void ClearFlag( FlagType flag ) { m_flags &= ~(flag); }
-
- // Use, for example, to detect if item is inside collapsed section.
- bool IsSomeParent( wxPGProperty* candidate_parent ) const;
+ /**
+ Call this to set value of the property. Unlike methods in wxPropertyGrid,
+ this does not automatically update the display.
- /** Adapts list variant into proper value using consequtive ChildChanged-calls.
- */
- void AdaptListToValue( wxVariant& list, wxVariant* value ) const;
+ @remarks
+ Use wxPropertyGrid::ChangePropertyValue() instead if you need to run through
+ validation process and send property change event.
- /** This is used by properties that have fixed sub-properties. */
- void AddChild( wxPGProperty* prop );
+ If you need to change property value in event, based on user input, use
+ SetValueInEvent() instead.
- /** Returns height of children, recursively, and
- by taking expanded/collapsed status into account.
-
- iMax is used when finding property y-positions.
+ @param value
+ The value to set.
+ @param pList
+ Pointer to list variant that contains child values. Used to indicate
+ which children should be marked as modified. Usually you just use @NULL.
+ @param flags
+ Use wxPG_SETVAL_REFRESH_EDITOR to update editor control, if it
+ was selected.
*/
- int GetChildrenHeight( int lh, int iMax = -1 ) const;
+ void SetValue( wxVariant value, wxVariant* pList = NULL, int flags = 0 );
- /** Returns number of child properties */
- unsigned int GetChildCount() const { return m_children.GetCount(); }
+ /**
+ Set wxBitmap in front of the value. This bitmap may be ignored
+ by custom cell renderers.
+ */
+ void SetValueImage( wxBitmap& bmp );
- /** Returns sub-property at index i. */
- wxPGProperty* Item( size_t i ) const { return (wxPGProperty*)m_children.Item(i); }
+ /**
+ Call this function in OnEvent(), OnButtonClick() etc. to change the
+ property value based on user input.
- /** Returns last sub-property.
+ @remarks This method is const since it doesn't actually modify value, but posts
+ given variant as pending value, stored in wxPropertyGrid.
*/
- wxPGProperty* Last() const { return (wxPGProperty*)m_children.Last(); }
-
- /** Returns index of given sub-property. */
- int Index( const wxPGProperty* p ) const { return m_children.Index((wxPGProperty*)p); }
+ void SetValueInEvent( wxVariant value ) const;
- /** Deletes all sub-properties. */
- void Empty();
+ /**
+ Sets property's value to unspecified (ie. Null variant).
+ */
+ void SetValueToUnspecified();
- // Puts correct indexes to children
- void FixIndexesOfChildren( size_t starthere = 0 );
+ /**
+ Call with @false in OnSetValue() to cancel value changes after all
+ (ie. cancel @true returned by StringToValue() or IntToValue()).
+ */
+ void SetWasModified( bool set = true );
- wxPGProperty* GetItemAtY( unsigned int y, unsigned int lh, unsigned int* nextItemY ) const;
+ /**
+ Updates composed values of parent non-category properties, recursively.
+ Returns topmost property updated.
+ */
+ wxPGProperty* UpdateParentValues();
- /** Returns (direct) child property with given name (or NULL if not found).
+ /**
+ Returns @true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
*/
- wxPGProperty* GetPropertyByName( const wxString& name ) const;
+ bool UsesAutoUnspecified() const;
};
-/** @class wxPGChoices
+/**
+ @class wxPGChoices
Helper class for managing choices of wxPropertyGrid properties.
Each entry can have label, value, bitmap, text colour, and background colour.
public:
typedef long ValArrItem;
- /** Default constructor. */
- wxPGChoices()
- {
- Init();
- }
+ /**
+ Default constructor.
+ */
+ wxPGChoices();
/** Copy constructor. */
- wxPGChoices( const wxPGChoices& a )
- {
- if ( a.m_data != wxPGChoicesEmptyData )
- {
- m_data = a.m_data;
- m_data->m_refCount++;
- }
- }
+ wxPGChoices( const wxPGChoices& a );
/** Constructor. */
- wxPGChoices( const wxChar** labels, const long* values = NULL )
- {
- Init();
- Set(labels,values);
- }
+ wxPGChoices( const wxChar** labels, const long* values = NULL );
/** Constructor. */
- wxPGChoices( const wxArrayString& labels, const wxArrayInt& values = wxArrayInt() )
- {
- Init();
- Set(labels,values);
- }
-
- /** Simple interface constructor. */
- wxPGChoices( wxPGChoicesData* data )
- {
- wxASSERT(data);
- m_data = data;
- data->m_refCount++;
- }
+ wxPGChoices( const wxArrayString& labels, const wxArrayInt& values = wxArrayInt() );
+
+ /** Constructor. */
+ wxPGChoices( wxPGChoicesData* data );
/** Destructor. */
- ~wxPGChoices()
- {
- Free();
- }
+ ~wxPGChoices();
- /** Adds to current. If did not have own copies, creates them now. If was empty,
+ /**
+ Adds to current. If did not have own copies, creates them now. If was empty,
identical to set except that creates copies.
*/
void Add( const wxChar** labels, const ValArrItem* values = NULL );
wxPGChoiceEntry& Add( const wxString& label, int value = wxPG_INVALID_VALUE );
/** Adds a single item, with bitmap. */
- wxPGChoiceEntry& Add( const wxString& label, const wxBitmap& bitmap, int value = wxPG_INVALID_VALUE );
+ wxPGChoiceEntry& Add( const wxString& label, const wxBitmap& bitmap,
+ int value = wxPG_INVALID_VALUE );
/** Adds a single item with full entry information. */
- wxPGChoiceEntry& Add( const wxPGChoiceEntry& entry )
- {
- return Insert(entry, -1);
- }
+ wxPGChoiceEntry& Add( const wxPGChoiceEntry& entry );
- /** Adds single item. */
+ /** Adds single item, sorted. */
wxPGChoiceEntry& AddAsSorted( const wxString& label, int value = wxPG_INVALID_VALUE );
- void Assign( const wxPGChoices& a )
- {
- AssignData(a.m_data);
- }
+ /**
+ Assigns data from another set of choices.
+ */
+ void Assign( const wxPGChoices& a );
+ /**
+ Assigns data from another set of choices.
+ */
void AssignData( wxPGChoicesData* data );
- /** Delete all choices. */
- void Clear()
- {
- if ( m_data != wxPGChoicesEmptyData )
- m_data->Clear();
- }
-
- void EnsureData()
- {
- if ( m_data == wxPGChoicesEmptyData )
- m_data = new wxPGChoicesData();
- }
-
- /** Gets a unsigned number identifying this list. */
- wxPGChoicesId GetId() const { return (wxPGChoicesId) m_data; };
-
- const wxString& GetLabel( size_t ind ) const
- {
- wxASSERT( ind >= 0 && ind < GetCount() );
- return Item(ind).GetText();
- }
-
- size_t GetCount () const
- {
- wxASSERT_MSG( m_data,
- wxT("When checking if wxPGChoices is valid, use IsOk() instead of GetCount()") );
- return m_data->GetCount();
- }
-
- int GetValue( size_t ind ) const { return Item(ind).GetValue(); }
-
- /** Returns array of values matching the given strings. Unmatching strings
+ /**
+ Deletes all items.
+ */
+ void Clear();
+
+ /**
+ Returns labe of item.
+ */
+ const wxString& GetLabel( unsigned int ind ) const;
+
+ /**
+ Returns number of items.
+ */
+ unsigned int GetCount() const;
+
+ /**
+ Returns value of item;
+ */
+ int GetValue( unsigned int ind ) const;
+
+ /**
+ Returns array of values matching the given strings. Unmatching strings
result in wxPG_INVALID_VALUE entry in array.
*/
wxArrayInt GetValuesForStrings( const wxArrayString& strings ) const;
- /** Returns array of indices matching given strings. Unmatching strings
- are added to 'unmatched', if not NULL.
+ /**
+ Returns array of indices matching given strings. Unmatching strings
+ are added to 'unmatched', if not @NULL.
*/
- wxArrayInt GetIndicesForStrings( const wxArrayString& strings, wxArrayString* unmatched = NULL ) const;
+ wxArrayInt GetIndicesForStrings( const wxArrayString& strings,
+ wxArrayString* unmatched = NULL ) const;
- /** Returns true if choices in general are likely to have values
- (depens on that all entries have values or none has)
+ /**
+ Returns @true if item at given index has a valid value;
*/
- bool HasValues() const;
+ bool HasValue( unsigned int i ) const;
- bool HasValue( unsigned int i ) const { return (m_data->GetCount() > i && m_data->Item(i)->HasValue()); }
+ /**
+ Returns index of item with given label.
+ */
+ int Index( const wxString& label ) const;
- int Index( const wxString& str ) const;
+ /**
+ Returns index of item with given value.
+ */
int Index( int val ) const;
- /** Inserts single item. */
+ /**
+ Inserts single item.
+ */
wxPGChoiceEntry& Insert( const wxString& label, int index, int value = wxPG_INVALID_VALUE );
- /** Inserts a single item with full entry information. */
+ /**
+ Inserts a single item with full entry information.
+ */
wxPGChoiceEntry& Insert( const wxPGChoiceEntry& entry, int index );
- /** Returns false if this is a constant empty set of choices,
+ /**
+ Returns @false if this is a constant empty set of choices,
which should not be modified.
*/
- bool IsOk() const
- {
- return ( m_data != wxPGChoicesEmptyData );
- }
+ bool IsOk() const;
- const wxPGChoiceEntry& Item( unsigned int i ) const
- {
- wxASSERT( IsOk() );
- return *m_data->Item(i);
- }
+ /**
+ Returns item at given index.
+ */
+ const wxPGChoiceEntry& Item( unsigned int i ) const;
- wxPGChoiceEntry& Item( unsigned int i )
- {
- wxASSERT( IsOk() );
- return *m_data->Item(i);
- }
+ /**
+ Returns item at given index.
+ */
+ wxPGChoiceEntry& Item( unsigned int i );
- /** Removes count items starting at position nIndex. */
+ /**
+ Removes count items starting at position nIndex.
+ */
void RemoveAt(size_t nIndex, size_t count = 1);
- /** Does not create copies for itself. */
- void Set( const wxChar** labels, const long* values = NULL )
- {
- Free();
- Add(labels,values);
- }
+ /**
+ Sets contents from lists of strings and values.
+ */
+ void Set( const wxChar** labels, const long* values = NULL );
- /** Version that works with wxArrayString.
- TODO: Deprecate this.
+ /**
+ Sets contents from lists of strings and values.
*/
- void Set( wxArrayString& arr, const long* values = (const long*) NULL )
- {
- Free();
- Add(arr,values);
- }
+ void Set( const wxArrayString& labels, const wxArrayInt& values = wxArrayInt() );
- /** Version that works with wxArrayString and wxArrayInt. */
- void Set( const wxArrayString& labels, const wxArrayInt& values = wxArrayInt() )
- {
- Free();
- if ( &values )
- Add(labels,values);
- else
- Add(labels);
- }
-
- // Creates exclusive copy of current choices
- void SetExclusive()
- {
- if ( m_data->m_refCount != 1 )
- {
- wxPGChoicesData* data = new wxPGChoicesData();
- data->CopyDataFrom(m_data);
- Free();
- m_data = data;
- }
- }
-
- // Returns data, increases refcount.
- wxPGChoicesData* GetData()
- {
- wxASSERT( m_data->m_refCount != 0xFFFFFFF );
- m_data->m_refCount++;
- return m_data;
- }
-
- // Returns plain data ptr - no refcounting stuff is done.
- wxPGChoicesData* GetDataPtr() const { return m_data; }
-
- // Changes ownership of data to you.
- wxPGChoicesData* ExtractData()
- {
- wxPGChoicesData* data = m_data;
- m_data = wxPGChoicesEmptyData;
- return data;
- }
+ /**
+ Creates exclusive copy of current choices.
+ */
+ void SetExclusive();
+ /**
+ Returns array of choice labels.
+ */
wxArrayString GetLabels() const;
- void operator= (const wxPGChoices& a)
- {
- AssignData(a.m_data);
- }
-
- wxPGChoiceEntry& operator[](unsigned int i)
- {
- return Item(i);
- }
+ void operator= (const wxPGChoices& a);
- const wxPGChoiceEntry& operator[](unsigned int i) const
- {
- return Item(i);
- }
+ wxPGChoiceEntry& operator[](unsigned int i);
+ const wxPGChoiceEntry& operator[](unsigned int i) const;
};
// -----------------------------------------------------------------------
projects / wxWidgets.git / blobdiff