Class: Wx::RTC::TextAttrBorders
- Inherits:
-
Object
- Object
- Wx::RTC::TextAttrBorders
- Defined in:
- lib/wx/doc/gen/rtc/rich_text_object.rb
Overview
This class is untracked and should not be derived from nor instances extended!
A class representing a rich text object’s borders.
Category: Rich Text
Instance Method Summary collapse
-
#==(borders) ⇒ Boolean
Equality operator.
-
#apply(borders, compareWith = nil) ⇒ Boolean
Applies 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(borders, weakTest = true) ⇒ Boolean
Partial equality test.
-
#get_bottom ⇒ Wx::RTC::TextAttrBorder
(also: #bottom)
Returns the bottom border.
-
#get_left ⇒ Wx::RTC::TextAttrBorder
(also: #left)
Returns the left border.
-
#get_right ⇒ Wx::RTC::TextAttrBorder
(also: #right)
Returns the right border.
-
#get_top ⇒ Wx::RTC::TextAttrBorder
(also: #top)
Returns the top border.
-
#initialize ⇒ Wx::RTC::TextAttrBorders
constructor
Default constructor.
-
#is_valid ⇒ Boolean
(also: #valid?)
Returns true if at least one border is valid.
-
#remove_style(attr) ⇒ Boolean
Removes the specified attributes from this object.
-
#reset ⇒ void
Resets all borders.
- #set_colour(*args) ⇒ Object (also: #colour=)
-
#set_style(style) ⇒ void
(also: #style=)
Sets the style of all borders.
- #set_width(*args) ⇒ Object (also: #width=)
Constructor Details
#initialize ⇒ Wx::RTC::TextAttrBorders
Default constructor.
2428 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2428 def initialize; end |
Instance Method Details
#==(borders) ⇒ Boolean
Equality operator.
2433 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2433 def ==(borders) end |
#apply(borders, compareWith = nil) ⇒ Boolean
Applies border to this object, but not if the same as compareWith.
2480 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2480 def apply(borders, 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.
2492 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2492 def collect_common_attributes(attr, clashingAttr, absentAttr) end |
#eq_partial(borders, weakTest = true) ⇒ Boolean
Partial equality test.
If weakTest is true, attributes of this object do not have to be present if those attributes of borders are present. If weakTest is false, the function will fail if an attribute is present in borders but not in this object.
2474 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2474 def eq_partial(borders, weakTest=true) end |
#get_bottom ⇒ Wx::RTC::TextAttrBorder Also known as: bottom
Returns the bottom border.
2516 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2516 def get_bottom; end |
#get_left ⇒ Wx::RTC::TextAttrBorder Also known as: left
Returns the left border.
2501 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2501 def get_left; end |
#get_right ⇒ Wx::RTC::TextAttrBorder Also known as: right
Returns the right border.
2506 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2506 def get_right; end |
#get_top ⇒ Wx::RTC::TextAttrBorder Also known as: top
Returns the top border.
2511 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2511 def get_top; end |
#is_valid ⇒ Boolean Also known as: valid?
Returns true if at least one border is valid.
2496 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2496 def is_valid; end |
#remove_style(attr) ⇒ Boolean
Removes the specified attributes from this object.
2485 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2485 def remove_style(attr) end |
#reset ⇒ void
This method returns an undefined value.
Resets all borders.
2466 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2466 def reset; end |
#set_colour(colour) ⇒ void #set_colour(colour) ⇒ void Also known as: colour=
2449 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2449 def set_colour(*args) end |
#set_style(style) ⇒ void Also known as: style=
This method returns an undefined value.
Sets the style of all borders.
2438 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2438 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=
2461 |
# File 'lib/wx/doc/gen/rtc/rich_text_object.rb', line 2461 def set_width(*args) end |