QTextStream Class

Documentación de las funciones miembro

QTextStream::QTextStream()

Construye un QTextStream. Antes de poder usarlo para leer o escribir, debes asignarle un dispositivo o una cadena.

Véase también setDevice() y setString().

[explicit] QTextStream::QTextStream(QIODevice *device)

Construye un QTextStream que opera sobre device.

[explicit] QTextStream::QTextStream(FILE *fileHandle, QIODeviceBase::OpenMode openMode = ReadWrite)

Construye un QTextStream que opera sobre fileHandle, usando openMode para definir el modo de apertura. Internamente, se crea un QFile para manejar el puntero FILE.

Este constructor es útil para trabajar directamente con los flujos de entrada y salida comunes basados en FILE: stdin, stdout y stderr. Ejemplo:

QString str;
QTextStream in(stdin);
in >> str;

[explicit] QTextStream::QTextStream(QByteArray *array, QIODeviceBase::OpenMode openMode = ReadWrite)

Construye un QTextStream que opera sobre array, usando openMode para definir el modo de apertura. Internamente, el array está envuelto por un QBuffer.

[explicit] QTextStream::QTextStream(QString *string, QIODeviceBase::OpenMode openMode = ReadWrite)

Construye un QTextStream que opera sobre string, usando openMode para definir el modo de apertura.

[explicit] QTextStream::QTextStream(const QByteArray &array, QIODeviceBase::OpenMode openMode = ReadOnly)

Construye un QTextStream que opera sobre array, usando openMode para definir el modo de apertura. Se accede al array como sólo lectura, independientemente de los valores en openMode.

Este constructor es conveniente para trabajar con cadenas constantes. Ejemplo:

int main(int argc, char *argv[])
{
    // read numeric arguments (123, 0x20, 4.5...)
    for (int i = 1; i < argc; ++i) {
        int number;
        QTextStream in(argv[i]);
        in >> number;
        //...
    }
}

[virtual noexcept] QTextStream::~QTextStream()

Destruye el QTextStream.

Si el flujo opera en un dispositivo, flush() será llamado implícitamente. De lo contrario, el dispositivo no se verá afectado.

bool QTextStream::atEnd() const

Devuelve true si no hay más datos que leer de QTextStream; en caso contrario devuelve false. Esto es similar, pero no es lo mismo que llamar a QIODevice::atEnd(), ya que QTextStream también tiene en cuenta su búfer Unicode interno.

bool QTextStream::autoDetectUnicode() const

Devuelve true si la detección automática de Unicode está activada; en caso contrario, devuelve false. La detección automática de Unicode está activada por defecto.

Véase también setAutoDetectUnicode() y setEncoding().

QIODevice *QTextStream::device() const

Devuelve el dispositivo actual asociado a QTextStream, o nullptr si no se ha asignado ningún dispositivo.

Véase también setDevice() y string().

QStringConverter::Encoding QTextStream::encoding() const

Devuelve la codificación asignada actualmente al flujo.

Véase también setEncoding(), setAutoDetectUnicode() y locale().

QTextStream::FieldAlignment QTextStream::fieldAlignment() const

Devuelve la alineación actual del campo.

Véase también setFieldAlignment() y fieldWidth().

int QTextStream::fieldWidth() const

Devuelve el ancho de campo actual.

Véase también setFieldWidth().

void QTextStream::flush()

Vacía cualquier dato almacenado en el búfer que esté esperando a ser escrito en el dispositivo.

Si QTextStream opera sobre una cadena, esta función no hace nada.

bool QTextStream::generateByteOrderMark() const

Devuelve true si QTextStream está configurado para generar el UTF BOM (Byte Order Mark) cuando se utiliza una codificación UTF; en caso contrario devuelve false. La generación de UTF BOM es falsa por defecto.

Véase también setGenerateByteOrderMark().

int QTextStream::integerBase() const

Devuelve la base actual de los números enteros. 0 significa que se detecta la base al leer, o 10 (decimal) al generar números.

Véase también setIntegerBase(), QString::number(), y numberFlags().

QLocale QTextStream::locale() const

Devuelve la configuración regional de este flujo. La configuración regional por defecto es C.

Véase también setLocale().

QTextStream::NumberFlags QTextStream::numberFlags() const

Devuelve las banderas numéricas actuales.

Véase también setNumberFlags(), integerBase() y realNumberNotation().

