wxRuby Documentation Home

# Wx::RichTextStyleListCtrl

This class incorporates a RichTextStyleListBox and
a choice control that allows the user to select the category of style to view.
It is demonstrated in the RichTextCtrl sample in `samples/richtext`.

To use RichTextStyleListCtrl, add the control to your window hierarchy and
call set_style_type with
one of RichTextStyleListBox::RICHTEXT_STYLE_ALL, RichTextStyleListBox::RICHTEXT_STYLE_PARAGRAPH,
RichTextStyleListBox::RICHTEXT_STYLE_CHARACTER and RichTextStyleListBox::RICHTEXT_STYLE_LIST to set the current view.
Associate the control with a style sheet and rich text control with SetStyleSheet and SetRichTextCtrl,
so that when a style is double-clicked, it is applied to the selection.

## Window styles

`RICHTEXTSTYLELIST_HIDE_TYPE_SELECTOR` | This style hides the category selection control.

## Derived from

Control

## Data structures

## Methods

- RichTextStyleListCtrl.new
- RichTextStyleListCtrl#create
- RichTextStyleListCtrl#get_rich_text_ctrl
- RichTextStyleListCtrl#get_style_choice
- RichTextStyleListCtrl#get_style_list_box
- RichTextStyleListCtrl#get_style_sheet
- RichTextStyleListCtrl#get_style_type
- RichTextStyleListCtrl#set_rich_text_ctrl
- RichTextStyleListCtrl#set_style_sheet
- RichTextStyleListCtrl#set_style_type
- RichTextStyleListCtrl#update_styles

### RichTextStyleListCtrl.new

RichTextStyleListCtrl.new(%(arg-type)Window% parent, Integer id = ID_ANY, Point pos = DEFAULT_POSITION, Size size = DEFAULT_SIZE, Integer style = 0)

### RichTextStyleListCtrl#create

Boolean create(%(arg-type)Window% parent, Integer id = ID_ANY, Point pos = DEFAULT_POSITION, Size size = DEFAULT_SIZE, Integer style = 0)

Creates the windows.

### RichTextStyleListCtrl#get_rich_text_ctrl

RichTextCtrl get_rich_text_ctrl()

Returns the associated rich text control, if any.

### RichTextStyleListCtrl#get_style_choice

Choice get_style_choice()

Returns the Choice control used for selecting the style category.

### RichTextStyleListCtrl#get_style_list_box

RichTextStyleListBox get_style_list_box()

Returns the ListBox control used to view the style list.

### RichTextStyleListCtrl#get_style_sheet

RichTextStyleSheet get_style_sheet()

Returns the associated style sheet, if any.

### RichTextStyleListCtrl#get_style_type

RichTextStyleListBox::RichTextStyleType get_style_type()

Returns the type of style to show in the list box.

### RichTextStyleListCtrl#set_rich_text_ctrl

set_rich_text_ctrl(%(arg-type)RichTextCtrl% ctrl)

Associates the control with a RichTextCtrl.

### RichTextStyleListCtrl#set_style_sheet

set_style_sheet(%(arg-type)RichTextStyleSheet% styleSheet)

Associates the control with a style sheet.

### RichTextStyleListCtrl#set_style_type

set_style_type(%(arg-type)RichTextStyleListBox::RichTextStyleType% styleType)

Sets the style type to display. One of RichTextStyleListBox::RICHTEXT_STYLE_ALL, RichTextStyleListBox::RICHTEXT_STYLE_PARAGRAPH,
RichTextStyleListBox::RICHTEXT_STYLE_CHARACTER and RichTextStyleListBox::RICHTEXT_STYLE_LIST.

### RichTextStyleListCtrl#update_styles

update_styles()

Updates the style list box.

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