API reference - Class QFtp

Notation used in Ruby API documentation

Description: Binding of QFtp

Class hierarchy: QFtp » QObject

Public constructors

new QFtpnew(QObject ptr parent = 0)Constructor QFtp::QFtp(QObject *parent)

Public methods

voidabortMethod void QFtp::abort()
[const]long longbytesAvailableMethod qint64 QFtp::bytesAvailable()
intcd(string dir)Method int QFtp::cd(const QString &dir)
voidclearPendingCommandsMethod void QFtp::clearPendingCommands()
intcloseMethod int QFtp::close()
[event]voidcommandFinished(int arg1,
bool arg2)
Signal declaration for QFtp::commandFinished(int, bool)
[event]voidcommandStarted(int arg1)Signal declaration for QFtp::commandStarted(int)
intconnectToHost(string host,
unsigned short port = 21)
Method int QFtp::connectToHost(const QString &host, quint16 port)
voidcreateEnsures the C++ object is created
[const]QFtp_CommandcurrentCommandMethod QFtp::Command QFtp::currentCommand()
[const]QIODevice ptrcurrentDeviceMethod QIODevice *QFtp::currentDevice()
[const]intcurrentIdMethod int QFtp::currentId()
[event]voiddataTransferProgress(long long arg1,
long long arg2)
Signal declaration for QFtp::dataTransferProgress(qint64, qint64)
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QFtp::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[event]voiddone(bool arg1)Signal declaration for QFtp::done(bool)
[const]QFtp_ErrorerrorMethod QFtp::Error QFtp::error()
[const]stringerrorStringMethod QString QFtp::errorString()
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QFtp::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QFtp::eventFilter(QObject *, QEvent *)
intget(string file,
QIODevice ptr dev = 0,
const QFtp_TransferType type = QFtp::Binary)
Method int QFtp::get(const QString &file, QIODevice *dev, QFtp::TransferType type)
[const]boolhasPendingCommandsMethod bool QFtp::hasPendingCommands()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
intlist(string dir = QString())Method int QFtp::list(const QString &dir)
[event]voidlistInfo(const QUrlInfo arg1)Signal declaration for QFtp::listInfo(const QUrlInfo &)
intlogin(string user = QString(),
string password = QString())
Method int QFtp::login(const QString &user, const QString &password)
intmkdir(string dir)Method int QFtp::mkdir(const QString &dir)
intput(string data,
string file,
const QFtp_TransferType type = QFtp::Binary)
Method int QFtp::put(const QByteArray &data, const QString &file, QFtp::TransferType type)
intput(QIODevice ptr dev,
string file,
const QFtp_TransferType type = QFtp::Binary)
Method int QFtp::put(QIODevice *dev, const QString &file, QFtp::TransferType type)
intrawCommand(string command)Method int QFtp::rawCommand(const QString &command)
[event]voidrawCommandReply(int arg1,
string arg2)
Signal declaration for QFtp::rawCommandReply(int, const QString &)
stringreadAllMethod QByteArray QFtp::readAll()
[event]voidreadyReadSignal declaration for QFtp::readyRead()
intremove(string file)Method int QFtp::remove(const QString &file)
intrename(string oldname,
string newname)
Method int QFtp::rename(const QString &oldname, const QString &newname)
intrmdir(string dir)Method int QFtp::rmdir(const QString &dir)
intsetProxy(string host,
unsigned short port)
Method int QFtp::setProxy(const QString &host, quint16 port)
intsetTransferMode(const QFtp_TransferMode mode)Method int QFtp::setTransferMode(QFtp::TransferMode mode)
[const]QFtp_StatestateMethod QFtp::State QFtp::state()
[event]voidstateChanged(int arg1)Signal declaration for QFtp::stateChanged(int)

Public static methods and constants

