wxRuby Documentation Home

# Wx::RichTextListStyleDefinition

This class represents a list style definition, usually added to a 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 RichTextCtrl#set_list_style. You
can also use the functions RichTextCtrl#number_list, RichTextCtrl#promote_list and
RichTextCtrl#clear_list_style. As usual, there are RichTextBuffer versions of these functions
so that you can apply them directly to a buffer without requiring a control.

## Derived from

RichTextParagraphStyleDefinition

## Data structures

## Methods

- RichTextListStyleDefinition.new
- RichTextListStyleDefinition#combine_with_paragraph_style
- RichTextListStyleDefinition#find_level_for_indent
- RichTextListStyleDefinition#get_combined_style
- RichTextListStyleDefinition#get_combined_style_for_level
- RichTextListStyleDefinition#get_level_attributes
- RichTextListStyleDefinition#get_level_count
- RichTextListStyleDefinition#is_numbered
- RichTextListStyleDefinition#set_level_attributes

### RichTextListStyleDefinition.new

RichTextListStyleDefinition.new(%(arg-type)String% name = ’’)

Constructor.

destructor()

Destructor.

### RichTextListStyleDefinition#combine_with_paragraph_style

RichTextAttr combine_with_paragraph_style(%(arg-type)Integer% indent, RichTextAttr paraStyle, RichTextStyleSheet styleSheet = nil)

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.

### RichTextListStyleDefinition#find_level_for_indent

Integer find_level_for_indent(%(arg-type)Integer% indent)

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

### RichTextListStyleDefinition#get_combined_style

RichTextAttr get_combined_style(%(arg-type)Integer% indent, RichTextStyleSheet styleSheet = nil)

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.

### RichTextListStyleDefinition#get_combined_style_for_level

RichTextAttr get_combined_style_level(%(arg-type)Integer% level, RichTextStyleSheet styleSheet = nil)

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.

### RichTextListStyleDefinition#get_level_attributes

RichTextAttr get_level_attributes(%(arg-type)Integer% level)

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

### RichTextListStyleDefinition#get_level_count

Integer get_level_count()

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.

### RichTextListStyleDefinition#is_numbered

Integer is_numbered(%(arg-type)Integer% level)

Returns if the given level has numbered list attributes.

### RichTextListStyleDefinition#set_level_attributes

set_level_attributes(%(arg-type)Integer% level, RichTextAttr attr) set_level_attributes(%(arg-type)Integer% level, Integer leftIndent, Integer leftSubIndent, Integer bulletStyle, String bulletSymbol = ’’)

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

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

[This page automatically generated from the Textile source at 2023-06-09 00:45:34 +0000]