API reference - Class QFtp

Active

Signature: [static,const] QFtp_TransferMode Active

Description: Enum constant QFtp::Active

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

Ascii

Signature: [static,const] QFtp_TransferType Ascii

Description: Enum constant QFtp::Ascii

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

Binary

Signature: [static,const] QFtp_TransferType Binary

Description: Enum constant QFtp::Binary

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

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.

Closing

Signature: [static,const] QFtp_State Closing

Description: Enum constant QFtp::Closing

Python specific notes:
The object exposes a readable attribute 'Closing'. 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.

Connected

Signature: [static,const] QFtp_State Connected

Description: Enum constant QFtp::Connected

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

Connecting

Signature: [static,const] QFtp_State Connecting

Description: Enum constant QFtp::Connecting

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

ConnectionRefused

Signature: [static,const] QFtp_Error ConnectionRefused

Description: Enum constant QFtp::ConnectionRefused

Python specific notes:
The object exposes a readable attribute 'ConnectionRefused'. 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.

HostLookup

Signature: [static,const] QFtp_State HostLookup

Description: Enum constant QFtp::HostLookup

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

HostNotFound

Signature: [static,const] QFtp_Error HostNotFound

Description: Enum constant QFtp::HostNotFound

Python specific notes:
The object exposes a readable attribute 'HostNotFound'. 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.

LoggedIn

Signature: [static,const] QFtp_State LoggedIn

Description: Enum constant QFtp::LoggedIn

Python specific notes:
The object exposes a readable attribute 'LoggedIn'. 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.

NoError

Signature: [static,const] QFtp_Error NoError

Description: Enum constant QFtp::NoError

Python specific notes:
The object exposes a readable attribute 'NoError'. 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.

NotConnected

Signature: [static,const] QFtp_Error NotConnected

Description: Enum constant QFtp::NotConnected

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

Passive

Signature: [static,const] QFtp_TransferMode Passive

Description: Enum constant QFtp::Passive

Python specific notes:
The object exposes a readable attribute 'Passive'. 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.

Unconnected

Signature: [static,const] QFtp_State Unconnected

Description: Enum constant QFtp::Unconnected

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

UnknownError

Signature: [static,const] QFtp_Error UnknownError

Description: Enum constant QFtp::UnknownError

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

_const_cast

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

abort

Signature: void abort

Description: Method void QFtp::abort()

bytesAvailable

Signature: [const] long long bytesAvailable

Description: Method qint64 QFtp::bytesAvailable()

cd

Signature: int cd (string dir)

Description: Method int QFtp::cd(const QString &dir)

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QFtp::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

clearPendingCommands

Signature: void clearPendingCommands

Description: Method void QFtp::clearPendingCommands()

close

Signature: int close

Description: Method int QFtp::close()

commandFinished

Signature: [signal] void commandFinished (int arg1, bool arg2)

Description: Signal declaration for QFtp::commandFinished(int, bool)

You can bind a procedure to this signal.

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

commandStarted

Signature: [signal] void commandStarted (int arg1)

Description: Signal declaration for QFtp::commandStarted(int)

You can bind a procedure to this signal.

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

connectToHost

Signature: int connectToHost (string host, unsigned short port = 21)

Description: Method int QFtp::connectToHost(const QString &host, quint16 port)

currentCommand

Signature: [const] QFtp_Command currentCommand

Description: Method QFtp::Command QFtp::currentCommand()

currentDevice

Signature: [const] QIODevice ptr currentDevice

Description: Method QIODevice *QFtp::currentDevice()

currentId

Signature: [const] int currentId

Description: Method int QFtp::currentId()

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QFtp::customEvent(QEvent *)

This method can be reimplemented in a derived class.

dataTransferProgress

Signature: [signal] void dataTransferProgress (long long arg1, long long arg2)

Description: Signal declaration for QFtp::dataTransferProgress(qint64, qint64)

You can bind a procedure to this signal.

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

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QFtp::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (string signal)

Description: Virtual method void QFtp::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

done

Signature: [signal] void done (bool arg1)

Description: Signal declaration for QFtp::done(bool)

You can bind a procedure to this signal.

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

emit_commandFinished

Signature: void emit_commandFinished (int arg1, bool arg2)

Description: Emitter for signal void QFtp::commandFinished(int, bool)

Call this method to emit this signal.

emit_commandStarted

Signature: void emit_commandStarted (int arg1)

Description: Emitter for signal void QFtp::commandStarted(int)

Call this method to emit this signal.

emit_dataTransferProgress

Signature: void emit_dataTransferProgress (long long arg1, long long arg2)

Description: Emitter for signal void QFtp::dataTransferProgress(qint64, qint64)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

