KLayout Manual: Main Index » Class Index » API reference - Class QFtp_State

API reference - Class QFtp_State

Notation used in Ruby API documentation

Description: This class represents the QFtp::State enum

Public constructors

new QFtp_Statenew(unsigned int arg1)Creates the enum object from an integer

Public methods

[const]bool==(QFtp_State 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 QFtp_State 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]QFtp_StatedupCreates 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 QFtp_StateClosingEnum constant QFtp::Closing
new QFtp_StateConnectedEnum constant QFtp::Connected
new QFtp_StateConnectingEnum constant QFtp::Connecting
new QFtp_StateHostLookupEnum constant QFtp::HostLookup
new QFtp_StateLoggedInEnum constant QFtp::LoggedIn
new QFtp_StateUnconnectedEnum constant QFtp::Unconnected

Detailed description

[const] bool ==(QFtp_State 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 QFtp_State Closing

Description: Enum constant QFtp::Closing

[static] new QFtp_State Connected

Description: Enum constant QFtp::Connected

[static] new QFtp_State Connecting

Description: Enum constant QFtp::Connecting

[static] new QFtp_State HostLookup

Description: Enum constant QFtp::HostLookup

[static] new QFtp_State LoggedIn

Description: Enum constant QFtp::LoggedIn

[static] new QFtp_State Unconnected

Description: Enum constant QFtp::Unconnected

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

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