Class: Wx::RTC::RichTextStyleDefinition

Inherits:

Object

• Object
• Object
• Wx::RTC::RichTextStyleDefinition

Defined in:

lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb

Overview

This is a base class for paragraph and character styles.

Category: Rich Text

Requires:

• USE_RICHTEXT

Direct Known Subclasses

RichTextCharacterStyleDefinition, RichTextParagraphStyleDefinition

Instance Method Summary

• #get_base_style ⇒ Wx::String (also: #base_style)

  Returns the style on which this style is based.

• #get_description ⇒ Wx::String (also: #description)

  Returns the style’s description.

• #get_name ⇒ Wx::String (also: #name)

  Returns the style name.

• #get_properties ⇒ Wx::RTC::RichTextProperties (also: #properties)

  Returns the definition’s properties.

• #get_style_merged_with_base(sheet) ⇒ Wx::RTC::RichTextAttr (also: #style_merged_with_base)

  Returns the style attributes combined with the attributes of the specified base style, if any.

• #initialize(name = ('')) ⇒ Wx::RTC::RichTextStyleDefinition constructor

  Constructor.

• #set_base_style(name) ⇒ void (also: #base_style=)

  Sets the name of the style that this style is based on.

• #set_description(descr) ⇒ void (also: #description=)

  Sets the style description.

• #set_name(name) ⇒ void (also: #name=)

  Sets the name of the style.

• #set_properties(props) ⇒ void (also: #properties=)

  Sets the definition’s properties.

• #set_style(style) ⇒ void (also: #style=)

  Sets the attributes for this style.

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(name = ('')) ⇒ Wx::RTC::RichTextStyleDefinition

Constructor.

Parameters:

• name (String) (defaults to: (''))

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

def initialize(name=('')) end

Instance Method Details

#get_base_style ⇒ Wx::String Also known as: base_style

Returns the style on which this style is based.

Returns:

• (Wx::String)

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

def get_base_style; end

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

Returns the style’s description.

Returns:

• (Wx::String)

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

def get_description; end

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

Returns the style name.

Returns:

• (Wx::String)

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

def get_name; end

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

Returns the definition’s properties.

Returns:

• (Wx::RTC::RichTextProperties)

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

def get_properties; end

#get_style_merged_with_base(sheet) ⇒ Wx::RTC::RichTextAttr Also known as: style_merged_with_base

Returns the style attributes combined with the attributes of the specified base style, if any.

This function works recursively.

Parameters:

• sheet (Wx::RTC::RichTextStyleSheet)

Returns:

• (Wx::RTC::RichTextAttr)

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

def get_style_merged_with_base(sheet) end

#set_base_style(name) ⇒ void Also known as: base_style=

This method returns an undefined value.

Sets the name of the style that this style is based on.

Parameters:

• name (String)

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

def set_base_style(name) end

#set_description(descr) ⇒ void Also known as: description=

This method returns an undefined value.

Sets the style description.

Parameters:

• descr (String)

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

def set_description(descr) end

#set_name(name) ⇒ void Also known as: name=

This method returns an undefined value.

Sets the name of the style.

Parameters:

• name (String)

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

def set_name(name) end

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

This method returns an undefined value.

Sets the definition’s properties.

Parameters:

• props (Wx::RTC::RichTextProperties)

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

def set_properties(props) end

#set_style(style) ⇒ void Also known as: style=

This method returns an undefined value.

Sets the attributes for this style.

Parameters:

• style (Wx::RTC::RichTextAttr)

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

def set_style(style) end