Description: Emitter for signal void QFtp::destroyed(QObject *)

Call this method to emit this signal.

emit_done

Signature: void emit_done (bool arg1)

Description: Emitter for signal void QFtp::done(bool)

Call this method to emit this signal.

emit_listInfo

Signature: void emit_listInfo (const QUrlInfo arg1)

Description: Emitter for signal void QFtp::listInfo(const QUrlInfo &)

Call this method to emit this signal.

emit_rawCommandReply

Signature: void emit_rawCommandReply (int arg1, string arg2)

Description: Emitter for signal void QFtp::rawCommandReply(int, const QString &)

Call this method to emit this signal.

emit_readyRead

Signature: void emit_readyRead

Description: Emitter for signal void QFtp::readyRead()

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (int arg1)

Description: Emitter for signal void QFtp::stateChanged(int)

Call this method to emit this signal.

error

Signature: [const] QFtp_Error error

Description: Method QFtp::Error QFtp::error()

errorString

Signature: [const] string errorString

Description: Method QString QFtp::errorString()

event

Signature: bool event (QEvent ptr arg1)

Description: Virtual method bool QFtp::event(QEvent *)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QFtp::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

get

Signature: int get (string file, QIODevice ptr dev = 0, const QFtp_TransferType type = QFtp::Binary)

Description: Method int QFtp::get(const QString &file, QIODevice *dev, QFtp::TransferType type)

hasPendingCommands

Signature: [const] bool hasPendingCommands

Description: Method bool QFtp::hasPendingCommands()

list

Signature: int list (string dir = QString())

Description: Method int QFtp::list(const QString &dir)

listInfo

Signature: [signal] void listInfo (const QUrlInfo arg1)

Description: Signal declaration for QFtp::listInfo(const QUrlInfo &)

You can bind a procedure to this signal.

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

login

Signature: int login (string user = QString(), string password = QString())

Description: Method int QFtp::login(const QString &user, const QString &password)

mkdir

Signature: int mkdir (string dir)

Description: Method int QFtp::mkdir(const QString &dir)

new

Signature: [static] new QFtp new (QObject ptr parent = 0)

Description: Constructor QFtp::QFtp(QObject *parent)

This method creates an object of class QFtp.

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

put

(1) Signature: int put (bytes data, string file, const QFtp_TransferType type = QFtp::Binary)

Description: Method int QFtp::put(const QByteArray &data, const QString &file, QFtp::TransferType type)

(2) Signature: int put (QIODevice ptr dev, string file, const QFtp_TransferType type = QFtp::Binary)

Description: Method int QFtp::put(QIODevice *dev, const QString &file, QFtp::TransferType type)

rawCommand

Signature: int rawCommand (string command)

Description: Method int QFtp::rawCommand(const QString &command)

rawCommandReply

Signature: [signal] void rawCommandReply (int arg1, string arg2)

Description: Signal declaration for QFtp::rawCommandReply(int, const QString &)

You can bind a procedure to this signal.

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

readAll

Signature: bytes readAll

Description: Method QByteArray QFtp::readAll()

readyRead

Signature: [signal] void readyRead

Description: Signal declaration for QFtp::readyRead()

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QFtp::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

remove

Signature: int remove (string file)

Description: Method int QFtp::remove(const QString &file)

rename

Signature: int rename (string oldname, string newname)

Description: Method int QFtp::rename(const QString &oldname, const QString &newname)

rmdir

Signature: int rmdir (string dir)

Description: Method int QFtp::rmdir(const QString &dir)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QFtp::sender()

This method is protected and can only be called from inside a derived class.

setProxy

Signature: int setProxy (string host, unsigned short port)

Description: Method int QFtp::setProxy(const QString &host, quint16 port)

setTransferMode

Signature: int setTransferMode (const QFtp_TransferMode mode)

Description: Method int QFtp::setTransferMode(QFtp::TransferMode mode)

state

Signature: [const] QFtp_State state

Description: Method QFtp::State QFtp::state()

stateChanged

Signature: [signal] void stateChanged (int arg1)

Description: Signal declaration for QFtp::stateChanged(int)

You can bind a procedure to this signal.

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QFtp::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

tr

(1) Signature: [static] string tr (string s, string c = 0)

Description: Static method QString QFtp::tr(const char *s, const char *c)

This method is static and can be called without an instance.

(2) Signature: [static] string tr (string s, string c, int n)

Description: Static method QString QFtp::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

(1) Signature: [static] string trUtf8 (string s, string c = 0)

Description: Static method QString QFtp::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

(2) Signature: [static] string trUtf8 (string s, string c, int n)

Description: Static method QString QFtp::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.