Class: Wx::RTC::TextAttrDimension

Inherits:
Object
  • Object
show all
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 dimension, including units and position.

Category: Rich Text

See Also:

Requires:

  • USE_RICHTEXT

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::RTC::TextAttrDimension #initialize(value, units = Wx::RTC::TextAttrUnits::TEXT_ATTR_UNITS_TENTHS_MM) ⇒ Wx::RTC::TextAttrDimension

Returns a new instance of TextAttrDimension.

Overloads:

  • #initialize ⇒ Wx::RTC::TextAttrDimension

    Default constructor.

  • #initialize(value, units = Wx::RTC::TextAttrUnits::TEXT_ATTR_UNITS_TENTHS_MM) ⇒ Wx::RTC::TextAttrDimension

    Constructor taking value and units flag.

    Parameters:

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


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

def initialize(*args) end

Instance Method Details

#==(dim) ⇒ Boolean

Equality operator.

Parameters:

Returns:

  • (Boolean) 


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

def ==(dim) end

#apply(dim, compareWith = nil) ⇒ Boolean

Apply the dimension, but not those identical to compareWith if present.

Parameters:

Returns:

  • (Boolean) 


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

def apply(dim, 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:



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

def collect_common_attributes(attr, clashingAttr, absentAttr) end

#eq_partial(dim, weakTest = true) ⇒ Boolean

Partial equality test.

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

Parameters:

Returns:

  • (Boolean) 


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

def eq_partial(dim, weakTest=true) end

#get_flags ⇒ Wx::TextAttrDimensionFlags Also known as: flags

Gets the dimension flags.

Returns:

  • (Wx::TextAttrDimensionFlags) 


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

def get_flags; end

#get_position ⇒ Wx::TextBoxAttrPosition Also known as: position

Gets the position flags.

Returns:

  • (Wx::TextBoxAttrPosition) 


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

def get_position; end

#get_units ⇒ Wx::TextAttrUnits Also known as: units

Gets the units of the dimension.

Returns:

  • (Wx::TextAttrUnits) 


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

def get_units; end

#get_value ⇒ Integer Also known as: value

Returns the integer value of the dimension.

Returns:

  • (Integer) 


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

def get_value; end

#get_value_mm ⇒ Float Also known as: value_mm

Returns the floating-pointing value of the dimension in mm.

Returns:

  • (Float) 


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

def get_value_mm; end

#is_valid ⇒ Boolean Also known as: valid?

Returns true if the dimension is valid.

Returns:

  • (Boolean) 


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

def is_valid; end

#reset ⇒ void

This method returns an undefined value.

Resets the dimension value and flags.



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

def reset; end

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

This method returns an undefined value.

Sets the dimension flags.

Parameters:

  • flags (Wx::TextAttrDimensionFlags) 


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

def set_flags(flags) end

#set_position(pos) ⇒ void Also known as: position=

This method returns an undefined value.

Sets the position flags.

Parameters:

  • pos (Wx::TextBoxAttrPosition) 


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

def set_position(pos) end

#set_units(units) ⇒ void Also known as: units=

This method returns an undefined value.

Sets the units of the dimension.

Parameters:

  • units (Wx::TextAttrUnits) 


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

def set_units(units) end

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

This method returns an undefined value.

Sets the valid flag.

Parameters:

  • b (Boolean) 


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

def set_valid(b) end

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

Overloads:

  • #set_value(value) ⇒ void

    This method returns an undefined value.

    Sets the integer value of the dimension.

    Parameters:

    • value (Integer)
  • #set_value(value, flags) ⇒ void

    This method returns an undefined value.

    Sets the integer value of the dimension, passing dimension flags.

    Parameters:

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

    This method returns an undefined value.

    Sets the integer value and units.

    Parameters:

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

    This method returns an undefined value.

    Sets the dimension.

    Parameters:



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

def set_value(*args) end

#set_value_mm(value) ⇒ void Also known as: value_mm=

This method returns an undefined value.

Sets the value of the dimension in mm.

Parameters:

  • value (Float) 


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

def set_value_mm(value) end