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

API reference - Class QFtp_Command

Notation used in Ruby API documentation

Description: This class represents the QFtp::Command enum

Public constructors

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

Public methods

[const]bool==(QFtp_Command 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_Command 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_CommanddupCreates 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_CommandCdEnum constant QFtp::Cd
new QFtp_CommandCloseEnum constant QFtp::Close
new QFtp_CommandConnectToHostEnum constant QFtp::ConnectToHost
new QFtp_CommandGetEnum constant QFtp::Get
new QFtp_CommandListEnum constant QFtp::List
new QFtp_CommandLoginEnum constant QFtp::Login
new QFtp_CommandMkdirEnum constant QFtp::Mkdir
new QFtp_CommandNoneEnum constant QFtp::None
new QFtp_CommandPutEnum constant QFtp::Put
new QFtp_CommandRawCommandEnum constant QFtp::RawCommand
new QFtp_CommandRemoveEnum constant QFtp::Remove
new QFtp_CommandRenameEnum constant QFtp::Rename
new QFtp_CommandRmdirEnum constant QFtp::Rmdir
new QFtp_CommandSetProxyEnum constant QFtp::SetProxy
new QFtp_CommandSetTransferModeEnum constant QFtp::SetTransferMode

Detailed description

[const] bool ==(QFtp_Command 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_Command Cd

Description: Enum constant QFtp::Cd

[static] new QFtp_Command Close

Description: Enum constant QFtp::Close

[static] new QFtp_Command ConnectToHost

Description: Enum constant QFtp::ConnectToHost

[static] new QFtp_Command Get

Description: Enum constant QFtp::Get

[static] new QFtp_Command List

Description: Enum constant QFtp::List

[static] new QFtp_Command Login

Description: Enum constant QFtp::Login

[static] new QFtp_Command Mkdir

Description: Enum constant QFtp::Mkdir

[static] new QFtp_Command None

Description: Enum constant QFtp::None

[static] new QFtp_Command Put

Description: Enum constant QFtp::Put

[static] new QFtp_Command RawCommand

Description: Enum constant QFtp::RawCommand

[static] new QFtp_Command Remove

Description: Enum constant QFtp::Remove

[static] new QFtp_Command Rename

Description: Enum constant QFtp::Rename

[static] new QFtp_Command Rmdir

Description: Enum constant QFtp::Rmdir

[static] new QFtp_Command SetProxy

Description: Enum constant QFtp::SetProxy

[static] new QFtp_Command SetTransferMode

Description: Enum constant QFtp::SetTransferMode

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