wxRuby Documentation Home

# Wx::RichTextStyleSheet

A style sheet contains named paragraph and character styles that make it
easy for a user to apply combinations of attributes to a RichTextCtrl.

You can use a RichTextStyleListBox in your
user interface to show available styles to the user, and allow application
of styles to the control.

## Derived from

Object

## Data structures

## Methods

- RichTextStyleSheet.new
- RichTextStyleSheet#add_character_style
- RichTextStyleSheet#add_list_style
- RichTextStyleSheet#add_paragraph_style
- RichTextStyleSheet#add_style
- RichTextStyleSheet#delete_styles
- RichTextStyleSheet#find_character_style
- RichTextStyleSheet#find_list_style
- RichTextStyleSheet#find_paragraph_style
- RichTextStyleSheet#find_style
- RichTextStyleSheet#get_character_style
- RichTextStyleSheet#get_character_style_count
- RichTextStyleSheet#get_description
- RichTextStyleSheet#get_list_style
- RichTextStyleSheet#get_list_style_count
- RichTextStyleSheet#get_name
- RichTextStyleSheet#get_paragraph_style
- RichTextStyleSheet#get_paragraph_style_count
- RichTextStyleSheet#remove_character_style
- RichTextStyleSheet#remove_list_style
- RichTextStyleSheet#remove_paragraph_style
- RichTextStyleSheet#remove_style
- RichTextStyleSheet#set_description
- RichTextStyleSheet#set_name

### RichTextStyleSheet.new

destructor()

Destructor.

### RichTextStyleSheet#add_character_style

Boolean add_character_style(%(arg-type)RichTextCharacterStyleDefinition% def)

Adds a definition to the character style list.

### RichTextStyleSheet#add_list_style

Boolean add_list_style(%(arg-type)RichTextListStyleDefinition% def)

Adds a definition to the list style list.

### RichTextStyleSheet#add_paragraph_style

Boolean add_paragraph_style(%(arg-type)RichTextParagraphStyleDefinition% def)

Adds a definition to the paragraph style list.

### RichTextStyleSheet#add_style

Boolean add_style(%(arg-type)RichTextStyleDefinition% def)

Adds a definition to the appropriate style list.

### RichTextStyleSheet#delete_styles

delete_styles()

Deletes all styles.

### RichTextStyleSheet#find_character_style

RichTextCharacterStyleDefinition find_character_style(%(arg-type)String% name)

Finds a character definition by name.

### RichTextStyleSheet#find_list_style

RichTextListStyleDefinition find_list_style(%(arg-type)String% name)

Finds a list definition by name.

### RichTextStyleSheet#find_paragraph_style

RichTextParagraphStyleDefinition find_paragraph_style(%(arg-type)String% name)

Finds a paragraph definition by name.

### RichTextStyleSheet#find_style

RichTextStyleDefinition find_style(%(arg-type)String% name)

Finds a style definition by name.

### RichTextStyleSheet#get_character_style

RichTextCharacterStyleDefinition get_character_style(%(arg-type)size_t% n)

Returns the _n_th character style.

### RichTextStyleSheet#get_character_style_count

size_t get_character_style_count()

Returns the number of character styles.

### RichTextStyleSheet#get_description

String get_description()

Returns the style sheet’s description.

### RichTextStyleSheet#get_list_style

RichTextListStyleDefinition get_list_style(%(arg-type)size_t% n)

Returns the _n_th list style.

### RichTextStyleSheet#get_list_style_count

size_t get_list_style_count()

Returns the number of list styles.

### RichTextStyleSheet#get_name

String get_name()

Returns the style sheet’s name.

### RichTextStyleSheet#get_paragraph_style

RichTextParagraphStyleDefinition get_paragraph_style(%(arg-type)size_t% n)

Returns the _n_th paragraph style.

### RichTextStyleSheet#get_paragraph_style_count

size_t get_paragraph_style_count()

Returns the number of paragraph styles.

### RichTextStyleSheet#remove_character_style

Boolean remove_character_style(%(arg-type)RichTextStyleDefinition% def, Boolean deleteStyle = false)

Removes a character style.

### RichTextStyleSheet#remove_list_style

Boolean remove_list_style(%(arg-type)RichTextStyleDefinition% def, Boolean deleteStyle = false)

Removes a list style.

### RichTextStyleSheet#remove_paragraph_style

Boolean remove_paragraph_style(%(arg-type)RichTextStyleDefinition% def, Boolean deleteStyle = false)

Removes a paragraph style.

### RichTextStyleSheet#remove_style

Boolean remove_style(%(arg-type)RichTextStyleDefinition% def, Boolean deleteStyle = false)

Removes a style.

### RichTextStyleSheet#set_description

set_description(%(arg-type)String% descr)

Sets the style sheet’s description.

### RichTextStyleSheet#set_name

set_name(%(arg-type)String% name)

Sets the style sheet’s name.

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