QChar QTextStream::padChar() const

Devuelve el carácter de almohadilla actual.

Véase también setPadChar() y setFieldWidth().

qint64 QTextStream::pos() const

Devuelve la posición de dispositivo correspondiente a la posición actual del flujo, o -1 si se produce un error (por ejemplo, si no hay dispositivo o cadena, o si hay un error de dispositivo).

Dado que QTextStream se almacena en búfer, es posible que esta función tenga que buscar el dispositivo para reconstruir una posición de dispositivo válida. Esta operación puede ser costosa, por lo que puede que quieras evitar llamar a esta función en un bucle cerrado.

Véase también seek().

QString QTextStream::read(qint64 maxlen)

Lee como máximo maxlen caracteres del flujo y devuelve los datos leídos como QString.

Véase también readAll(), readLine() y QIODevice::read().

QString QTextStream::readAll()

Lee todo el contenido del flujo y lo devuelve como QString. Evite esta función cuando trabaje con archivos grandes, ya que consumirá una cantidad significativa de memoria.

Es mejor llamar a readLine() si no se sabe cuántos datos hay disponibles.

Véase también readLine().

QString QTextStream::readLine(qint64 maxlen = 0)

Lee una línea de texto del flujo y la devuelve como QString. La longitud máxima de línea permitida se establece en maxlen. Si el flujo contiene líneas más largas, las líneas se dividirán después de los caracteres maxlen y se devolverán por partes.

Si maxlen es 0, las líneas pueden tener cualquier longitud.

La línea devuelta no tiene caracteres de fin de línea ("\n" o "\r\n "), por lo que no es necesario llamar a QString::trimmed().

Si el flujo ha leído hasta el final del archivo, readLine() devolverá un valor nulo QString. Para cadenas, o para dispositivos que lo soporten, puede comprobar explícitamente el final del flujo utilizando atEnd().

Véase también readAll() y QIODevice::readLine().

bool QTextStream::readLineInto(QString *line, qint64 maxlen = 0)

Lee una línea de texto del flujo en line. Si line es nullptr, la línea leída no se almacena.

La longitud máxima de línea permitida es maxlen. Si el flujo contiene líneas más largas, las líneas se dividirán después de los caracteres maxlen y se devolverán por partes.

Si maxlen es 0, las líneas pueden tener cualquier longitud.

La línea resultante no tiene caracteres de final de línea ("\n" o "\r\n "), por lo que puede ser innecesario llamar a QString::trimmed().

Si line tiene capacidad suficiente para los datos que se van a leer, es posible que esta función no necesite asignar nueva memoria. Por ello, puede ser más rápida que readLine().

Devuelve false si el flujo ha leído hasta el final del archivo o se ha producido un error; en caso contrario devuelve true. El contenido en line antes de la llamada se descarta en cualquier caso.

Véase también readAll(), QIODevice::readLine(), y QIODevice::readLineInto().

QTextStream::RealNumberNotation QTextStream::realNumberNotation() const

Devuelve la notación numérica real actual.

Véase también setRealNumberNotation(), realNumberPrecision(), numberFlags() y integerBase().

int QTextStream::realNumberPrecision() const

Devuelve la precisión actual de los números reales, o el número de dígitos de fracción que QTextStream escribirá al generar números reales (FixedNotation, ScientificNotation), o el número máximo de dígitos significativos (SmartNotation).

Véase también setRealNumberPrecision(), setRealNumberNotation(), realNumberNotation(), numberFlags(), y integerBase().

void QTextStream::reset()

Restablece las opciones de formato de QTextStream, devolviéndolo a su estado original. El dispositivo, la cadena y los datos almacenados en el búfer se mantienen intactos.

void QTextStream::resetStatus()

Restablece el estado del flujo de texto.

Véase también QTextStream::Status, status(), y setStatus().

bool QTextStream::seek(qint64 pos)

Busca la posición pos en el dispositivo. Devuelve true en caso de éxito; en caso contrario, devuelve false.

void QTextStream::setAutoDetectUnicode(bool enabled)

Si enabled es verdadero, QTextStream intentará detectar la codificación Unicode echando un vistazo a los datos del flujo para ver si puede encontrar la marca de orden de bytes UTF-8, UTF-16 o UTF-32 (BOM). Si encuentra esta marca, QTextStream sustituirá la codificación actual por la codificación UTF.

