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

API reference - Class QTextCharFormat_UnderlineStyle

Notation used in Ruby API documentation

Description: This class represents the QTextCharFormat::UnderlineStyle enum

Public constructors

new QTextCharFormat_UnderlineStylenew(unsigned int arg1)Creates the enum object from an integer

Public methods

[const]bool==(QTextCharFormat_UnderlineStyle other)Compares the enum class against an enum of it's own type
[const]bool==(unsigned int other)Compares the enum class against an integer
[const]voidassign(const QTextCharFormat_UnderlineStyle 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]QTextCharFormat_UnderlineStyledupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]unsigned intto_iConverts the enum class to an integer
[const]stringto_sConverts the enum class to a string

Public static methods and constants

new QTextCharFormat_UnderlineStyleDashDotDotLineEnum constant QTextCharFormat::DashDotDotLine
new QTextCharFormat_UnderlineStyleDashDotLineEnum constant QTextCharFormat::DashDotLine
new QTextCharFormat_UnderlineStyleDashUnderlineEnum constant QTextCharFormat::DashUnderline
new QTextCharFormat_UnderlineStyleDotLineEnum constant QTextCharFormat::DotLine
new QTextCharFormat_UnderlineStyleNoUnderlineEnum constant QTextCharFormat::NoUnderline
new QTextCharFormat_UnderlineStyleSingleUnderlineEnum constant QTextCharFormat::SingleUnderline
new QTextCharFormat_UnderlineStyleSpellCheckUnderlineEnum constant QTextCharFormat::SpellCheckUnderline
new QTextCharFormat_UnderlineStyleWaveUnderlineEnum constant QTextCharFormat::WaveUnderline

Detailed description

[const] bool ==(QTextCharFormat_UnderlineStyle other)

Description: Compares the enum class against an enum of it's own type

[const] bool ==(unsigned int other)

Description: Compares the enum class against an integer

[static] new QTextCharFormat_UnderlineStyle DashDotDotLine

Description: Enum constant QTextCharFormat::DashDotDotLine

[static] new QTextCharFormat_UnderlineStyle DashDotLine

Description: Enum constant QTextCharFormat::DashDotLine

[static] new QTextCharFormat_UnderlineStyle DashUnderline

Description: Enum constant QTextCharFormat::DashUnderline

[static] new QTextCharFormat_UnderlineStyle DotLine

Description: Enum constant QTextCharFormat::DotLine

[static] new QTextCharFormat_UnderlineStyle NoUnderline

Description: Enum constant QTextCharFormat::NoUnderline

[static] new QTextCharFormat_UnderlineStyle SingleUnderline

Description: Enum constant QTextCharFormat::SingleUnderline

[static] new QTextCharFormat_UnderlineStyle SpellCheckUnderline

Description: Enum constant QTextCharFormat::SpellCheckUnderline

[static] new QTextCharFormat_UnderlineStyle WaveUnderline

Description: Enum constant QTextCharFormat::WaveUnderline

[const] void assign(const QTextCharFormat_UnderlineStyle 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] QTextCharFormat_UnderlineStyle dup

Description: Creates a copy of self

[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 QTextCharFormat_UnderlineStyle new(unsigned int arg1)

Description: Creates the enum object from an integer

[const] unsigned int to_i

Description: Converts the enum class to an integer

[const] string to_s

Description: Converts the enum class to a string