API reference - Class QMainWindow_DockOption

Notation used in Ruby API documentation

Description: This class represents the QMainWindow::DockOption enum

Class hierarchy: QMainWindow_DockOption » QMainWindow_QFlags_DockOption

Public constructors

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

Public methods

[const]bool==(QMainWindow_DockOption 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 QMainWindow_DockOption 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]QMainWindow_DockOptiondupCreates 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 QMainWindow_DockOptionAllowNestedDocksEnum constant QMainWindow::AllowNestedDocks
new QMainWindow_DockOptionAllowTabbedDocksEnum constant QMainWindow::AllowTabbedDocks
new QMainWindow_DockOptionAnimatedDocksEnum constant QMainWindow::AnimatedDocks
new QMainWindow_DockOptionForceTabbedDocksEnum constant QMainWindow::ForceTabbedDocks
new QMainWindow_DockOptionVerticalTabsEnum constant QMainWindow::VerticalTabs

Detailed description

[const] bool ==(QMainWindow_DockOption 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 QMainWindow_DockOption AllowNestedDocks

Description: Enum constant QMainWindow::AllowNestedDocks

[static] new QMainWindow_DockOption AllowTabbedDocks

Description: Enum constant QMainWindow::AllowTabbedDocks

[static] new QMainWindow_DockOption AnimatedDocks

Description: Enum constant QMainWindow::AnimatedDocks

[static] new QMainWindow_DockOption ForceTabbedDocks

Description: Enum constant QMainWindow::ForceTabbedDocks

[static] new QMainWindow_DockOption VerticalTabs

Description: Enum constant QMainWindow::VerticalTabs

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