API reference - Class QFrame_Shape

Notation used in Ruby API documentation

Description: This class represents the QFrame::Shape enum

Class hierarchy: QFrame_Shape » QFrame_QFlags_Shape

Public constructors

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

Public methods

[const]bool==(QFrame_Shape 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 QFrame_Shape 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]QFrame_ShapedupCreates 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 QFrame_ShapeBoxEnum constant QFrame::Box
new QFrame_ShapeHLineEnum constant QFrame::HLine
new QFrame_ShapeNoFrameEnum constant QFrame::NoFrame
new QFrame_ShapePanelEnum constant QFrame::Panel
new QFrame_ShapeStyledPanelEnum constant QFrame::StyledPanel
new QFrame_ShapeVLineEnum constant QFrame::VLine
new QFrame_ShapeWinPanelEnum constant QFrame::WinPanel

Detailed description

[const] bool ==(QFrame_Shape 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 QFrame_Shape Box

Description: Enum constant QFrame::Box

[static] new QFrame_Shape HLine

Description: Enum constant QFrame::HLine

[static] new QFrame_Shape NoFrame

Description: Enum constant QFrame::NoFrame

[static] new QFrame_Shape Panel

Description: Enum constant QFrame::Panel

[static] new QFrame_Shape StyledPanel

Description: Enum constant QFrame::StyledPanel

[static] new QFrame_Shape VLine

Description: Enum constant QFrame::VLine

[static] new QFrame_Shape WinPanel

Description: Enum constant QFrame::WinPanel

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