API reference - Class QFtp_Command

!=

(1) Signature: [const] bool != (const QFtp_Command other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const QFtp_Command other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const QFtp_Command other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

Cd

Signature: [static,const] QFtp_Command Cd

Description: Enum constant QFtp::Cd

Python specific notes:
The object exposes a readable attribute 'Cd'. This is the getter.

Close

Signature: [static,const] QFtp_Command Close

Description: Enum constant QFtp::Close

Python specific notes:
The object exposes a readable attribute 'Close'. This is the getter.

ConnectToHost

Signature: [static,const] QFtp_Command ConnectToHost

Description: Enum constant QFtp::ConnectToHost

Python specific notes:
The object exposes a readable attribute 'ConnectToHost'. This is the getter.

Get

Signature: [static,const] QFtp_Command Get

Description: Enum constant QFtp::Get

Python specific notes:
The object exposes a readable attribute 'Get'. This is the getter.

List

Signature: [static,const] QFtp_Command List

Description: Enum constant QFtp::List

Python specific notes:
The object exposes a readable attribute 'List'. This is the getter.

Login

Signature: [static,const] QFtp_Command Login

Description: Enum constant QFtp::Login

Python specific notes:
The object exposes a readable attribute 'Login'. This is the getter.

Mkdir

Signature: [static,const] QFtp_Command Mkdir

Description: Enum constant QFtp::Mkdir

Python specific notes:
The object exposes a readable attribute 'Mkdir'. This is the getter.

None

Signature: [static,const] QFtp_Command None

Description: Enum constant QFtp::None

Python specific notes:
This member is available as 'None_' in Python.
The object exposes a readable attribute 'None_'. This is the getter.

Put

Signature: [static,const] QFtp_Command Put

Description: Enum constant QFtp::Put

Python specific notes:
The object exposes a readable attribute 'Put'. This is the getter.

RawCommand

Signature: [static,const] QFtp_Command RawCommand

Description: Enum constant QFtp::RawCommand

Python specific notes:
The object exposes a readable attribute 'RawCommand'. This is the getter.

Remove

Signature: [static,const] QFtp_Command Remove

Description: Enum constant QFtp::Remove

Python specific notes:
The object exposes a readable attribute 'Remove'. This is the getter.

Rename

Signature: [static,const] QFtp_Command Rename

Description: Enum constant QFtp::Rename

Python specific notes:
The object exposes a readable attribute 'Rename'. This is the getter.

Rmdir

Signature: [static,const] QFtp_Command Rmdir

Description: Enum constant QFtp::Rmdir

Python specific notes:
The object exposes a readable attribute 'Rmdir'. This is the getter.

SetProxy

Signature: [static,const] QFtp_Command SetProxy

Description: Enum constant QFtp::SetProxy

Python specific notes:
The object exposes a readable attribute 'SetProxy'. This is the getter.

SetTransferMode

Signature: [static,const] QFtp_Command SetTransferMode

Description: Enum constant QFtp::SetTransferMode

Python specific notes:
The object exposes a readable attribute 'SetTransferMode'. This is the getter.

_const_cast

Signature: [const] QFtp_Command ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: 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.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [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.

_is_const_object?

Signature: [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.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QFtp_Command other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QFtp_Command ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

Python specific notes:
This method is also available as 'hash(object)'.

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new QFtp_Command ptr new (int i)

Description: Creates an enum from an integer value

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QFtp_Command ptr new (string s)

Description: Creates an enum from a string value

Python specific notes:
This method is the default initializer of the object.

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

Python specific notes:
This method is also available as 'int(object)'.

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.

|

(1) Signature: [const] QFtp_QFlags_Command | (const QFtp_Command other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] QFtp_QFlags_Command | (const QFtp_QFlags_Command other)

Description: Combines the flag and the flag set