Navigation

Phoenix Logo

phoenix_title wx.richtext.RichTextListStyleDefinition

This class represents a list style definition, usually added to a wx.richtext.RichTextStyleSheet.

The class inherits paragraph attributes from RichTextStyleParagraphDefinition, and adds 10 further attribute objects, one for each level of a list. When applying a list style to a paragraph, the list style’s base and appropriate level attributes are merged with the paragraph’s existing attributes.

You can apply a list style to one or more paragraphs using wx.richtext.RichTextCtrl.SetListStyle . You can also use the functions wx.richtext.RichTextCtrl.NumberList , wx.richtext.RichTextCtrl.PromoteList and wx.richtext.RichTextCtrl.ClearListStyle .

As usual, there are wx.richtext.RichTextBuffer versions of these functions so that you can apply them directly to a buffer without requiring a control.


class_hierarchy Class Hierarchy

Inheritance diagram for class RichTextListStyleDefinition:

method_summary Methods Summary

__init__ Constructor.
CombineWithParagraphStyle This function combines the given paragraph style with the list style’s base attributes and level style matching the given indent, returning the combined attributes.
FindLevelForIndent This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches indent (expressed in tenths of a millimetre).
GetCombinedStyle This function combines the list style’s base attributes and the level style matching the given indent, returning the combined attributes.
GetCombinedStyleForLevel This function combines the list style’s base attributes and the style for the specified level, returning the combined attributes.
GetLevelAttributes Returns the style for the given level.
GetLevelCount Returns the number of levels.
IsNumbered Returns True if the given level has numbered list attributes.
SetLevelAttributes Sets the style for the given level.

property_summary Properties Summary

LevelCount See GetLevelCount

api Class API


class wx.richtext.RichTextListStyleDefinition(RichTextParagraphStyleDefinition)

Possible constructors:

RichTextListStyleDefinition(name="")

This class represents a list style definition, usually added to a RichTextStyleSheet.


Methods


__init__(self, name="")

Constructor.

Parameters:name (string) –

CombineWithParagraphStyle(self, indent, paraStyle, styleSheet=None)

This function combines the given paragraph style with the list style’s base attributes and level style matching the given indent, returning the combined attributes.

If styleSheet is specified, the base style for this definition will also be included in the result.

Parameters:
Return type:

wx.richtext.RichTextAttr

FindLevelForIndent(self, indent)

This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches indent (expressed in tenths of a millimetre).

Parameters:indent (int) –
Return type:int

GetCombinedStyle(self, indent, styleSheet=None)

This function combines the list style’s base attributes and the level style matching the given indent, returning the combined attributes.

If styleSheet is specified, the base style for this definition will also be included in the result.

Parameters:
Return type:

wx.richtext.RichTextAttr

GetCombinedStyleForLevel(self, level, styleSheet=None)

This function combines the list style’s base attributes and the style for the specified level, returning the combined attributes.

If styleSheet is specified, the base style for this definition will also be included in the result.

Parameters:
Return type:

wx.richtext.RichTextAttr

GetLevelAttributes(self, level)

Returns the style for the given level.

level is a number between 0 and 9.

Parameters:level (int) –
Return type: wx.richtext.RichTextAttr

GetLevelCount(self)

Returns the number of levels.

This is hard-wired to 10. Returns the style for the given level. level is a number between 0 and 9.

Return type:int

IsNumbered(self, level)

Returns True if the given level has numbered list attributes.

Parameters:level (int) –
Return type:bool

SetLevelAttributes(self, level, attr)

Sets the style for the given level.

level is a number between 0 and 9. The first and most flexible form uses a wx.TextAttr object, while the second form is for convenient setting of the most commonly-used attributes.

Parameters:

Properties


LevelCount

See GetLevelCount