Esta función puede utilizarse junto con setEncoding(). Es habitual establecer la codificación en UTF-8 y, a continuación, activar la detección de UTF-16.

Véase también autoDetectUnicode() y setEncoding().

void QTextStream::setDevice(QIODevice *device)

Establece el dispositivo actual a device. Si ya se ha asignado un dispositivo, QTextStream llamará a flush() antes de que el dispositivo antiguo sea reemplazado.

Véase también device() y setString().

[since 6.0] void QTextStream::setEncoding(QStringConverter::Encoding encoding)

Establece la codificación para este flujo en encoding. La codificación se utiliza para descodificar cualquier dato que se lea del dispositivo asignado, y para codificar cualquier dato que se escriba. Por defecto, se utiliza QStringConverter::Utf8, y la detección automática de unicode está activada.

Si QTextStream opera sobre una cadena, esta función no hace nada.

Esta función se introdujo en Qt 6.0.

Véase también encoding(), setAutoDetectUnicode(), y setLocale().

void QTextStream::setFieldAlignment(QTextStream::FieldAlignment mode)

Establece la alineación de los campos en mode. Cuando se utiliza junto con setFieldWidth(), esta función permite generar una salida formateada con el texto alineado a la izquierda, a la derecha o centrado.

Véase también fieldAlignment() y setFieldWidth().

void QTextStream::setFieldWidth(int width)

Establece la anchura de campo actual en width. Si width es 0 (por defecto), la anchura de campo es igual a la longitud del texto generado.

Véase también fieldWidth() y setPadChar().

void QTextStream::setGenerateByteOrderMark(bool generate)

Si generate es verdadero y se utiliza una codificación UTF, QTextStream insertará la BOM (marca de orden de bytes) antes de que se haya escrito ningún dato en el dispositivo. Si generate es falso, no se insertará ninguna BOM. Esta función debe llamarse antes de que se escriba ningún dato. De lo contrario, no hace nada.

Véase también generateByteOrderMark() y bom().

void QTextStream::setIntegerBase(int base)

Establece la base de los enteros en base, tanto para la lectura como para la generación de números. base puede ser 2 (binario), 8 (octal), 10 (decimal) o 16 (hexadecimal). Si base es 0, QTextStream intentará detectar la base inspeccionando los datos en el flujo. Al generar números, QTextStream asume que la base es 10 a menos que se haya establecido explícitamente.

Véase también integerBase(), QString::number(), y setNumberFlags().

void QTextStream::setLocale(const QLocale &locale)

Establece la configuración regional de este flujo en locale. La configuración regional especificada se utiliza para las conversiones entre números y sus representaciones de cadena.

La configuración regional por defecto es C y es un caso especial - el separador de grupos de miles no se utiliza por razones de compatibilidad con versiones anteriores.

Véase también locale().

void QTextStream::setNumberFlags(QTextStream::NumberFlags flags)

Establece las banderas numéricas actuales en flags. flags es un conjunto de banderas del enum NumberFlag, y describe opciones para formatear el código generado (por ejemplo, si escribir o no siempre la base o el signo de un número).

Véase también numberFlags(), setIntegerBase(), y setRealNumberNotation().

void QTextStream::setPadChar(QChar ch)

Establece el carácter de relleno en ch. El valor por defecto es el carácter de espacio ASCII (' '), o QChar(0x20). Este carácter se utiliza para rellenar el espacio en los campos al generar texto.

Ejemplo:

QString s;
QTextStream out(&s);
out.setFieldWidth(10);
out.setFieldAlignment(QTextStream::AlignCenter);
out.setPadChar('-');
out << "Qt" << "rocks!";

La cadena s contiene:

----Qt------rocks!--

Véase también padChar() y setFieldWidth().

void QTextStream::setRealNumberNotation(QTextStream::RealNumberNotation notation)

Establece la notación de números reales en notation (SmartNotation, FixedNotation, ScientificNotation). Al leer y generar números, QTextStream utiliza este valor para detectar el formato de los números reales.

Véase también realNumberNotation(), setRealNumberPrecision(), setNumberFlags(), y setIntegerBase().

void QTextStream::setRealNumberPrecision(int precision)

Establece la precisión de los números reales en precision. Este valor describe el número de dígitos de fracción que QTextStream debe escribir al generar números reales (FixedNotation, ScientificNotation), o el número máximo de dígitos significativos (SmartNotation).

