Class: Wx::RTC::TextAttrSize

Inherits:

Object

• Object
• Wx::RTC::TextAttrSize

Defined in:

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

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

A class for representing width and height.

Category: Rich Text

See Also:

• RichTextAttr
• RichTextCtrl
• TextAttrDimension

Requires:

• USE_RICHTEXT

Instance Method Summary

• #==(size) ⇒ Boolean

  Equality operator.

• #apply(dims, compareWith = nil) ⇒ Boolean

  Apply to this object, but not if the same as compareWith.

• #collect_common_attributes(attr, clashingAttr, absentAttr) ⇒ void

  Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.

• #eq_partial(size, weakTest = true) ⇒ Boolean

  Partial equality test.

• #get_height ⇒ Wx::RTC::TextAttrDimension (also: #height)
• #get_width ⇒ Wx::RTC::TextAttrDimension (also: #width)
• #initialize ⇒ Wx::RTC::TextAttrSize constructor

  Default constructor.

• #is_valid ⇒ Boolean (also: #valid?)

  Is the size valid?.

• #remove_style(attr) ⇒ Boolean

  Removes the specified attributes from this object.

• #reset ⇒ void

  Resets the width and height dimensions.

• #set_height(*args) ⇒ Object (also: #height=)
• #set_width(*args) ⇒ Object (also: #width=)

Constructor Details

#initialize ⇒ Wx::RTC::TextAttrSize

Default constructor.

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2536

def initialize; end

Instance Method Details

#==(size) ⇒ Boolean

Equality operator.

Parameters:

• size (Wx::RTC::TextAttrSize)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2545

def ==(size) end

#apply(dims, compareWith = nil) ⇒ Boolean

Apply to this object, but not if the same as compareWith.

Parameters:

• dims (Wx::RTC::TextAttrSize)
• compareWith (Wx::RTC::TextAttrSize) (defaults to: nil)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2559

def apply(dims, compareWith=nil) end

#collect_common_attributes(attr, clashingAttr, absentAttr) ⇒ void

This method returns an undefined value.

Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.

Parameters:

• attr (Wx::RTC::TextAttrSize)
• clashingAttr (Wx::RTC::TextAttrSize)
• absentAttr (Wx::RTC::TextAttrSize)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2566

def collect_common_attributes(attr, clashingAttr, absentAttr) end

#eq_partial(size, weakTest = true) ⇒ Boolean

Partial equality test.

If weakTest is true, attributes of this object do not have to be present if those attributes of size are present. If weakTest is false, the function will fail if an attribute is present in size but not in this object.

Parameters:

• size (Wx::RTC::TextAttrSize)
• weakTest (Boolean) (defaults to: true)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2553

def eq_partial(size, weakTest=true) end

#get_height ⇒ Wx::RTC::TextAttrDimension Also known as: height

Returns:

• (Wx::RTC::TextAttrDimension)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2595

def get_height; end

#get_width ⇒ Wx::RTC::TextAttrDimension Also known as: width

Returns:

• (Wx::RTC::TextAttrDimension)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2574

def get_width; end

#is_valid ⇒ Boolean Also known as: valid?

Is the size valid?

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2617

def is_valid; end

#remove_style(attr) ⇒ Boolean

Removes the specified attributes from this object.

Parameters:

• attr (Wx::RTC::TextAttrSize)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2571

def remove_style(attr) end

#reset ⇒ void

This method returns an undefined value.

Resets the width and height dimensions.

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2540

def reset; end

#set_height(value, flags) ⇒ void #set_height(value, units) ⇒ void #set_height(dim) ⇒ void Also known as: height=

Overloads:

• #set_height(value, flags) ⇒ void

  This method returns an undefined value.

  Sets the height.

  Parameters:

  • value (Integer)
  • flags (Wx::TextAttrDimensionFlags)
• #set_height(value, units) ⇒ void

  This method returns an undefined value.

  Sets the height.

  Parameters:

  • value (Integer)
  • units (Wx::TextAttrUnits)
• #set_height(dim) ⇒ void

  This method returns an undefined value.

  Sets the height.

  Parameters:

  • dim (Wx::RTC::TextAttrDimension)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2612

def set_height(*args) end

#set_width(value, flags) ⇒ void #set_width(value, units) ⇒ void #set_width(dim) ⇒ void Also known as: width=

Overloads:

• #set_width(value, flags) ⇒ void

  This method returns an undefined value.

  Sets the width.

  Parameters:

  • value (Integer)
  • flags (Wx::TextAttrDimensionFlags)
• #set_width(value, units) ⇒ void

  This method returns an undefined value.

  Sets the width.

  Parameters:

  • value (Integer)
  • units (Wx::TextAttrUnits)
• #set_width(dim) ⇒ void

  This method returns an undefined value.

  Sets the width.

  Parameters:

  • dim (Wx::RTC::TextAttrDimension)

# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2591

def set_width(*args) end