API reference - Class Qt_DockWidgetArea

Notation used in Ruby API documentation

Description: This class represents the Qt::DockWidgetArea enum

Class hierarchy: Qt_DockWidgetArea » Qt_QFlags_DockWidgetArea

Public constructors

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

Public methods

[const]bool==(Qt_DockWidgetArea 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 Qt_DockWidgetArea 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]Qt_DockWidgetAreadupCreates 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 Qt_DockWidgetAreaAllDockWidgetAreasEnum constant Qt::AllDockWidgetAreas
new Qt_DockWidgetAreaBottomDockWidgetAreaEnum constant Qt::BottomDockWidgetArea
new Qt_DockWidgetAreaDockWidgetArea_MaskEnum constant Qt::DockWidgetArea_Mask
new Qt_DockWidgetAreaLeftDockWidgetAreaEnum constant Qt::LeftDockWidgetArea
new Qt_DockWidgetAreaNoDockWidgetAreaEnum constant Qt::NoDockWidgetArea
new Qt_DockWidgetAreaRightDockWidgetAreaEnum constant Qt::RightDockWidgetArea
new Qt_DockWidgetAreaTopDockWidgetAreaEnum constant Qt::TopDockWidgetArea

Detailed description

[const] bool ==(Qt_DockWidgetArea 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 Qt_DockWidgetArea AllDockWidgetAreas

Description: Enum constant Qt::AllDockWidgetAreas

[static] new Qt_DockWidgetArea BottomDockWidgetArea

Description: Enum constant Qt::BottomDockWidgetArea

[static] new Qt_DockWidgetArea DockWidgetArea_Mask

Description: Enum constant Qt::DockWidgetArea_Mask

[static] new Qt_DockWidgetArea LeftDockWidgetArea

Description: Enum constant Qt::LeftDockWidgetArea

[static] new Qt_DockWidgetArea NoDockWidgetArea

Description: Enum constant Qt::NoDockWidgetArea

[static] new Qt_DockWidgetArea RightDockWidgetArea

Description: Enum constant Qt::RightDockWidgetArea

[static] new Qt_DockWidgetArea TopDockWidgetArea

Description: Enum constant Qt::TopDockWidgetArea

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