wx.richtext.RichTextProperties

A simple property class using Variants.

This is used to give each rich text object the ability to store custom properties that can be used by the application.

See also

wx.richtext.RichTextBuffer, wx.richtext.RichTextObject, wx.richtext.RichTextCtrl

Class Hierarchy

Inheritance diagram for class RichTextProperties:

Methods Summary

__init__	Default constructor.
Clear	Clears the properties.
Copy	Copies from props.
Find	Finds the given property.
FindOrCreateProperty	Finds or creates a property with the given name, returning a pointer to the variant.
GetCount	Returns a count of the properties.
GetProperties	Returns the array of variants implementing the properties.
GetProperty	Gets the property variant by name.
GetPropertyBool	Gets the value of the named property as a boolean.
GetPropertyDouble	Gets the value of the named property as a double.
GetPropertyLong	Gets the value of the named property as a long integer.
GetPropertyNames	Returns all the property names.
GetPropertyString	Gets the value of the named property as a string.
HasProperty	Returns True if the given property is found.
MergeProperties	Merges the given properties with these properties.
Remove	Removes the given property.
RemoveProperties	Removes the given properties from these properties.
SetProperties	Sets the array of variants.
SetProperty	Sets the property by passing a variant which contains a name and value.
__eq__	Equality operator.

Properties Summary

Count	See GetCount
Properties	See GetProperties and SetProperties
PropertyNames	See GetPropertyNames

Class API

class wx.richtext.RichTextProperties(Object)

Possible constructors:

RichTextProperties() -> None

RichTextProperties(props : RichTextProperties) -> None

A simple property class using Variants.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Return type:

None

---

__init__ (self, props : RichTextProperties)

Copy constructor.

Parameters:

props (wx.richtext.RichTextProperties)

Return type:

None

---

---

Clear(self)

Clears the properties.

Return type:

None

---

Copy(self, props: RichTextProperties)

Copies from props.

Parameters:

props (wx.richtext.RichTextProperties)

Return type:

None

---

Find(self, name: str)

Finds the given property.

Parameters:

name (string)

Return type:

int

---

FindOrCreateProperty(self, name: str)

Finds or creates a property with the given name, returning a pointer to the variant.

Parameters:

name (string)

Return type:

Variant

---

GetCount(self)

Returns a count of the properties.

Return type:

int

---

GetProperties(self)

Returns the array of variants implementing the properties.

Return type:

RichTextVariantArray

---

GetProperty(self, name: str)

Gets the property variant by name.

Parameters:

name (string)

Return type:

Variant

---

GetPropertyBool(self, name: str)

Gets the value of the named property as a boolean.

Parameters:

name (string)

Return type:

bool

---

GetPropertyDouble(self, name: str)

Gets the value of the named property as a double.

Parameters:

name (string)

Return type:

float

---

GetPropertyLong(self, name: str)

Gets the value of the named property as a long integer.

Parameters:

name (string)

Return type:

int

---

GetPropertyNames(self)

Returns all the property names.

Return type:

List[str]

---

GetPropertyString(self, name: str)

Gets the value of the named property as a string.

Parameters:

name (string)

Return type:

str

---

HasProperty(self, name: str)

Returns True if the given property is found.

Parameters:

name (string)

Return type:

bool

---

MergeProperties(self, properties: RichTextProperties)

Merges the given properties with these properties.

Parameters:

properties (wx.richtext.RichTextProperties)

Return type:

None

---

Remove(self, name: str)

Removes the given property.

Parameters:

name (string)

Return type:

bool

---

RemoveProperties(self, properties: RichTextProperties)

Removes the given properties from these properties.

Parameters:

properties (wx.richtext.RichTextProperties)

Return type:

None

---

SetProperties(self, props: RichTextVariantArray)

Sets the array of variants.

Parameters:

props (RichTextVariantArray)

Return type:

None

---

SetProperty(self, *args, **kw)

Overloaded Implementations:

---

SetProperty (self, variant : Variant)

Sets the property by passing a variant which contains a name and value.

Parameters:

variant (Variant)

Return type:

None

---

SetProperty (self, name : str, variant : Variant)

Sets a property by name and variant.

Parameters:

• name (string)

• variant (Variant)

Return type:

None

---

SetProperty (self, name : str, value : str)

Sets a property by name and string value.

Parameters:

• name (string)

• value (string)

Return type:

None

---

SetProperty (self, name : str, value : str)

Sets a property by name and Char value.

Parameters:

• name (string)

• value (wx.Char)

Return type:

None

---

SetProperty (self, name : str, value : int)

Sets property by name and long integer value.

Parameters:

• name (string)

• value (long)

Return type:

None

---

SetProperty (self, name : str, value : float)

Sets property by name and float value.

Parameters:

• name (string)

• value (float)

Return type:

None

---

---

__eq__(self)

Equality operator.

Parameters:

props (wx.richtext.RichTextProperties)

Properties

Count

See GetCount

---

Properties

See GetProperties and SetProperties

---

PropertyNames

See GetPropertyNames