API reference - Class QIODevice

Notation used in Ruby API documentation

Description: Binding of QIODevice

Class hierarchy: QIODevice » QObject

Public methods

[const]boolatEndMethod bool QIODevice::atEnd()
[const]long longbytesAvailableMethod qint64 QIODevice::bytesAvailable()
[const]long longbytesToWriteMethod qint64 QIODevice::bytesToWrite()
[const]boolcanReadLineMethod bool QIODevice::canReadLine()
voidcloseMethod void QIODevice::close()
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]stringerrorStringMethod QString QIODevice::errorString()
[const]boolisOpenMethod bool QIODevice::isOpen()
[const]boolisOpen?Method bool QIODevice::isOpen()
[const]boolisReadableMethod bool QIODevice::isReadable()
[const]boolisReadable?Method bool QIODevice::isReadable()
[const]boolisSequentialMethod bool QIODevice::isSequential()
[const]boolisSequential?Method bool QIODevice::isSequential()
[const]boolisTextModeEnabledMethod bool QIODevice::isTextModeEnabled()
[const]boolisTextModeEnabled?Method bool QIODevice::isTextModeEnabled()
[const]boolisWritableMethod bool QIODevice::isWritable()
[const]boolisWritable?Method bool QIODevice::isWritable()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
boolopen(const QIODevice_QFlags_OpenModeFlag mode)Method bool QIODevice::open(QFlags<QIODevice::OpenModeFlag> mode)
[const]QIODevice_QFlags_OpenModeFlagopenModeMethod QFlags<QIODevice::OpenModeFlag> QIODevice::openMode()
stringpeek(long long maxlen)Method QByteArray QIODevice::peek(qint64 maxlen)
[const]long longposMethod qint64 QIODevice::pos()
boolputChar(char c)Method bool QIODevice::putChar(char c)
stringread(long long maxlen)Method QByteArray QIODevice::read(qint64 maxlen)
stringreadAllMethod QByteArray QIODevice::readAll()
stringreadLine(long long maxlen = 0)Method QByteArray QIODevice::readLine(qint64 maxlen)
boolresetMethod bool QIODevice::reset()
boolseek(long long pos)Method bool QIODevice::seek(qint64 pos)
voidsetTextModeEnabled(bool enabled)Method void QIODevice::setTextModeEnabled(bool enabled)
[const]long longsizeMethod qint64 QIODevice::size()
voidtextModeEnabled=(bool enabled)Method void QIODevice::setTextModeEnabled(bool enabled)
voidungetChar(char c)Method void QIODevice::ungetChar(char c)
boolwaitForBytesWritten(int msecs)Method bool QIODevice::waitForBytesWritten(int msecs)
boolwaitForReadyRead(int msecs)Method bool QIODevice::waitForReadyRead(int msecs)
long longwrite(string data,
long long len)
Method qint64 QIODevice::write(const char *data, qint64 len)
long longwrite(string data)Method qint64 QIODevice::write(const QByteArray &data)

Public static methods and constants

QIODevice_OpenModeFlagAppendEnum constant QIODevice::Append
QIODevice_OpenModeFlagNotOpenEnum constant QIODevice::NotOpen
QIODevice_OpenModeFlagReadOnlyEnum constant QIODevice::ReadOnly
QIODevice_OpenModeFlagReadWriteEnum constant QIODevice::ReadWrite
QIODevice_OpenModeFlagTextEnum constant QIODevice::Text
QIODevice_OpenModeFlagTruncateEnum constant QIODevice::Truncate
QIODevice_OpenModeFlagUnbufferedEnum constant QIODevice::Unbuffered
QIODevice_OpenModeFlagWriteOnlyEnum constant QIODevice::WriteOnly
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QIODevice::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QIODevice::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QIODevice::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QIODevice::trUtf8(const char *s, const char *c, int n)

Detailed description

[static] QIODevice_OpenModeFlag Append

Description: Enum constant QIODevice::Append

