Class: Wx::RTC::RichTextStyleSheet

Inherits:
Object
  • Object
show all
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

Requires:

  • USE_RICHTEXT

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::RTC::RichTextStyleSheet

Constructor.



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.

Parameters:

Returns:

  • (Boolean) 


892
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 892

def add_character_style(def_) end

#add_list_style(def_) ⇒ Boolean

Adds a definition to the list style list.

Parameters:

Returns:

  • (Boolean) 


897
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 897

def add_list_style(def_) end

#add_paragraph_style(def_) ⇒ Boolean

Adds a definition to the paragraph style list.

Parameters:

Returns:

  • (Boolean) 


902
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 902

def add_paragraph_style(def_) end

#add_style(def_) ⇒ Boolean

Adds a definition to the appropriate style list.

Parameters:

Returns:

  • (Boolean) 


907
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 907

def add_style(def_) end

#copy(sheet) ⇒ void

This method returns an undefined value.

Copy given style sheet

Parameters:



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.



911
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 911

def delete_styles; end

#find_character_style(name, recurse = true) ⇒ Wx::RTC::RichTextCharacterStyleDefinition

Finds a character definition by name.

Parameters:

  • name (String)
  • recurse (Boolean) (defaults to: true)

Returns:



917
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 917

def find_character_style(name, recurse=true) end

#find_list_style(name, recurse = true) ⇒ Wx::RTC::RichTextListStyleDefinition

Finds a list definition by name.

Parameters:

  • name (String)
  • recurse (Boolean) (defaults to: true)

Returns:



923
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 923

def find_list_style(name, recurse=true) end

#find_paragraph_style(name, recurse = true) ⇒ Wx::RTC::RichTextParagraphStyleDefinition

Finds a paragraph definition by name.

Parameters:

  • name (String)
  • recurse (Boolean) (defaults to: true)

Returns:



929
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 929

def find_paragraph_style(name, recurse=true) end

#find_style(name) ⇒ Wx::RTC::RichTextStyleDefinition

Finds a style definition by name.

Parameters:

  • name (String)

Returns:



934
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 934

def find_style(name) end

#get_character_style(n) ⇒ Wx::RTC::RichTextCharacterStyleDefinition Also known as: character_style

Returns the nth character style.

Parameters:

  • n (Integer)

Returns:



939
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 939

def get_character_style(n) end

#get_character_style_count ⇒ Integer Also known as: character_style_count

Returns the number of character styles.

Returns:

  • (Integer) 


944
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 944

def get_character_style_count; end

#get_description ⇒ Wx::String Also known as: description

Returns the style sheet’s description.

Returns:

  • (Wx::String) 


949
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 949

def get_description; end

#get_list_style(n) ⇒ Wx::RTC::RichTextListStyleDefinition Also known as: list_style

Returns the nth list style.

Parameters:

  • n (Integer)

Returns:



955
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 955

def get_list_style(n) end

#get_list_style_count ⇒ Integer Also known as: list_style_count

Returns the number of list styles.

Returns:

  • (Integer) 


960
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 960

def get_list_style_count; end

#get_name ⇒ Wx::String Also known as: name

Returns the style sheet’s name.

Returns:

  • (Wx::String) 


965
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 965

def get_name; end

#get_paragraph_style(n) ⇒ Wx::RTC::RichTextParagraphStyleDefinition Also known as: paragraph_style

Returns the nth paragraph style.

Parameters:

  • n (Integer)

Returns:



971
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 971

def get_paragraph_style(n) end

#get_paragraph_style_count ⇒ Integer Also known as: paragraph_style_count

Returns the number of paragraph styles.

Returns:

  • (Integer) 


976
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 976

def get_paragraph_style_count; end

#get_properties ⇒ Wx::RTC::RichTextProperties Also known as: properties

Returns the sheet’s properties.

Returns:



1017
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1017

def get_properties; end

#remove_character_style(def_, deleteStyle = false) ⇒ Boolean

Removes a character style.

Parameters:

Returns:

  • (Boolean) 


983
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 983

def remove_character_style(def_, deleteStyle=false) end

#remove_list_style(def_, deleteStyle = false) ⇒ Boolean

Removes a list style.

Parameters:

Returns:

  • (Boolean) 


989
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 989

def remove_list_style(def_, deleteStyle=false) end

#remove_paragraph_style(def_, deleteStyle = false) ⇒ Boolean

Removes a paragraph style.

Parameters:

Returns:

  • (Boolean) 


995
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 995

def remove_paragraph_style(def_, deleteStyle=false) end

#remove_style(def_, deleteStyle = false) ⇒ Boolean

Removes a style.

Parameters:

Returns:

  • (Boolean) 


1001
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1001

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.

Parameters:

  • descr (String) 


1006
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1006

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.

Parameters:

  • name (String) 


1012
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1012

def set_name(name) end

#set_properties(props) ⇒ void Also known as: properties=

This method returns an undefined value.

Sets the sheet’s properties.

Parameters:



1023
 
# File 'lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb', line 1023

def set_properties(props) end