API reference - Class QTextOption_Flag

Notation used in Ruby API documentation

Description: This class represents the QTextOption::Flag enum

Class hierarchy: QTextOption_Flag » QTextOption_QFlags_Flag

Public constructors

new QTextOption_Flagnew(unsigned int value)Creates the enum object from an integer

Public methods

[const]bool==(QTextOption_Flag 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 QTextOption_Flag 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]QTextOption_FlagdupCreates 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 QTextOption_FlagAddSpaceForLineAndParagraphSeparatorsEnum constant QTextOption::AddSpaceForLineAndParagraphSeparators
new QTextOption_FlagIncludeTrailingSpacesEnum constant QTextOption::IncludeTrailingSpaces
new QTextOption_FlagShowLineAndParagraphSeparatorsEnum constant QTextOption::ShowLineAndParagraphSeparators
new QTextOption_FlagShowTabsAndSpacesEnum constant QTextOption::ShowTabsAndSpaces
new QTextOption_FlagSuppressColorsEnum constant QTextOption::SuppressColors

Detailed description

[const] bool ==(QTextOption_Flag 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 QTextOption_Flag AddSpaceForLineAndParagraphSeparators

Description: Enum constant QTextOption::AddSpaceForLineAndParagraphSeparators

[static] new QTextOption_Flag IncludeTrailingSpaces

Description: Enum constant QTextOption::IncludeTrailingSpaces

[static] new QTextOption_Flag ShowLineAndParagraphSeparators

Description: Enum constant QTextOption::ShowLineAndParagraphSeparators

[static] new QTextOption_Flag ShowTabsAndSpaces

Description: Enum constant QTextOption::ShowTabsAndSpaces

[static] new QTextOption_Flag SuppressColors

Description: Enum constant QTextOption::SuppressColors

[const] void assign(const QTextOption_Flag 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] QTextOption_Flag 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 QTextOption_Flag new(unsigned int value)

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