API reference - Class QTextCharFormat_UnderlineStyle

Notation used in Ruby API documentation

Description: This class represents the QTextCharFormat::UnderlineStyle enum

Class hierarchy: QTextCharFormat_UnderlineStyle » QTextCharFormat_QFlags_UnderlineStyle

This class is equivalent to the top-level class QTextCharFormat::UnderlineStyle

Public constructors

new QTextCharFormat_UnderlineStyle ptrnew(unsigned int value)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
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const QTextCharFormat_UnderlineStyle other)Assigns another object to self
[const]new QTextCharFormat_UnderlineStyle ptrdupCreates a copy of self
[const]stringinspectConverts the enum class to a string
[const]unsigned intto_iConverts the enum class to an integer
[const]stringto_sConverts the enum class to a string

Public static methods and constants

[static,const]new QTextCharFormat_UnderlineStyle ptrDashDotDotLineEnum constant QTextCharFormat::DashDotDotLine
[static,const]new QTextCharFormat_UnderlineStyle ptrDashDotLineEnum constant QTextCharFormat::DashDotLine
[static,const]new QTextCharFormat_UnderlineStyle ptrDashUnderlineEnum constant QTextCharFormat::DashUnderline
[static,const]new QTextCharFormat_UnderlineStyle ptrDotLineEnum constant QTextCharFormat::DotLine
[static,const]new QTextCharFormat_UnderlineStyle ptrNoUnderlineEnum constant QTextCharFormat::NoUnderline
[static,const]new QTextCharFormat_UnderlineStyle ptrSingleUnderlineEnum constant QTextCharFormat::SingleUnderline
[static,const]new QTextCharFormat_UnderlineStyle ptrSpellCheckUnderlineEnum constant QTextCharFormat::SpellCheckUnderline
[static,const]new QTextCharFormat_UnderlineStyle ptrWaveUnderlineEnum constant QTextCharFormat::WaveUnderline

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

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,const] new QTextCharFormat_UnderlineStyle ptr DashDotDotLine

Description: Enum constant QTextCharFormat::DashDotDotLine

[static,const] new QTextCharFormat_UnderlineStyle ptr DashDotLine

Description: Enum constant QTextCharFormat::DashDotLine

[static,const] new QTextCharFormat_UnderlineStyle ptr DashUnderline

Description: Enum constant QTextCharFormat::DashUnderline

[static,const] new QTextCharFormat_UnderlineStyle ptr DotLine

Description: Enum constant QTextCharFormat::DotLine

[static,const] new QTextCharFormat_UnderlineStyle ptr NoUnderline

Description: Enum constant QTextCharFormat::NoUnderline

[static,const] new QTextCharFormat_UnderlineStyle ptr SingleUnderline

Description: Enum constant QTextCharFormat::SingleUnderline

[static,const] new QTextCharFormat_UnderlineStyle ptr SpellCheckUnderline

Description: Enum constant QTextCharFormat::SpellCheckUnderline

[static,const] new QTextCharFormat_UnderlineStyle ptr WaveUnderline

Description: Enum constant QTextCharFormat::WaveUnderline

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 destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, 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] 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.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

void assign(const QTextCharFormat_UnderlineStyle other)

Description: Assigns another object to self

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] new QTextCharFormat_UnderlineStyle ptr dup

Description: Creates a copy of self

[const] string inspect

Description: Converts the enum class to a string

Python specific notes:

This method is also available as 'str(object)'

This method is also available as 'repr(object)'

[const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

[static] new QTextCharFormat_UnderlineStyle ptr new(unsigned int value)

Description: Creates the enum object from an integer

Python specific notes:

This method is the default initializer of the object

[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

Python specific notes:

This method is also available as 'str(object)'

This method is also available as 'repr(object)'