Class: Wx::RTC::RichTextStyleSheet
- Defined in:
- lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb,
lib/wx/doc/rtc/richtext_style_sheet.rb
Overview
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.
Category: Rich Text
Instance Method Summary collapse
-
#add_character_style(def_) ⇒ Boolean
Adds a definition to the character style list.
-
#add_list_style(def_) ⇒ Boolean
Adds a definition to the list style list.
-
#add_paragraph_style(def_) ⇒ Boolean
Adds a definition to the paragraph style list.
-
#add_style(def_) ⇒ Boolean
Adds a definition to the appropriate style list.
-
#copy(sheet) ⇒ void
Copies given style sheet.
-
#delete_styles ⇒ void
Deletes all styles.
-
#find_character_style(name, recurse = true) ⇒ Wx::RTC::RichTextCharacterStyleDefinition
Finds a character definition by name.
-
#find_list_style(name, recurse = true) ⇒ Wx::RTC::RichTextListStyleDefinition
Finds a list definition by name.
-
#find_paragraph_style(name, recurse = true) ⇒ Wx::RTC::RichTextParagraphStyleDefinition
Finds a paragraph definition by name.
-
#find_style(name) ⇒ Wx::RTC::RichTextStyleDefinition
Finds a style definition by name.
-
#get_character_style(n) ⇒ Wx::RTC::RichTextCharacterStyleDefinition
(also: #character_style)
Returns the nth character style.
-
#get_character_style_count ⇒ Integer
(also: #character_style_count)
Returns the number of character styles.
-
#get_description ⇒ Wx::String
(also: #description)
Returns the style sheet’s description.
-
#get_list_style(n) ⇒ Wx::RTC::RichTextListStyleDefinition
(also: #list_style)
Returns the nth list style.
-
#get_list_style_count ⇒ Integer
(also: #list_style_count)
Returns the number of list styles.
-
#get_name ⇒ Wx::String
(also: #name)
Returns the style sheet’s name.
-
#get_paragraph_style(n) ⇒ Wx::RTC::RichTextParagraphStyleDefinition
(also: #paragraph_style)
Returns the nth paragraph style.
-
#get_paragraph_style_count ⇒ Integer
(also: #paragraph_style_count)
Returns the number of paragraph styles.
-
#get_properties ⇒ Wx::RTC::RichTextProperties
(also: #properties)
Returns the sheet’s properties.
-
#initialize(*args) ⇒ RichTextStyleSheet
constructor
A new instance of RichTextStyleSheet.
-
#remove_character_style(def_, deleteStyle = false) ⇒ Boolean
Removes a character style.
-
#remove_list_style(def_, deleteStyle = false) ⇒ Boolean
Removes a list style.
-
#remove_paragraph_style(def_, deleteStyle = false) ⇒ Boolean
Removes a paragraph style.
-
#remove_style(def_, deleteStyle = false) ⇒ Boolean
Removes a style.
-
#set_description(descr) ⇒ void
(also: #description=)
Sets the style sheet’s description.
-
#set_name(name) ⇒ void
(also: #name=)
Sets the style sheet’s name.
-
#set_properties(props) ⇒ void
(also: #properties=)
Sets the sheet’s properties.
Methods inherited from Object
#clone, #dup, #is_same_as, #un_share
Constructor Details
#initialize ⇒ Wx::RTC::RichTextStyleSheet #initialize(sheet) ⇒ Wx::RTC::RichTextStyleSheet
Returns a new instance of RichTextStyleSheet.
17 |
# File 'lib/wx/doc/rtc/richtext_style_sheet.rb', line 17 def initialize(sheet) end |
Instance Method Details
#add_character_style(def_) ⇒ Boolean
Adds a definition to the character style list.
902 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 902 def add_character_style(def_) end |
#add_list_style(def_) ⇒ Boolean
Adds a definition to the list style list.
907 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 907 def add_list_style(def_) end |
#add_paragraph_style(def_) ⇒ Boolean
Adds a definition to the paragraph style list.
912 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 912 def add_paragraph_style(def_) end |
#add_style(def_) ⇒ Boolean
Adds a definition to the appropriate style list.
917 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 917 def add_style(def_) end |
#copy(sheet) ⇒ void
This method returns an undefined value.
Copies given style sheet.
22 |
# File 'lib/wx/doc/rtc/richtext_style_sheet.rb', line 22 def copy(sheet) end |
#delete_styles ⇒ void
This method returns an undefined value.
Deletes all styles.
921 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 921 def delete_styles; end |
#find_character_style(name, recurse = true) ⇒ Wx::RTC::RichTextCharacterStyleDefinition
Finds a character definition by name.
927 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 927 def find_character_style(name, recurse=true) end |
#find_list_style(name, recurse = true) ⇒ Wx::RTC::RichTextListStyleDefinition
Finds a list definition by name.
933 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 933 def find_list_style(name, recurse=true) end |
#find_paragraph_style(name, recurse = true) ⇒ Wx::RTC::RichTextParagraphStyleDefinition
Finds a paragraph definition by name.
939 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 939 def find_paragraph_style(name, recurse=true) end |
#find_style(name) ⇒ Wx::RTC::RichTextStyleDefinition
Finds a style definition by name.
944 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 944 def find_style(name) end |
#get_character_style(n) ⇒ Wx::RTC::RichTextCharacterStyleDefinition Also known as: character_style
Returns the nth character style.
949 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 949 def get_character_style(n) end |
#get_character_style_count ⇒ Integer Also known as: character_style_count
Returns the number of character styles.
954 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 954 def get_character_style_count; end |
#get_description ⇒ Wx::String Also known as: description
Returns the style sheet’s description.
959 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 959 def get_description; end |
#get_list_style(n) ⇒ Wx::RTC::RichTextListStyleDefinition Also known as: list_style
Returns the nth list style.
965 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 965 def get_list_style(n) end |
#get_list_style_count ⇒ Integer Also known as: list_style_count
Returns the number of list styles.
970 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 970 def get_list_style_count; end |
#get_name ⇒ Wx::String Also known as: name
Returns the style sheet’s name.
975 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 975 def get_name; end |
#get_paragraph_style(n) ⇒ Wx::RTC::RichTextParagraphStyleDefinition Also known as: paragraph_style
Returns the nth paragraph style.
981 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 981 def get_paragraph_style(n) end |
#get_paragraph_style_count ⇒ Integer Also known as: paragraph_style_count
Returns the number of paragraph styles.
986 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 986 def get_paragraph_style_count; end |
#get_properties ⇒ Wx::RTC::RichTextProperties Also known as: properties
Returns the sheet’s properties.
1027 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1027 def get_properties; end |
#remove_character_style(def_, deleteStyle = false) ⇒ Boolean
Removes a character style.
993 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 993 def remove_character_style(def_, deleteStyle=false) end |
#remove_list_style(def_, deleteStyle = false) ⇒ Boolean
Removes a list style.
999 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 999 def remove_list_style(def_, deleteStyle=false) end |
#remove_paragraph_style(def_, deleteStyle = false) ⇒ Boolean
Removes a paragraph style.
1005 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1005 def remove_paragraph_style(def_, deleteStyle=false) end |
#remove_style(def_, deleteStyle = false) ⇒ Boolean
Removes a style.
1011 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1011 def remove_style(def_, deleteStyle=false) end |
#set_description(descr) ⇒ void Also known as: description=
This method returns an undefined value.
Sets the style sheet’s description.
1016 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1016 def set_description(descr) end |
#set_name(name) ⇒ void Also known as: name=
This method returns an undefined value.
Sets the style sheet’s name.
1022 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1022 def set_name(name) end |
#set_properties(props) ⇒ void Also known as: properties=
This method returns an undefined value.
Sets the sheet’s properties.
1033 |
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1033 def set_properties(props) end |