API reference - Class QLocalSocket_LocalSocketState

Notation used in Ruby API documentation

Description: This class represents the QLocalSocket::LocalSocketState enum

Class hierarchy: QLocalSocket_LocalSocketState » QLocalSocket_QFlags_LocalSocketState

Public constructors

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

Public methods

[const]bool==(QLocalSocket_LocalSocketState 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 QLocalSocket_LocalSocketState 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]QLocalSocket_LocalSocketStatedupCreates 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 QLocalSocket_LocalSocketStateClosingStateEnum constant QLocalSocket::ClosingState
new QLocalSocket_LocalSocketStateConnectedStateEnum constant QLocalSocket::ConnectedState
new QLocalSocket_LocalSocketStateConnectingStateEnum constant QLocalSocket::ConnectingState
new QLocalSocket_LocalSocketStateUnconnectedStateEnum constant QLocalSocket::UnconnectedState

Detailed description

[const] bool ==(QLocalSocket_LocalSocketState 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 QLocalSocket_LocalSocketState ClosingState

Description: Enum constant QLocalSocket::ClosingState

[static] new QLocalSocket_LocalSocketState ConnectedState

Description: Enum constant QLocalSocket::ConnectedState

[static] new QLocalSocket_LocalSocketState ConnectingState

Description: Enum constant QLocalSocket::ConnectingState

[static] new QLocalSocket_LocalSocketState UnconnectedState

Description: Enum constant QLocalSocket::UnconnectedState

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