QFtp_TransferModeActiveEnum constant QFtp::Active
QFtp_TransferTypeAsciiEnum constant QFtp::Ascii
QFtp_TransferTypeBinaryEnum constant QFtp::Binary
QFtp_CommandCdEnum constant QFtp::Cd
QFtp_CommandCloseEnum constant QFtp::Close
QFtp_StateClosingEnum constant QFtp::Closing
QFtp_CommandConnectToHostEnum constant QFtp::ConnectToHost
QFtp_StateConnectedEnum constant QFtp::Connected
QFtp_StateConnectingEnum constant QFtp::Connecting
QFtp_ErrorConnectionRefusedEnum constant QFtp::ConnectionRefused
QFtp_CommandGetEnum constant QFtp::Get
QFtp_StateHostLookupEnum constant QFtp::HostLookup
QFtp_ErrorHostNotFoundEnum constant QFtp::HostNotFound
QFtp_CommandListEnum constant QFtp::List
QFtp_StateLoggedInEnum constant QFtp::LoggedIn
QFtp_CommandLoginEnum constant QFtp::Login
QFtp_CommandMkdirEnum constant QFtp::Mkdir
QFtp_ErrorNoErrorEnum constant QFtp::NoError
QFtp_CommandNoneEnum constant QFtp::None
QFtp_ErrorNotConnectedEnum constant QFtp::NotConnected
QFtp_TransferModePassiveEnum constant QFtp::Passive
QFtp_CommandPutEnum constant QFtp::Put
QFtp_CommandRawCommandEnum constant QFtp::RawCommand
QFtp_CommandRemoveEnum constant QFtp::Remove
QFtp_CommandRenameEnum constant QFtp::Rename
QFtp_CommandRmdirEnum constant QFtp::Rmdir
QFtp_CommandSetProxyEnum constant QFtp::SetProxy
QFtp_CommandSetTransferModeEnum constant QFtp::SetTransferMode
QFtp_StateUnconnectedEnum constant QFtp::Unconnected
QFtp_ErrorUnknownErrorEnum constant QFtp::UnknownError
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QFtp::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QFtp::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QFtp::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QFtp::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QFtp::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QFtp::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QFtp::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QFtp::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QFtp::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QFtp::timerEvent(QTimerEvent *)

Detailed description

[static] QFtp_TransferMode Active

Description: Enum constant QFtp::Active

[static] QFtp_TransferType Ascii

Description: Enum constant QFtp::Ascii

[static] QFtp_TransferType Binary

Description: Enum constant QFtp::Binary

[static] QFtp_Command Cd

Description: Enum constant QFtp::Cd

[static] QFtp_Command Close

Description: Enum constant QFtp::Close

[static] QFtp_State Closing

Description: Enum constant QFtp::Closing

[static] QFtp_Command ConnectToHost

Description: Enum constant QFtp::ConnectToHost

[static] QFtp_State Connected

Description: Enum constant QFtp::Connected

[static] QFtp_State Connecting

Description: Enum constant QFtp::Connecting

[static] QFtp_Error ConnectionRefused

Description: Enum constant QFtp::ConnectionRefused

[static] QFtp_Command Get

Description: Enum constant QFtp::Get

[static] QFtp_State HostLookup

Description: Enum constant QFtp::HostLookup

[static] QFtp_Error HostNotFound

Description: Enum constant QFtp::HostNotFound

[static] QFtp_Command List

Description: Enum constant QFtp::List

[static] QFtp_State LoggedIn

Description: Enum constant QFtp::LoggedIn

[static] QFtp_Command Login

Description: Enum constant QFtp::Login

[static] QFtp_Command Mkdir

Description: Enum constant QFtp::Mkdir

[static] QFtp_Error NoError

Description: Enum constant QFtp::NoError

[static] QFtp_Command None

Description: Enum constant QFtp::None

[static] QFtp_Error NotConnected

Description: Enum constant QFtp::NotConnected

[static] QFtp_TransferMode Passive

Description: Enum constant QFtp::Passive

[static] QFtp_Command Put

Description: Enum constant QFtp::Put

[static] QFtp_Command RawCommand

Description: Enum constant QFtp::RawCommand

[static] QFtp_Command Remove

Description: Enum constant QFtp::Remove

[static] QFtp_Command Rename

Description: Enum constant QFtp::Rename

[static] QFtp_Command Rmdir

Description: Enum constant QFtp::Rmdir

[static] QFtp_Command SetProxy

Description: Enum constant QFtp::SetProxy

[static] QFtp_Command SetTransferMode

Description: Enum constant QFtp::SetTransferMode

[static] QFtp_State Unconnected

Description: Enum constant QFtp::Unconnected

[static] QFtp_Error UnknownError

Description: Enum constant QFtp::UnknownError

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

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

[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

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.

[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

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

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.

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.