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()

RichTextProperties(props)

A simple property class using Variants.

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

---

__init__ (self, props)

Copy constructor.

Parameters

props (wx.richtext.RichTextProperties) –

---

Clear(self)

Clears the properties.

Copy(self, props)

Copies from props.

Parameters

props (wx.richtext.RichTextProperties) –

Find(self, name)

Finds the given property.

Parameters

name (string) –

Return type

int

FindOrCreateProperty(self, name)

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)

Gets the property variant by name.

Parameters

name (string) –

Return type

Variant

GetPropertyBool(self, name)

Gets the value of the named property as a boolean.

Parameters

name (string) –

Return type

bool

GetPropertyDouble(self, name)

Gets the value of the named property as a double.

Parameters

name (string) –

Return type

float

GetPropertyLong(self, name)

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

Parameters

name (string) –

Return type

long

GetPropertyNames(self)

Returns all the property names.

Return type

list of strings

GetPropertyString(self, name)

Gets the value of the named property as a string.

Parameters

name (string) –

Return type

string

HasProperty(self, name)

Returns True if the given property is found.

Parameters

name (string) –

Return type

bool

MergeProperties(self, properties)

Merges the given properties with these properties.

Parameters

properties (wx.richtext.RichTextProperties) –

Remove(self, name)

Removes the given property.

Parameters

name (string) –

Return type

bool

RemoveProperties(self, properties)

Removes the given properties from these properties.

Parameters

properties (wx.richtext.RichTextProperties) –

SetProperties(self, props)

Sets the array of variants.

Parameters

props (RichTextVariantArray) –

SetProperty(self, *args, **kw)

Overloaded Implementations:

---

SetProperty (self, variant)

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

Parameters

variant (Variant) –

---

SetProperty (self, name, variant)

Sets a property by name and variant.

Parameters

• name (string) –

• variant (Variant) –

---

SetProperty (self, name, value)

Sets a property by name and string value.

Parameters

• name (string) –

• value (string) –

---

SetProperty (self, name, value)

Sets a property by name and Char value.

Parameters

• name (string) –

• value (wx.Char) –

---

SetProperty (self, name, value)

Sets property by name and long integer value.

Parameters

• name (string) –

• value (long) –

---

SetProperty (self, name, value)

Sets property by name and float value.

Parameters

• name (string) –

• value (float) –

---

__eq__(self)

Equality operator.

Parameters

props (wx.richtext.RichTextProperties) –

Count

See GetCount

Properties

See GetProperties and SetProperties

PropertyNames

See GetPropertyNames