phoenix_title wx.richtext.RichTextStyleDefinition

This is a base class for paragraph and character styles.


class_hierarchy Class Hierarchy

Inheritance diagram for class RichTextStyleDefinition:

sub_classes Known Subclasses

wx.richtext.RichTextCharacterStyleDefinition, wx.richtext.RichTextParagraphStyleDefinition


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.


property_summary Properties Summary

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


api Class API

class wx.richtext.RichTextStyleDefinition(Object)

Possible constructors:

RichTextStyleDefinition(name: str='') -> None

This is a base class for paragraph and character styles.


Methods

__init__(self, name: str='')

Constructor.

Parameters:

name (string) –

Return type:

None



GetBaseStyle(self)

Returns the style on which this style is based.

Return type:

str



GetDescription(self)

Returns the style’s description.

Return type:

str



GetName(self)

Returns the style name.

Return type:

str



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 : RichTextStyleSheet)

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 : str)

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

Parameters:

name (string) –

Return type:

None



SetDescription(self, descr : str)

Sets the style description.

Parameters:

descr (string) –

Return type:

None



SetName(self, name : str)

Sets the name of the style.

Parameters:

name (string) –

Return type:

None



SetProperties(self, props : RichTextProperties)

Sets the definition’s properties.

Parameters:

props (wx.richtext.RichTextProperties) –

Return type:

None



SetStyle(self, style : RichTextAttr)

Sets the attributes for this style.

Parameters:

style (wx.richtext.RichTextAttr) –

Return type:

None


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