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.
Class Hierarchy¶
Methods Summary¶
Default constructor. |
|
Clears the properties. |
|
Copies from props. |
|
Finds the given property. |
|
Finds or creates a property with the given name, returning a pointer to the variant. |
|
Returns a count of the properties. |
|
Returns the array of variants implementing the properties. |
|
Gets the property variant by name. |
|
Gets the value of the named property as a boolean. |
|
Gets the value of the named property as a double. |
|
Gets the value of the named property as a long integer. |
|
Returns all the property names. |
|
Gets the value of the named property as a string. |
|
Returns |
|
Merges the given properties with these properties. |
|
Removes the given property. |
|
Removes the given properties from these properties. |
|
Sets the array of variants. |
|
Sets the property by passing a variant which contains a name and value. |
|
Equality operator. |
Properties Summary¶
See |
|
See |
|
See |
Class API¶
- class wx.richtext.RichTextProperties(Object)¶
Possible constructors:
RichTextProperties() -> None RichTextProperties(props) -> None
A simple property class using Variants.
Methods¶
- __init__(self, *args, **kw)¶
-
__init__ (self)
Default constructor.
- Return type:
None
__init__ (self, props)
Copy constructor.
- Parameters:
props (wx.richtext.RichTextProperties)
- Return type:
None
- Clear(self)¶
Clears the properties.
- Return type:
None
- Copy(self, props)¶
Copies from props.
- Parameters:
props (wx.richtext.RichTextProperties)
- Return type:
None
- 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:
int
- GetPropertyNames(self)¶
Returns all the property names.
- Return type:
List[str]
- GetPropertyString(self, name)¶
Gets the value of the named property as a string.
- Parameters:
name (string)
- Return type:
str
- 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)
- Return type:
None
- 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)
- Return type:
None
- SetProperties(self, props)¶
Sets the array of variants.
- Parameters:
props (RichTextVariantArray)
- Return type:
None
- SetProperty(self, *args, **kw)¶
-
SetProperty (self, variant)
Sets the property by passing a variant which contains a name and value.
- Parameters:
variant (Variant)
- Return type:
None
SetProperty (self, name, variant)
Sets a property by name and variant.
- Parameters:
name (string)
variant (Variant)
- Return type:
None
SetProperty (self, name, value)
Sets a property by name and string value.
- Parameters:
name (string)
value (string)
- Return type:
None
SetProperty (self, name, value)
Sets a property by name and Char value.
- Parameters:
name (string)
value (wx.Char)
- Return type:
None
SetProperty (self, name, value)
Sets property by name and long integer value.
- Parameters:
name (string)
value (long)
- Return type:
None
SetProperty (self, name, value)
Sets property by name and float value.
- Parameters:
name (string)
value (float)
- Return type:
None
- __eq__(self, props)¶
Equality operator.
- Parameters:
props (wx.richtext.RichTextProperties)
- Return type:
bool
Properties¶
- Properties¶
See
GetProperties
andSetProperties
- PropertyNames¶
See
GetPropertyNames