Class: Wx::RTC::TextAttrShadow

Inherits:

Object

• Object
• Wx::RTC::TextAttrShadow

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 shadow.

Category: Rich Text

See Also:

• RichTextAttr
• RichTextCtrl

Requires:

• USE_RICHTEXT

Instance Method Summary

• #==(shadow) ⇒ Boolean

  Equality operator.

• #add_flag(flag) ⇒ void

  Adds a border flag.

• #apply(shadow, 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(shadow, weakTest = true) ⇒ Boolean

  Partial equality test.

• #get_blur_distance ⇒ Wx::RTC::TextAttrDimension (also: #blur_distance)
• #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_offset_x ⇒ Wx::RTC::TextAttrDimension (also: #offset_x)
• #get_offset_y ⇒ Wx::RTC::TextAttrDimension (also: #offset_y)
• #get_opacity ⇒ Wx::RTC::TextAttrDimension (also: #opacity)
• #get_spread ⇒ Wx::RTC::TextAttrDimension (also: #spread)
• #has_colour ⇒ Boolean (also: #has_colour?)

  True if the shadow has a valid colour.

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

  Default constructor.

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

  True if the shadow has no attributes set.

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

  Returns true if the dimension is valid.

• #remove_flag(flag) ⇒ void

  Removes a border flag.

• #remove_style(attr) ⇒ Boolean

  Removes the specified attributes from this object.

• #reset ⇒ void

  Resets the shadow.

• #set_blur_distance(blur) ⇒ void (also: #blur_distance=)

  Sets the shadow blur distance.

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

  Sets the border flags.

• #set_offset_x(offset) ⇒ void (also: #offset_x=)

  Sets the shadow horizontal offset.

• #set_offset_y(offset) ⇒ void (also: #offset_y=)

  Sets the shadow vertical offset.

• #set_opacity(opacity) ⇒ void (also: #opacity=)

  Sets the shadow opacity.

• #set_spread(spread) ⇒ void (also: #spread=)

  Sets the shadow spread size.

• #set_valid(b) ⇒ void (also: #valid=)

  Sets the valid flag.

Constructor Details

#initialize ⇒ Wx::RTC::TextAttrShadow

Default constructor.

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

def initialize; end

Instance Method Details

#==(shadow) ⇒ Boolean

Equality operator.

Parameters:

• shadow (Wx::RTC::TextAttrShadow)

Returns:

• (Boolean)

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

def ==(shadow) 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 2245

def add_flag(flag) end

#apply(shadow, compareWith = nil) ⇒ Boolean

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

Parameters:

• shadow (Wx::RTC::TextAttrShadow)
• compareWith (Wx::RTC::TextAttrShadow) (defaults to: nil)

Returns:

• (Boolean)

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

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

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

def collect_common_attributes(attr, clashingAttr, absentAttr) end

#eq_partial(shadow, 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:

• shadow (Wx::RTC::TextAttrShadow)
• weakTest (Boolean) (defaults to: true)

Returns:

• (Boolean)

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

def eq_partial(shadow, weakTest=true) end

#get_blur_distance ⇒ Wx::RTC::TextAttrDimension Also known as: blur_distance

Returns:

• (Wx::RTC::TextAttrDimension)

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

def get_blur_distance; 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 2168

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 2163

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 2233

def get_flags; end

#get_offset_x ⇒ Wx::RTC::TextAttrDimension Also known as: offset_x

Returns:

• (Wx::RTC::TextAttrDimension)

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

def get_offset_x; end

#get_offset_y ⇒ Wx::RTC::TextAttrDimension Also known as: offset_y

Returns:

• (Wx::RTC::TextAttrDimension)

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

def get_offset_y; end

#get_opacity ⇒ Wx::RTC::TextAttrDimension Also known as: opacity

Returns:

• (Wx::RTC::TextAttrDimension)

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

def get_opacity; end

#get_spread ⇒ Wx::RTC::TextAttrDimension Also known as: spread

Returns:

• (Wx::RTC::TextAttrDimension)

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

def get_spread; end

#has_colour ⇒ Boolean Also known as: has_colour?

True if the shadow has a valid colour.

Returns:

• (Boolean)

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

def has_colour; end

#is_default ⇒ Boolean Also known as: default?

True if the shadow has no attributes set.

Returns:

• (Boolean)

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

def is_default; end

#is_valid ⇒ Boolean Also known as: valid?

Returns true if the dimension is valid.

Returns:

• (Boolean)

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

def is_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 2250

def remove_flag(flag) end

#remove_style(attr) ⇒ Boolean

Removes the specified attributes from this object.

Parameters:

• attr (Wx::RTC::TextAttrShadow)

Returns:

• (Boolean)

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

def remove_style(attr) end

#reset ⇒ void

This method returns an undefined value.

Resets the shadow.

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

def reset; end

#set_blur_distance(blur) ⇒ void Also known as: blur_distance=

This method returns an undefined value.

Sets the shadow blur distance.

Parameters:

• blur (Wx::RTC::TextAttrDimension)

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

def set_blur_distance(blur) 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 shadow colour.

  Parameters:

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

  This method returns an undefined value.

  Sets the shadow colour.

  Parameters:

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

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

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 2239

def set_flags(flags) end

#set_offset_x(offset) ⇒ void Also known as: offset_x=

This method returns an undefined value.

Sets the shadow horizontal offset.

Parameters:

• offset (Wx::RTC::TextAttrDimension)

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

def set_offset_x(offset) end

#set_offset_y(offset) ⇒ void Also known as: offset_y=

This method returns an undefined value.

Sets the shadow vertical offset.

Parameters:

• offset (Wx::RTC::TextAttrDimension)

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

def set_offset_y(offset) end

#set_opacity(opacity) ⇒ void Also known as: opacity=

This method returns an undefined value.

Sets the shadow opacity.

Parameters:

• opacity (Wx::RTC::TextAttrDimension)

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

def set_opacity(opacity) end

#set_spread(spread) ⇒ void Also known as: spread=

This method returns an undefined value.

Sets the shadow spread size.

Parameters:

• spread (Wx::RTC::TextAttrDimension)

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

def set_spread(spread) end

#set_valid(b) ⇒ void Also known as: valid=

This method returns an undefined value.

Sets the valid flag.

Parameters:

• b (Boolean)

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

def set_valid(b) end