KLayout Manual: Main Index » Class Index » API reference - Class QDoubleColorPair

API reference - Class QDoubleColorPair

Notation used in Ruby API documentation

Description: Represents a QPair<double, QColor>

n

Public constructors

new QDoubleColorPairnewCreates a new pair
new QDoubleColorPairnew(double first,
const QColor second)
Creates a new pair from the given arguments

Public methods

[const]bool==(const QDoubleColorPair other)Returns true if self is equal to the other pair
[const]voidassign(const QDoubleColorPair other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QDoubleColorPairdupCreates a copy of self
[const]doublefirstReturns the first element of the pair
voidfirst=(double first)Sets the first element of the pair
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]QColorsecondReturns the second element of the pair
voidsecond=(const QColor second)Sets the second element of the pair

Detailed description

[const] bool ==(const QDoubleColorPair other)

Description: Returns true if self is equal to the other pair

[const] void assign(const QDoubleColorPair other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] QDoubleColorPair dup

Description: Creates a copy of self

[const] double first

Description: Returns the first element of the pair

void first=(double first)

Description: Sets the first element of the pair

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[static] new QDoubleColorPair new

Description: Creates a new pair

[static] new QDoubleColorPair new(double first,const QColor second)

Description: Creates a new pair from the given arguments

[const] QColor second

Description: Returns the second element of the pair

void second=(const QColor second)

Description: Sets the second element of the pair