Phoenix Logo

phoenix_title wx.richtext.RichTextStyleDefinition

This is a base class for paragraph and character styles.


class_hierarchy Class Hierarchy

Inheritance diagram for class RichTextStyleDefinition:

method_summary Methods Summary

__init__ Constructor.
GetBaseStyle Returns the style on which this style is based.
GetDescription Returns the style’s description.
GetName Returns the style name.
GetProperties Returns the definition’s properties.
GetStyle Returns the attributes associated with this style.
GetStyleMergedWithBase Returns the style attributes combined with the attributes of the specified base style, if any.
SetBaseStyle Sets the name of the style that this style is based on.
SetDescription Sets the style description.
SetName Sets the name of the style.
SetProperties Sets the definition’s properties.
SetStyle Sets the attributes for this style.

api Class API



class wx.richtext.RichTextStyleDefinition(Object)

Possible constructors:

RichTextStyleDefinition(name="")

This is a base class for paragraph and character styles.


Methods



__init__(self, name="")

Constructor.

Parameters:name (string) –


GetBaseStyle(self)

Returns the style on which this style is based.

Return type:string


GetDescription(self)

Returns the style’s description.

Return type:string


GetName(self)

Returns the style name.

Return type:string


GetProperties(self)

Returns the definition’s properties.

Return type: wx.richtext.RichTextProperties


GetStyle(self)

Returns the attributes associated with this style.

Return type: wx.richtext.RichTextAttr


GetStyleMergedWithBase(self, sheet)

Returns the style attributes combined with the attributes of the specified base style, if any.

This function works recursively.

Parameters:sheet (wx.richtext.RichTextStyleSheet) –
Return type: wx.richtext.RichTextAttr


SetBaseStyle(self, name)

Sets the name of the style that this style is based on.

Parameters:name (string) –


SetDescription(self, descr)

Sets the style description.

Parameters:descr (string) –


SetName(self, name)

Sets the name of the style.

Parameters:name (string) –


SetProperties(self, props)

Sets the definition’s properties.

Parameters:props (wx.richtext.RichTextProperties) –


SetStyle(self, style)

Sets the attributes for this style.

Parameters:style (wx.richtext.RichTextAttr) –

Properties



BaseStyle

See GetBaseStyle and SetBaseStyle



Description

See GetDescription and SetDescription



Name

See GetName and SetName



Properties

See GetProperties and SetProperties



Style

See GetStyle and SetStyle