La precisión no puede ser un valor negativo. El valor por defecto es 6.

Véase también realNumberPrecision() y setRealNumberNotation().

void QTextStream::setStatus(QTextStream::Status status)

Establece el estado del flujo de texto en status.

Las llamadas posteriores a setStatus() se ignoran hasta que se llame a resetStatus().

Véase también Status, status(), y resetStatus().

void QTextStream::setString(QString *string, QIODeviceBase::OpenMode openMode = ReadWrite)

Establece la cadena actual en string, utilizando el openMode dado. Si un dispositivo ya ha sido asignado, QTextStream llamará a flush() antes de reemplazarlo.

Véase también string() y setDevice().

void QTextStream::skipWhiteSpace()

Lee y descarta los espacios en blanco del flujo hasta que se detecta un carácter no espaciado o hasta que atEnd() devuelve verdadero. Esta función es útil cuando se lee un flujo carácter por carácter.

Los espacios en blanco son todos los caracteres para los que QChar::isSpace() devuelve true.

Véase también operator>>().

QTextStream::Status QTextStream::status() const

Devuelve el estado del flujo de texto.

Véase también QTextStream::Status, setStatus(), y resetStatus().

QString *QTextStream::string() const

Devuelve la cadena actual asignada a QTextStream, o nullptr si no se ha asignado ninguna cadena.

Véase también setString() y device().

[explicit noexcept, since 6.10] QTextStream::operator bool() const

Devuelve si este flujo no tiene errores (status() devuelve Ok).

Esta función se introdujo en Qt 6.10.

QTextStream &QTextStream::operator<<(QChar c)

Escribe el carácter c en el flujo y devuelve una referencia a QTextStream.

Véase también setFieldWidth().

QTextStream &QTextStream::operator<<(const QString &string)

Escribe la cadena string en el flujo y devuelve una referencia a QTextStream. La cadena se codifica primero utilizando la codificación asignada (el valor predeterminado es UTF-8) antes de escribirse en el flujo.

Véase también setFieldWidth() y setEncoding().

QTextStream &QTextStream::operator<<(float f)

Escribe el número real f en el flujo y, a continuación, devuelve una referencia a QTextStream. Por defecto, QTextStream lo almacena utilizando SmartNotation, con hasta 6 dígitos de precisión. Puede cambiar la representación textual que QTextStream utilizará para los números reales llamando a setRealNumberNotation(), setRealNumberPrecision() y setNumberFlags().

Véase también setFieldWidth(), setRealNumberNotation(), setRealNumberPrecision() y setNumberFlags().

QTextStream &QTextStream::operator<<(short i)

Escribe el número entero i en el flujo, luego devuelve una referencia a QTextStream. Por defecto, el número se almacena en forma decimal, pero también se puede establecer la base llamando a setIntegerBase().

Véase también setFieldWidth() y setNumberFlags().

QTextStream &QTextStream::operator<<(QLatin1StringView string)

Escribe string en el flujo y devuelve una referencia a QTextStream.

QTextStream &QTextStream::operator<<(QStringView string)

Escribe string en el flujo y devuelve una referencia a QTextStream.

QTextStream &QTextStream::operator<<(char c)

Convierte c de ASCII a QChar, y luego lo escribe en el flujo.

[since 6.3.1] QTextStream &QTextStream::operator<<(char16_t c)

Escribe el carácter Unicode c en el flujo y devuelve una referencia a QTextStream.

Esta función se introdujo en Qt 6.3.1.

QTextStream &QTextStream::operator<<(const QByteArray &array)

Escribe array en el flujo. El contenido de array se convierte con QString::fromUtf8().

QTextStream &QTextStream::operator<<(const char *string)

Escribe la cadena constante apuntada por string en el flujo. Se supone que string está en codificación UTF-8. Este operador resulta útil cuando se trabaja con datos de cadena constante. Ejemplo:

QTextStream out(stdout);
out << "Qt rocks!" << Qt::endl;

Advertencia: QTextStream asume que string apunta a una cadena de texto, terminada por un carácter '\0'. Si no hay ningún carácter de terminación '\0', su aplicación puede bloquearse.

QTextStream &QTextStream::operator<<(const void *ptr)

Escribe ptr en el flujo como un número hexadecimal con una base.

QTextStream &QTextStream::operator<<(double f)

Escribe el doble f en el flujo.

