Class: Wx::RTC::TextAttrBorder

Inherits:

Object

• Object
• Wx::RTC::TextAttrBorder

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 representing a rich text object border.

Category: Rich Text

See Also:

• RichTextAttr
• RichTextCtrl
• wxRichTextAttrBorders

Requires:

• USE_RICHTEXT

Instance Method Summary

• #==(border) ⇒ Boolean

  Equality operator.

• #add_flag(flag) ⇒ void

  Adds a border flag.

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

  Applies the border 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(border, weakTest = true) ⇒ Boolean

  Partial equality test.

• #get_colour ⇒ Wx::Colour (also: #colour)

  Gets the colour.

• #get_colour_long ⇒ Integer (also: #colour_long)

  Gets the colour as a long.

• #get_flags ⇒ Integer (also: #flags)

  Returns the border flags.

• #get_style ⇒ Integer (also: #style)

  Gets the border style.

• #get_width ⇒ Wx::RTC::TextAttrDimension (also: #width)
• #has_colour ⇒ Boolean (also: #has_colour?)

  True if the border has a valid colour.

• #has_style ⇒ Boolean (also: #has_style?)

  True if the border has a valid style.

• #has_width ⇒ Boolean (also: #has_width?)

  True if the border has a valid width.

• #initialize ⇒ Wx::RTC::TextAttrBorder constructor

  Default constructor.

• #is_default ⇒ Boolean (also: #default?)

  True if the border has no attributes set.

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

  True if the border is valid.

• #make_valid ⇒ void

  Set the valid flag for this border.

• #remove_flag(flag) ⇒ void

  Removes a border flag.

• #remove_style(attr) ⇒ Boolean

  Removes the specified attributes from this object.

• #reset ⇒ void

  Resets the border style, colour, width and flags.

• #set_colour(*args) ⇒ Object (also: #colour=)
• #set_flags(flags) ⇒ void (also: #flags=)

  Sets the border flags.

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

  Sets the border style.

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

Constructor Details

#initialize ⇒ Wx::RTC::TextAttrBorder

Default constructor.

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

def initialize; end

Instance Method Details

#==(border) ⇒ Boolean

Equality operator.

Parameters:

• border (Wx::RTC::TextAttrBorder)

Returns:

• (Boolean)

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

def ==(border) end

#add_flag(flag) ⇒ void

This method returns an undefined value.

Adds a border flag.

Parameters:

• flag (Integer)

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

def add_flag(flag) end

#apply(border, compareWith = nil) ⇒ Boolean

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

Parameters:

• border (Wx::RTC::TextAttrBorder)
• compareWith (Wx::RTC::TextAttrBorder) (defaults to: nil)

Returns:

• (Boolean)

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

def apply(border, 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::TextAttrBorder)
• clashingAttr (Wx::RTC::TextAttrBorder)
• absentAttr (Wx::RTC::TextAttrBorder)

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

def collect_common_attributes(attr, clashingAttr, absentAttr) end

#eq_partial(border, weakTest = true) ⇒ Boolean

Partial equality test.

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

Parameters:

• border (Wx::RTC::TextAttrBorder)
• weakTest (Boolean) (defaults to: true)

Returns:

• (Boolean)

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

def eq_partial(border, weakTest=true) end

#get_colour ⇒ Wx::Colour Also known as: colour

Gets the colour.

Returns:

• (Wx::Colour)

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

def get_colour; end

#get_colour_long ⇒ Integer Also known as: colour_long

Gets the colour as a long.

Returns:

• (Integer)

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

def get_colour_long; end

#get_flags ⇒ Integer Also known as: flags

Returns the border flags.

Returns:

• (Integer)

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

def get_flags; end

#get_style ⇒ Integer Also known as: style

Gets the border style.

Returns:

• (Integer)

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

def get_style; 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 2350

def get_width; end

#has_colour ⇒ Boolean Also known as: has_colour?

True if the border has a valid colour.

Returns:

• (Boolean)

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

def has_colour; end

#has_style ⇒ Boolean Also known as: has_style?

True if the border has a valid style.

Returns:

• (Boolean)

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

def has_style; end

#has_width ⇒ Boolean Also known as: has_width?

True if the border has a valid width.

Returns:

• (Boolean)

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

def has_width; end

#is_default ⇒ Boolean Also known as: default?

True if the border has no attributes set.

Returns:

• (Boolean)

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

def is_default; end

#is_valid ⇒ Boolean Also known as: valid?

True if the border is valid.

Returns:

• (Boolean)

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

def is_valid; end

#make_valid ⇒ void

This method returns an undefined value.

Set the valid flag for this border.

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

def make_valid; end

#remove_flag(flag) ⇒ void

This method returns an undefined value.

Removes a border flag.

Parameters:

• flag (Integer)

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

def remove_flag(flag) end

#remove_style(attr) ⇒ Boolean

Removes the specified attributes from this object.

Parameters:

• attr (Wx::RTC::TextAttrBorder)

Returns:

• (Boolean)

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

def remove_style(attr) end

#reset ⇒ void

This method returns an undefined value.

Resets the border style, colour, width and flags.

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

def reset; end

#set_colour(colour) ⇒ void #set_colour(colour) ⇒ void Also known as: colour=

Overloads:

• #set_colour(colour) ⇒ void

  This method returns an undefined value.

  Sets the border colour.

  Parameters:

  • colour (Integer)
• #set_colour(colour) ⇒ void

  This method returns an undefined value.

  Sets the border colour.

  Parameters:

  • colour (Wx::Colour, String, Symbol)

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

def set_colour(*args) end

#set_flags(flags) ⇒ void Also known as: flags=

This method returns an undefined value.

Sets the border flags.

Parameters:

• flags (Integer)

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

def set_flags(flags) end

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

This method returns an undefined value.

Sets the border style.

Parameters:

• style (Integer)

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

def set_style(style) end

#set_width(width) ⇒ void #set_width(value, units = Wx::RTC::TextAttrUnits::TEXT_ATTR_UNITS_TENTHS_MM) ⇒ void Also known as: width=

Overloads:

• #set_width(width) ⇒ void

  This method returns an undefined value.

  Sets the border width.

  Parameters:

  • width (Wx::RTC::TextAttrDimension)
• #set_width(value, units = Wx::RTC::TextAttrUnits::TEXT_ATTR_UNITS_TENTHS_MM) ⇒ void

  This method returns an undefined value.

  Sets the border width.

  Parameters:

  • value (Integer)
  • units (Wx::TextAttrUnits) (defaults to: Wx::RTC::TextAttrUnits::TEXT_ATTR_UNITS_TENTHS_MM)

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

def set_width(*args) end