## wxRichTextListStyleDefinition

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

The class inherits paragraph attributes from wxRichTextStyleParagraphDefinition, 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 wxRichTextCtrl::SetListStyle. You can also use the functions wxRichTextCtrl::NumberList, wxRichTextCtrl::PromoteList and wxRichTextCtrl::ClearListStyle. As usual, there are wxRichTextBuffer versions of these functions so that you can apply them directly to a buffer without requiring a control.

Derived from

wxRichTextParagraphStyleDefinition

Include files

<wx/richtext/richtextstyles.h>

Data structures

Members

wxRichTextListStyleDefinition::wxRichTextListStyleDefinition
wxRichTextListStyleDefinition::~wxRichTextListStyleDefinition
wxRichTextListStyleDefinition::CombineWithParagraphStyle
wxRichTextListStyleDefinition::FindLevelForIndent
wxRichTextListStyleDefinition::GetCombinedStyle
wxRichTextListStyleDefinition::GetLevelAttributes
wxRichTextListStyleDefinition::GetLevelCount
wxRichTextListStyleDefinition::IsNumbered
wxRichTextListStyleDefinition::SetLevelAttributes

### wxRichTextListStyleDefinition::wxRichTextListStyleDefinition

wxRichTextListStyleDefinition(const wxString& name = wxEmptyString)

Constructor.

### wxRichTextListStyleDefinition::~wxRichTextListStyleDefinition

~wxRichTextListStyleDefinition()

Destructor.

### wxRichTextListStyleDefinition::CombineWithParagraphStyle

wxRichTextAttr CombineWithParagraphStyle(int indent, const wxRichTextAttr& paraStyle)

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.

### wxRichTextListStyleDefinition::FindLevelForIndent

int FindLevelForIndent(int indent) const

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

### wxRichTextListStyleDefinition::GetCombinedStyle

wxRichTextAttr GetCombinedStyle(int indent) const

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

### wxRichTextListStyleDefinition::GetLevelAttributes

const wxRichTextAttr* GetLevelAttributes(int level) const

Returns the style for the given level. level is a number between 0 and 9.

### wxRichTextListStyleDefinition::GetLevelCount

int GetLevelCount() const

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.

### wxRichTextListStyleDefinition::IsNumbered

int IsNumbered(int level) const

Returns `true` if the given level has numbered list attributes.

### wxRichTextListStyleDefinition::SetLevelAttributes

void SetLevelAttributes(int level, const wxRichTextAttr& attr)

void SetLevelAttributes(int level, int leftIndent, int leftSubIndent, int bulletStyle, const wxString& bulletSymbol = wxEmptyString)

Sets the style for the given level. level is a number between 0 and 9.

The first and most flexible form uses a wxRichTextAttr object, while the second form is for convenient setting of the most commonly-used attributes.