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

API reference - Class QFtp

Notation used in Ruby API documentation

Description: Binding of QFtp

Class hierarchy: QFtp » QObject

Sub-classes: Command, Error, State, TransferMode, TransferType

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QFtp_TransferMode ptr Active

Description: Enum constant QFtp::Active

[static,const] new QFtp_TransferType ptr Ascii

Description: Enum constant QFtp::Ascii

[static,const] new QFtp_TransferType ptr Binary

Description: Enum constant QFtp::Binary

[static,const] new QFtp_Command ptr Cd

Description: Enum constant QFtp::Cd

[static,const] new QFtp_Command ptr Close

Description: Enum constant QFtp::Close

[static,const] new QFtp_State ptr Closing

Description: Enum constant QFtp::Closing

[static,const] new QFtp_Command ptr ConnectToHost

Description: Enum constant QFtp::ConnectToHost

[static,const] new QFtp_State ptr Connected

Description: Enum constant QFtp::Connected

[static,const] new QFtp_State ptr Connecting

Description: Enum constant QFtp::Connecting

[static,const] new QFtp_Error ptr ConnectionRefused

Description: Enum constant QFtp::ConnectionRefused

[static,const] new QFtp_Command ptr Get

Description: Enum constant QFtp::Get

[static,const] new QFtp_State ptr HostLookup

Description: Enum constant QFtp::HostLookup

[static,const] new QFtp_Error ptr HostNotFound

Description: Enum constant QFtp::HostNotFound

[static,const] new QFtp_Command ptr List

Description: Enum constant QFtp::List

[static,const] new QFtp_State ptr LoggedIn

Description: Enum constant QFtp::LoggedIn

[static,const] new QFtp_Command ptr Login

Description: Enum constant QFtp::Login

[static,const] new QFtp_Command ptr Mkdir

Description: Enum constant QFtp::Mkdir

[static,const] new QFtp_Error ptr NoError

Description: Enum constant QFtp::NoError

[static,const] new QFtp_Command ptr None

Description: Enum constant QFtp::None

[static,const] new QFtp_Error ptr NotConnected

Description: Enum constant QFtp::NotConnected

[static,const] new QFtp_TransferMode ptr Passive

Description: Enum constant QFtp::Passive

[static,const] new QFtp_Command ptr Put

Description: Enum constant QFtp::Put

[static,const] new QFtp_Command ptr RawCommand

Description: Enum constant QFtp::RawCommand

[static,const] new QFtp_Command ptr Remove

Description: Enum constant QFtp::Remove

[static,const] new QFtp_Command ptr Rename

Description: Enum constant QFtp::Rename

[static,const] new QFtp_Command ptr Rmdir

Description: Enum constant QFtp::Rmdir

[static,const] new QFtp_Command ptr SetProxy

Description: Enum constant QFtp::SetProxy

[static,const] new QFtp_Command ptr SetTransferMode

Description: Enum constant QFtp::SetTransferMode

[static,const] new QFtp_State ptr Unconnected

Description: Enum constant QFtp::Unconnected

[static,const] new QFtp_Error ptr UnknownError

Description: Enum constant QFtp::UnknownError

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

[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] 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.

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.

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.

void abort

Description: Method void QFtp::abort()

[const] long long bytesAvailable

Description: Method qint64 QFtp::bytesAvailable()

int cd(string dir)

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

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void clearPendingCommands

Description: Method void QFtp::clearPendingCommands()

int close

Description: Method int QFtp::close()

[event] void commandFinished(int arg1,bool arg2)

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

You can bind a procedure to this signal.

[event] void commandStarted(int arg1)

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

You can bind a procedure to this signal.

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

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

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] QFtp_Command currentCommand

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

[const] QIODevice ptr currentDevice

Description: Method QIODevice *QFtp::currentDevice()

[const] int currentId

Description: Method int QFtp::currentId()

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[event] void dataTransferProgress(long long arg1,long long arg2)

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

You can bind a procedure to this signal.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

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

This method can be reimplemented in a derived class.

[event] void done(bool arg1)

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

You can bind a procedure to this signal.

[const] QFtp_Error error

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

[const] string errorString

Description: Method QString QFtp::errorString()

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] 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.

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)

[const] bool hasPendingCommands

Description: Method bool QFtp::hasPendingCommands()

[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

int list(string dir = QString())

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

[event] void listInfo(const QUrlInfo arg1)

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

You can bind a procedure to this signal.

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

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

int mkdir(string dir)

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

[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

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

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

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)

int rawCommand(string command)

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

[event] void rawCommandReply(int arg1,string arg2)

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

You can bind a procedure to this signal.

string readAll

Description: Method QByteArray QFtp::readAll()

[event] void readyRead

Description: Signal declaration for QFtp::readyRead()

You can bind a procedure to this signal.

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

int remove(string file)

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

int rename(string oldname,string newname)

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

int rmdir(string dir)

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

[const] QObject ptr sender

Description: Method QObject *QFtp::sender()

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

int setProxy(string host,unsigned short port)

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

int setTransferMode(const QFtp_TransferMode mode)

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

[const] QFtp_State state

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

[event] void stateChanged(int arg1)

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

You can bind a procedure to this signal.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

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

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