[static] QIODevice_OpenModeFlag NotOpen

Description: Enum constant QIODevice::NotOpen

[static] QIODevice_OpenModeFlag ReadOnly

Description: Enum constant QIODevice::ReadOnly

[static] QIODevice_OpenModeFlag ReadWrite

Description: Enum constant QIODevice::ReadWrite

[static] QIODevice_OpenModeFlag Text

Description: Enum constant QIODevice::Text

[static] QIODevice_OpenModeFlag Truncate

Description: Enum constant QIODevice::Truncate

[static] QIODevice_OpenModeFlag Unbuffered

Description: Enum constant QIODevice::Unbuffered

[static] QIODevice_OpenModeFlag WriteOnly

Description: Enum constant QIODevice::WriteOnly

[const] bool atEnd

Description: Method bool QIODevice::atEnd()

[const] long long bytesAvailable

Description: Method qint64 QIODevice::bytesAvailable()

[const] long long bytesToWrite

Description: Method qint64 QIODevice::bytesToWrite()

[const] bool canReadLine

Description: Method bool QIODevice::canReadLine()

void close

Description: Method void QIODevice::close()

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] string errorString

Description: Method QString QIODevice::errorString()

[const] bool isOpen

Description: Method bool QIODevice::isOpen()

[const] bool isOpen?

Description: Method bool QIODevice::isOpen()

[const] bool isReadable

Description: Method bool QIODevice::isReadable()

[const] bool isReadable?

Description: Method bool QIODevice::isReadable()

[const] bool isSequential

Description: Method bool QIODevice::isSequential()

[const] bool isSequential?

Description: Method bool QIODevice::isSequential()

[const] bool isTextModeEnabled

Description: Method bool QIODevice::isTextModeEnabled()

[const] bool isTextModeEnabled?

Description: Method bool QIODevice::isTextModeEnabled()

[const] bool isWritable

Description: Method bool QIODevice::isWritable()

[const] bool isWritable?

Description: Method bool QIODevice::isWritable()

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

bool open(const QIODevice_QFlags_OpenModeFlag mode)

Description: Method bool QIODevice::open(QFlags<QIODevice::OpenModeFlag> mode)

[const] QIODevice_QFlags_OpenModeFlag openMode

Description: Method QFlags<QIODevice::OpenModeFlag> QIODevice::openMode()

string peek(long long maxlen)

Description: Method QByteArray QIODevice::peek(qint64 maxlen)

[const] long long pos

Description: Method qint64 QIODevice::pos()

bool putChar(char c)

Description: Method bool QIODevice::putChar(char c)

string read(long long maxlen)

Description: Method QByteArray QIODevice::read(qint64 maxlen)

string readAll

Description: Method QByteArray QIODevice::readAll()

string readLine(long long maxlen = 0)

Description: Method QByteArray QIODevice::readLine(qint64 maxlen)

bool reset

Description: Method bool QIODevice::reset()

bool seek(long long pos)

Description: Method bool QIODevice::seek(qint64 pos)

void setTextModeEnabled(bool enabled)

Description: Method void QIODevice::setTextModeEnabled(bool enabled)

[const] long long size

Description: Method qint64 QIODevice::size()

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

void textModeEnabled=(bool enabled)

Description: Method void QIODevice::setTextModeEnabled(bool enabled)

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

Description: Static method QString QIODevice::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 QIODevice::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 QIODevice::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 QIODevice::trUtf8(const char *s, const char *c, int n)

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

void ungetChar(char c)

Description: Method void QIODevice::ungetChar(char c)

bool waitForBytesWritten(int msecs)

Description: Method bool QIODevice::waitForBytesWritten(int msecs)

bool waitForReadyRead(int msecs)

Description: Method bool QIODevice::waitForReadyRead(int msecs)

long long write(string data,long long len)

Description: Method qint64 QIODevice::write(const char *data, qint64 len)

long long write(string data)

Description: Method qint64 QIODevice::write(const QByteArray &data)