QTextStream &QTextStream::operator<<(int i)

Escribe el int con signo i en el flujo.

QTextStream &QTextStream::operator<<(long i)

Escribe el long con signo i en el flujo.

QTextStream &QTextStream::operator<<(qlonglong i)

Escribe el qlonglong i en el flujo.

QTextStream &QTextStream::operator<<(qulonglong i)

Escribe el qulonglong i en el flujo.

QTextStream &QTextStream::operator<<(unsigned int i)

Escribe el valor unsigned int i en el flujo.

QTextStream &QTextStream::operator<<(unsigned long i)

Escribe el unsigned long i en el flujo.

QTextStream &QTextStream::operator<<(unsigned short i)

Escribe el corto sin signo i en el flujo.

QTextStream &QTextStream::operator>>(QChar &c)

Lee un carácter del flujo y lo almacena en c. Devuelve una referencia a QTextStream, por lo que se pueden anidar varios operadores. Ejemplo:

QTextStream in(file);
QChar ch1, ch2, ch3;
in >> ch1 >> ch2 >> ch3;

No se saltan los espacios en blanco.

QTextStream &QTextStream::operator>>(QString &str)

Lee una palabra del flujo y la almacena en str, luego devuelve una referencia al flujo. Las palabras están separadas por espacios en blanco (es decir, todos los caracteres para los que QChar::isSpace() devuelve true).

Se omiten los espacios en blanco iniciales.

QTextStream &QTextStream::operator>>(float &f)

Lee un número real del flujo y lo almacena en f, luego devuelve una referencia a QTextStream. El número se convierte al tipo correcto. Si no se detecta ningún número real en el flujo, f se establece en 0.0.

Como excepción especial, QTextStream permite que las cadenas "nan" e "inf" representen flotadores o dobles NAN e INF.

Se omiten los espacios en blanco.

QTextStream &QTextStream::operator>>(short &i)

Lee un número entero del flujo y lo almacena en i, luego devuelve una referencia a QTextStream. El número se convierte al tipo correcto antes de ser almacenado. Si no se detecta ningún número en el flujo, i se pone a 0.

Por defecto, QTextStream intentará detectar la base del número utilizando las siguientes reglas:

Si llama a setIntegerBase(), puede especificar explícitamente la base entera. Esto desactivará la detección automática y acelerará ligeramente QTextStream.

Los espacios en blanco se omiten.

QTextStream &QTextStream::operator>>(QByteArray &array)

Convierte la palabra a UTF-8 y la almacena en array.

Véase también QString::toLatin1().

QTextStream &QTextStream::operator>>(char &c)

Lee un carácter del flujo y lo almacena en c. El carácter del flujo se convierte a ISO-8859-1 antes de ser almacenado.

Véase también QChar::toLatin1().

QTextStream &QTextStream::operator>>(char *c)

Convierte la palabra a UTF-8 y la almacena en c, terminada por un carácter '\0'. Si no hay ninguna palabra disponible, sólo se almacena el carácter '\0'.

Advertencia: Aunque conveniente, este operador es peligroso y debe usarse con cuidado. QTextStream asume que c apunta a un buffer con suficiente espacio para contener la palabra. Si el búfer es demasiado pequeño, la aplicación puede bloquearse. Para una palabra formada por n QChars, el buffer debe tener al menos 3*n+1 caracteres.

Si es posible, utilice el operador QByteArray en su lugar.

[since 6.4] QTextStream &QTextStream::operator>>(char16_t &c)

Lee un carácter del flujo y lo almacena en c.

Esta función se introdujo en Qt 6.4.

QTextStream &QTextStream::operator>>(double &f)

Almacena el número real en el doble f.

QTextStream &QTextStream::operator>>(int &i)

Almacena el entero en el int con signo i.

QTextStream &QTextStream::operator>>(long &i)

Almacena el entero en el long con signo i.

QTextStream &QTextStream::operator>>(qlonglong &i)

Almacena el entero en el qlonglong i.

QTextStream &QTextStream::operator>>(qulonglong &i)

Almacena el entero en el qulonglong i.

QTextStream &QTextStream::operator>>(unsigned int &i)

Almacena el entero en el unsigned int i.

QTextStream &QTextStream::operator>>(unsigned long &i)

Almacena el entero en el unsigned long i.

QTextStream &QTextStream::operator>>(unsigned short &i)

Almacena el entero en el unsigned short i.