Navigation

Phoenix Logo

phoenix_title wx.propgrid.FlagsProperty

Represents a bit set that fits in a long integer.

wx.propgrid.BoolProperty sub-properties are created for editing individual bits. Textctrl is created to manually edit the flags as a text; a continuous sequence of spaces, commas and semicolons is considered as a flag id separator. Note: When changing “choices” (ie. flag labels) of wx.propgrid.FlagsProperty, you will need to use SetPropertyChoices - otherwise they will not get updated properly.


class_hierarchy Class Hierarchy

Inheritance diagram for class FlagsProperty:


method_summary Methods Summary

__init__  
ChildChanged Called after value of a child property has been altered.
DoSetAttribute Reimplement this member function to add special handling for attributes of this property.
GetChoiceSelection Returns which choice is currently selected.
GetItemCount  
GetLabel  
OnSetValue This virtual function is called after m_value has been set.
RefreshChildren Refresh values of child properties.
StringToValue Converts text into Variant value appropriate for this property.
ValueToString Converts property value into a text representation.

api Class API


class wx.propgrid.FlagsProperty(PGProperty)

Possible constructors:

FlagsProperty(label, name, choices, value=0)

FlagsProperty(label=PG_LABEL, name=PG_LABEL, labels=[], values=[],
              value=0)

Represents a bit set that fits in a long integer.


Methods


__init__(self, *args, **kw)

overload Overloaded Implementations:


__init__ (self, label, name, choices, value=0)

Parameters:


__init__ (self, label=PG_LABEL, name=PG_LABEL, labels=[], values=[], value=0)

Parameters:
  • label (string) –
  • name (string) –
  • labels (list of strings) –
  • values (list of integers) –
  • value (int) –



ChildChanged(self, thisValue, childIndex, childValue)

Called after value of a child property has been altered.

Must return new value of the whole property (after any alterations warranted by child’s new value).

Note that this function is usually called at the time that value of this property, or given child property, is still pending for change, and as such, result of GetValue or m_value should not be relied on.

Sample pseudo-code implementation:

# TBW
Parameters:
  • thisValue (PGVariant) – Value of this property. Changed value should be returned (in previous versions of wx.propgrid.PropertyGrid it was only necessary to write value back to this argument).
  • childIndex (int) – Index of child changed (you can use Item(childIndex) to get child property).
  • childValue (PGVariant) – (Pending) value of the child property.
Return type:

PGVariant
Returns:

Modified value of the whole property.

DoSetAttribute(self, name, value)

Reimplement this member function to add special handling for attributes of this property.

Parameters:
  • name (string) –
  • value (PGVariant) –
Return type:

bool
Returns:

Return False to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.

Note

To actually set property attribute values from the application, use wx.propgrid.PGProperty.SetAttribute instead.


GetChoiceSelection(self)

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.

Return type:int

GetItemCount(self)
Return type:int

GetLabel(self, ind)
Parameters:ind (int) –
Return type:string

OnSetValue(self)

This virtual function is called after m_value has been set.

Note

  • If m_value was set to Null variant (ie. unspecified value), OnSetValue will not be called.
  • m_value may be of any variant type. Typically properties internally support only one variant type, and as such OnSetValue provides a good opportunity to convert supported values into internal type.
  • Default implementation does nothing.

RefreshChildren(self)

Refresh values of child properties.

Automatically called after value is set.


StringToValue(self, variant, text, argFlags)

Converts text into Variant value appropriate for this property.

Parameters:
  • variant (PGVariant) – On function entry this is the old value (should not be NullVariant in normal cases). Translated value must be assigned back to it.
  • text (string) – Text to be translated into variant.
  • argFlags (int) – If wx.propgrid.PG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If wx.propgrid.PG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite property string value (as generated by ValueToString called with this same flag).
Return type:

bool

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 behaviour).

Returns:Returns True if resulting Variant value was different.

Note

Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.


ValueToString(self, value, argFlags=0)

Converts property value into a text representation.

Parameters:
  • value (PGVariant) – Value to be converted.
  • argFlags (int) – If 0 (default value), then displayed string is returned. If wx.propgrid.PG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If wx.propgrid.PG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If wx.propgrid.PG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display as a part of string property’s composite text representation.
Return type:

string

Note

Default implementation calls GenerateComposedValue .


Properties


ChoiceSelection

See GetChoiceSelection


ItemCount

See GetItemCount