QString Class Reference
^{[QtCore module]}

Argument a is formatted according to the specified format, which is 'g' by default and can be any of the following:

With 'e', 'E', and 'f', precision is the number of digits after the decimal point. With 'g' and 'G', precision is the maximum number of significant digits (trailing zeroes are omitted).

 double d = 12.34;
 QString str = QString("delta: %1").arg(d, 0, 'E', 3);
 // str == "delta: 1.234E+01"

The '%' can be followed by an 'L', in which case the sequence is replaced with a localized representation of a. The conversion uses the default locale, set by QLocale::setDefaultLocale(). If no default locale was specified, the "C" locale is used.

See also QLocale::toString().

const QChar QString::at ( int position ) const

Returns the character at the given index position in the string.

The position must be a valid index position in the string (i.e., 0 <= position < size()).

See also operator[]().

int QString::capacity () const

Returns the maximum number of characters that can be stored in the string without forcing a reallocation.

The sole purpose of this function is to provide a means of fine tuning QString's memory usage. In general, you will rarely ever need to call this function. If you want to know how many characters are in the string, call size().

See also reserve() and squeeze().

void QString::chop ( int n )

Removes n characters from the end of the string.

If n is greater than size(), the result is an empty string.

Example:

     QString str("LOGOUT\r\n");
     str.chop(2);
     // str == "LOGOUT"

If you want to remove characters from the beginning of the string, use remove() instead.

See also truncate(), resize(), and remove().

void QString::clear ()

Clears the contents of the string and makes it empty.

See also resize() and isEmpty().

int QString::compare ( const QString & s1, const QString & s2, Qt::CaseSensitivity cs )   [static]

Compares s1 with s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

If cs is Qt::CaseSensitive, the comparison is case sensitive; otherwise the comparison is case insensitive.

Case sensitive comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-visible strings with localeAwareCompare().

     int x = QString::compare("aUtO", "AuTo", Qt::CaseInsensitive);  // x == 0
     int y = QString::compare("auto", "Car", Qt::CaseSensitive);     // y > 0
     int z = QString::compare("auto", "Car", Qt::CaseInsensitive);   // z < 0

This function was introduced in Qt 4.2.

See also operator==(), operator<(), and operator>().

int QString::compare ( const QString & s1, const QString & s2 )   [static]

This is an overloaded member function, provided for convenience.

Performs a case sensitive compare of s1 and s2.

int QString::compare ( const QString & s1, const QLatin1String & s2, Qt::CaseSensitivity cs = Qt::CaseSensitive )   [static]

This is an overloaded member function, provided for convenience.

Performs a comparison of s1 and s2, using the case sensitivity setting cs.

This function was introduced in Qt 4.2.

int QString::compare ( const QLatin1String & s1, const QString & s2, Qt::CaseSensitivity cs = Qt::CaseSensitive )   [static]

This is an overloaded member function, provided for convenience.

Performs a comparison of s1 and s2, using the case sensitivity setting cs.

This function was introduced in Qt 4.2.

int QString::compare ( const QString & other ) const

This is an overloaded member function, provided for convenience.

Lexically compares this string with the other string and returns an integer less than, equal to, or greater than zero if this string is less than, equal to, or greater than the other string.

Equivalent to compare(*this, other).

int QString::compare ( const QString & other, Qt::CaseSensitivity cs ) const

This is an overloaded member function, provided for convenience.

Same as compare(*this, other, cs).

This function was introduced in Qt 4.2.

int QString::compare ( const QLatin1String & other, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

Same as compare(*this, other, cs).

This function was introduced in Qt 4.2.

const QChar * QString::constData () const

Returns a pointer to the data stored in the QString. The pointer can be used to access the characters that compose the string. For convenience, the data is '\0'-terminated.

Note that the pointer remains valid only as long as the string is not modified.

See also data() and operator[]().

bool QString::contains ( const QString & str, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

Returns true if this string contains an occurrence of the string str; otherwise returns false.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

Example:

     QString str = "Peter Pan";
     str.contains("peter", Qt::CaseInsensitive);    // returns true

See also indexOf() and count().

bool QString::contains ( QChar ch, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

Returns true if this string contains an occurrence of the character ch; otherwise returns false.

bool QString::contains ( const QRegExp & rx ) const

This is an overloaded member function, provided for convenience.

Returns true if the regular expression rx matches somewhere in this string; otherwise returns false.

int QString::count ( const QString & str, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

Returns the number of (potentially overlapping) occurrences of the string str in this string.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

See also contains() and indexOf().

int QString::count ( QChar ch, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

Returns the number of occurrences of character ch in the string.

int QString::count ( const QRegExp & rx ) const

This is an overloaded member function, provided for convenience.

Returns the number of times the regular expression rx matches in the string.

This function counts overlapping matches, so in the example below, there are four instances of "ana" or "ama":

     QString str = "banana and panama";
     str.count(QRegExp("a[nm]a"));    // returns 4

int QString::count () const

This is an overloaded member function, provided for convenience.

Same as size().

QChar * QString::data ()

Returns a pointer to the data stored in the QString. The pointer can be used to access and modify the characters that compose the string. For convenience, the data is '\0'-terminated.

Example:

     QString str = "Hello world";
     QChar *data = str.data();
     while (data) {
         qDebug() << data->unicode();
         ++data;
     }

Note that the pointer remains valid only as long as the string is not modified by other means. For read-only access, constData() is faster because it never causes a deep copy to occur.

See also constData() and operator[]().

const QChar * QString::data () const

This is an overloaded member function, provided for convenience.

bool QString::endsWith ( const QString & s, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

Returns true if the string ends with s; otherwise returns false.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

     QString str = "Bananas";
     str.endsWith("anas");         // returns true
     str.endsWith("pple");         // returns false

See also startsWith().

bool QString::endsWith ( const QLatin1String & s, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

bool QString::endsWith ( const QChar & c, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

Returns true if the string ends with c; otherwise returns false.

QString & QString::fill ( QChar ch, int size = -1 )

Sets every character in the string to character ch. If size is different from -1 (the default), the string is resized to size beforehand.

Example:

     QString str = "Berlin";
     str.fill('z');
     // str == "zzzzzz"

     str.fill('A', 2);
     // str == "AA"

See also resize().

QString QString::fromAscii ( const char * str, int size = -1 )   [static]

Returns a QString initialized with the first size characters of the 8-bit ASCII string str.

If size is -1 (the default), it is taken to be qstrlen(str).

If a codec has been set using QTextCodec::setCodecForCStrings(), it is used to convert str to Unicode; otherwise this function does the same as fromLatin1().

See also toAscii(), fromLatin1(), fromUtf8(), and fromLocal8Bit().

QString QString::fromLatin1 ( const char * str, int size = -1 )   [static]

Returns a QString initialized with the first size characters of the Latin-1 string str.

If size is -1 (the default), it is taken to be qstrlen(str).

See also toLatin1(), fromAscii(), fromUtf8(), and fromLocal8Bit().

QString QString::fromLocal8Bit ( const char * str, int size = -1 )   [static]

Returns a QString initialized with the first size characters of the 8-bit string str.

If size is -1 (the default), it is taken to be qstrlen(str).

QTextCodec::codecForLocale() is used to perform the conversion from Unicode.

See also toLocal8Bit(), fromAscii(), fromLatin1(), and fromUtf8().

QString QString::fromRawData ( const QChar * unicode, int size )   [static]

Constructs a QString that uses the first size Unicode characters in the array unicode. The data in unicode is not copied. The caller must be able to guarantee that unicode will not be deleted or modified as long as the QString (or an unmodified copy of it) exists.

Any attempts to modify the QString or copies of it will cause it to create a deep copy of the data, ensuring that the raw data isn't modified.

Here's an example of how we can use a QRegExp on raw data in memory without requiring to copy the data into a QString:

      QRegExp pattern;
      static const QChar unicode[] = {
              0x005A, 0x007F, 0x00A4, 0x0060,
              0x1009, 0x0020, 0x0020};
      int size = sizeof(unicode) / sizeof(QChar);

      QString str = QString::fromRawData(unicode, size);
      if (str.contains(QRegExp(pattern))) {
          // ...
      }

Warning: A string created with fromRawData() is not '\0'-terminated, unless the raw data contains a '\0' character at position size. This means unicode() will not return a '\0'-terminated string (although utf16() does, at the cost of copying the raw data).

See also fromUtf16().

QString QString::fromStdString ( const std::string & str )   [static]

Returns a copy of the str string. The given string is converted to Unicode using the fromAscii() function.

This constructor is only available if Qt is configured with STL compatibility enabled.

See also fromAscii(), fromLatin1(), fromLocal8Bit(), and fromUtf8().

QString QString::fromStdWString ( const std::wstring & str )   [static]

Returns a copy of the str string. The given string is assumed to be encoded in utf16 if the size of wchar_t is 2 bytes (e.g. on windows) and ucs4 if the size of wchar_t is 4 bytes (most Unix systems).

This method is only available if Qt is configured with STL compatibility enabled.

See also fromUtf16(), fromLatin1(), fromLocal8Bit(), fromUtf8(), and fromUcs4().

QString QString::fromUcs4 ( const uint * unicode, int size = -1 )   [static]

Returns a QString initialized with the first size characters of the Unicode string unicode (ISO-10646-UCS-4 encoded).

If size is -1 (the default), unicode must be terminated with a 0.

This function was introduced in Qt 4.2.

See also toUcs4(), fromUtf16(), utf16(), setUtf16(), and fromWCharArray().

QString QString::fromUtf8 ( const char * str, int size = -1 )   [static]

Returns a QString initialized with the first size bytes of the UTF-8 string str.

If size is -1 (the default), it is taken to be qstrlen(str).

See also toUtf8(), fromAscii(), fromLatin1(), and fromLocal8Bit().

QString QString::fromUtf16 ( const ushort * unicode, int size = -1 )   [static]

Returns a QString initialized with the first size characters of the Unicode string unicode (ISO-10646-UTF-16 encoded).

If size is -1 (the default), unicode must be terminated with a 0.

QString makes a deep copy of the Unicode data.

See also utf16() and setUtf16().

QString QString::fromWCharArray ( const wchar_t * string, int size = -1 )   [static]

Returns a copy of the string string encoded in ucs4.

If size is -1 (the default), the string has to be 0 terminated.

This function was introduced in Qt 4.2.

See also fromUtf16(), fromLatin1(), fromLocal8Bit(), fromUtf8(), fromUcs4(), and fromStdWString().

int QString::indexOf ( const QString & str, int from = 0, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

Returns the index position of the first occurrence of the string str in this string, searching forward from index position from. Returns -1 if str is not found.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

Example:

     QString x = "sticky question";
     QString y = "sti";
     x.indexOf(y);               // returns 0
     x.indexOf(y, 1);            // returns 10
     x.indexOf(y, 10);           // returns 10
     x.indexOf(y, 11);           // returns -1

If from is -1, the search starts at the last character; if it is -2, at the next to last character and so on.

See also lastIndexOf(), contains(), and count().

int QString::indexOf ( QChar ch, int from = 0, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

Returns the index position of the first occurrence of the character ch in the string, searching forward from index position from. Returns -1 if ch could not be found.

int QString::indexOf ( const QRegExp & rx, int from = 0 ) const

This is an overloaded member function, provided for convenience.

Returns the index position of the first match of the regular expression rx in the string, searching forward from index position from. Returns -1 if rx didn't match anywhere.

Example:

     QString str = "the minimum";
     str.indexOf(QRegExp("m[aeiou]"), 0);       // returns 4

QString & QString::insert ( int position, const QString & str )

Inserts the string str at the given index position and returns a reference to this string.

Example:

     QString str = "Meal";
     str.insert(1, QString("ontr"));
     // str == "Montreal"

If the given position is greater than size(), the array is first extended using resize().

See also append(), prepend(), replace(), and remove().

QString & QString::insert ( int position, const QLatin1String & str )

This is an overloaded member function, provided for convenience.

Inserts the Latin-1 string str at the given index position.

QString & QString::insert ( int position, const QChar * unicode, int size )

This is an overloaded member function, provided for convenience.

Inserts the first size characters of the QChar array unicode at the given index position in the string.

QString & QString::insert ( int position, QChar ch )

This is an overloaded member function, provided for convenience.

Inserts ch at the given index position in the string.

bool QString::isEmpty () const

Returns true if the string has no characters; otherwise returns false.

Example:

     QString().isEmpty();            // returns true
     QString("").isEmpty();          // returns true
     QString("x").isEmpty();         // returns false
     QString("abc").isEmpty();       // returns false

See also size().

bool QString::isNull () const

Returns true if this string is null; otherwise returns false.

Example:

     QString().isNull();             // returns true
     QString("").isNull();           // returns false
     QString("abc").isNull();        // returns false

Qt makes a distinction between null strings and empty strings for historical reasons. For most applications, what matters is whether or not a string contains any data, and this can be determined using the isEmpty() function.

See also isEmpty().

int QString::lastIndexOf ( const QString & str, int from = -1, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

Returns the index position of the last occurrence of the string str in this string, searching backward from index position from. If from is -1 (the default), the search starts at the last character; if from is -2, at the next to last character and so on. Returns -1 if str is not found.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

Example:

     QString x = "crazy azimuths";
     QString y = "az";
     x.lastIndexOf(y);           // returns 6
     x.lastIndexOf(y, 6);        // returns 6
     x.lastIndexOf(y, 5);        // returns 2
     x.lastIndexOf(y, 1);        // returns -1

See also indexOf(), contains(), and count().

int QString::lastIndexOf ( QChar ch, int from = -1, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

Returns the index position of the last occurrence of the character ch, searching backward from position from.

int QString::lastIndexOf ( const QRegExp & rx, int from = -1 ) const

This is an overloaded member function, provided for convenience.

Returns the index position of the last match of the regular expression rx in the string, searching backward from index position from. Returns -1 if rx didn't match anywhere.

Example:

     QString str = "the minimum";
     str.lastIndexOf(QRegExp("m[aeiou]"));      // returns 8

QString QString::left ( int n ) const

Returns a substring that contains the n leftmost characters of the string.

The entire string is returned if n is greater than size() or less than zero.

     QString x = "Pineapple";
     QString y = x.left(4);      // y == "Pine"

See also right(), mid(), and startsWith().

QString QString::leftJustified ( int width, QChar fill = QLatin1Char( ' ' ), bool truncate = false ) const

Returns a string of size width that contains this string padded by the fill character.

If truncate is false and the size() of the string is more than width, then the returned string is a copy of the string.

     QString s = "apple";
     QString t = s.leftJustified(8, '.');    // t == "apple..."

If truncate is true and the size() of the string is more than width, then any characters in a copy of the string after position width are removed, and the copy is returned.

     QString str = "Pineapple";
     str = str.leftJustified(5, '.', true);    // str == "Pinea"

See also rightJustified().

int QString::length () const

Returns the number of characters in this string. Equivalent to size().

See also setLength().

int QString::localeAwareCompare ( const QString & s1, const QString & s2 )   [static]

Compares s1 with s2 and returns an integer less than, equal to, or greater than zero if s1 is less than, equal to, or greater than s2.

The comparison is performed in a locale- and also platform-dependent manner. Use this function to present sorted lists of strings to the user.

See also compare() and QTextCodec::locale().

int QString::localeAwareCompare ( const QString & other ) const

This is an overloaded member function, provided for convenience.

Compares this string with the other string and returns an integer less than, equal to, or greater than zero if this string is less than, equal to, or greater than the other string.

Same as localeAwareCompare(*this, other).

QString QString::mid ( int position, int n = -1 ) const

Returns a string that contains n characters of this string, starting at the specified position index.

Returns an empty string if the position index exceeds the length of the string. If there are less than n characters available in the string starting at the given position, or if n is -1 (the default), the function returns all characters that are available from the specified position.

Example:

     QString x = "Nine pineapples";
     QString y = x.mid(5, 4);            // y == "pine"
     QString z = x.mid(5);               // z == "pineapples"

See also left() and right().

QString QString::normalized ( NormalizationForm form ) const

Returns the string in the given Unicode normalization form.

QString QString::normalized ( NormalizationForm form, QChar::UnicodeVersion version ) const

This is an overloaded member function, provided for convenience.

Returns the string in the given Unicode normalization form, according to the given version of the Unicode standard.

QString QString::number ( long n, int base = 10 )   [static]

Returns a string equivalent of the number n according to the specified base.

The base is 10 by default and must be between 2 and 36. For bases other than 10, n is treated as an unsigned integer.

     long a = 63;
     QString s = QString::number(a, 16);             // s == "3f"
     QString t = QString::number(a, 16).toUpper();     // t == "3F"

See also setNum().

QString QString::number ( ulong n, int base = 10 )   [static]

This is an overloaded member function, provided for convenience.

QString QString::number ( int n, int base = 10 )   [static]

This is an overloaded member function, provided for convenience.

QString QString::number ( uint n, int base = 10 )   [static]

This is an overloaded member function, provided for convenience.

QString QString::number ( qlonglong n, int base = 10 )   [static]

This is an overloaded member function, provided for convenience.

QString QString::number ( qulonglong n, int base = 10 )   [static]

This is an overloaded member function, provided for convenience.

QString QString::number ( double n, char format = 'g', int precision = 6 )   [static]

This is an overloaded member function, provided for convenience.

Returns a string equivalent of the number n, formatted according to the specified format and precision. The format can be 'f', 'F', 'e', 'E', 'g' or 'G' (see arg() for an explanation of the formats).

Unlike QLocale::toString(), this function does not honor the user's locale settings.

See also setNum() and QLocale::toString().

QString & QString::prepend ( const QString & str )

Prepends the string str to the beginning of this string and returns a reference to this string.

Example:

     QString x = "ship";
     QString y = "air";
     x.prepend(y);
     // x == "airship"

See also append() and insert().

QString & QString::prepend ( const QLatin1String & str )

This is an overloaded member function, provided for convenience.

Prepends the Latin-1 string str to this string.

QString & QString::prepend ( const QByteArray & ba )

This is an overloaded member function, provided for convenience.

Prepends the byte array ba to this string. The byte array is converted to Unicode using the fromAscii() function.

You can disable this function by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::prepend ( const char * str )

This is an overloaded member function, provided for convenience.

Prepends the string str to this string. The const char pointer is converted to Unicode using the fromAscii() function.

You can disable this function by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::prepend ( QChar ch )

This is an overloaded member function, provided for convenience.

Prepends the character ch to this string.

void QString::push_back ( const QString & other )

This function is provided for STL compatibility, appending the given other string onto the end of this string. It is equivalent to append(other).

See also append().

void QString::push_back ( QChar ch )

This is an overloaded member function, provided for convenience.

Appends the given ch character onto the end of this string.

void QString::push_front ( const QString & other )

This function is provided for STL compatibility, prepending the given other string to the beginning of this string. It is equivalent to prepend(other).

See also prepend().

void QString::push_front ( QChar ch )

This is an overloaded member function, provided for convenience.

Prepends the given ch character to the beginning of this string.

QString & QString::remove ( int position, int n )

Removes n characters from the string, starting at the given position index, and returns a reference to the string.

If the specified position index is within the string, but position + n is beyond the end of the string, the string is truncated at the specified position.

     QString s = "Montreal";
     s.remove(1, 4);
     // s == "Meal"

See also insert() and replace().

QString & QString::remove ( const QString & str, Qt::CaseSensitivity cs = Qt::CaseSensitive )

This is an overloaded member function, provided for convenience.

Removes every occurrence of the given str string in this string, and returns a reference to this string.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

This is the same as replace(str, "", cs).

See also replace().

QString & QString::remove ( QChar ch, Qt::CaseSensitivity cs = Qt::CaseSensitive )

This is an overloaded member function, provided for convenience.

Removes every occurrence of the character ch in this string, and returns a reference to this string.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

Example:

     QString t = "Ali Baba";
     t.remove(QChar('a'), Qt::CaseInsensitive);
     // t == "li Bb"

This is the same as replace(ch, "", cs).

See also replace().

QString & QString::remove ( const QRegExp & rx )

This is an overloaded member function, provided for convenience.

Removes every occurrence of the regular expression rx in the string, and returns a reference to the string. For example:

     QString r = "Telephone";
     r.remove(QRegExp("[aeiou]."));
     // r == "The"

See also indexOf(), lastIndexOf(), and replace().

QString & QString::replace ( int position, int n, const QString & after )

Replaces n characters from the specified index position with the string after, and returns a reference to this string.

Example:

     QString x = "Say yes!";
     QString y = "no";
     x.replace(4, 3, y);
     // x == "Say no!"

See also insert() and remove().

QString & QString::replace ( int position, int n, const QChar * unicode, int size )

This is an overloaded member function, provided for convenience.

Replaces n characters from the specified index position with the first size characters of the QChar array unicode.

QString & QString::replace ( int position, int n, QChar after )

This is an overloaded member function, provided for convenience.

Replaces n characters from the specified index position with the character after.

QString & QString::replace ( const QString & before, const QString & after, Qt::CaseSensitivity cs = Qt::CaseSensitive )

This is an overloaded member function, provided for convenience.

Replaces every occurrence of the string before with the string after.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

Example:

     QString str = "colour behaviour flavour neighbour";
     str.replace(QString("ou"), QString("o"));
     // str == "color behavior flavor neighbor"

QString & QString::replace ( QChar ch, const QString & after, Qt::CaseSensitivity cs = Qt::CaseSensitive )

This is an overloaded member function, provided for convenience.

Replaces every occurrence of the character ch in the string with after. Returns a reference to the string.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

QString & QString::replace ( QChar before, QChar after, Qt::CaseSensitivity cs = Qt::CaseSensitive )

This is an overloaded member function, provided for convenience.

Replaces every occurrence of the character before with the character after. Returns a reference to the string.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

QString & QString::replace ( const QRegExp & rx, const QString & after )

This is an overloaded member function, provided for convenience.

Replaces every occurrence of the regular expression rx in the string with after. Returns a reference to the string. For example:

     QString s = "Banana";
     s.replace(QRegExp("a[mn]"), "ox");
     // s == "Boxoxa"

For regular expressions containing capturing parentheses, occurrences of \1, \2, ..., in after are replaced with rx.cap(1), cap(2), ...

     QString t = "A <i>bon mot</i>.";
     t.replace(QRegExp("<i>([^<]*)</i>"), "\\emph{\\1}");
     // t == "A \\emph{bon mot}."

See also indexOf(), lastIndexOf(), remove(), and QRegExp::cap().

void QString::reserve ( int size )

Attempts to allocate memory for at least size characters. If you know in advance how large the string will be, you can call this function, and if you resize the string often you are likely to get better performance. If size is an underestimate, the worst that will happen is that the QString will be a bit slower.

The sole purpose of this function is to provide a means of fine tuning QString's memory usage. In general, you will rarely ever need to call this function. If you want to change the size of the string, call resize().

This function is useful for code that needs to build up a long string and wants to avoid repeated reallocation. In this example, we want to add to the string until some condition is true, and we're fairly sure that size is large enough to make a call to reserve() worthwhile:

     QString result;
     int maxSize;
     bool condition;
     QChar nextChar;

     result.reserve(maxSize);

     while (condition)
         result.append(nextChar);

     result.squeeze();

See also squeeze() and capacity().

void QString::resize ( int size )

Sets the size of the string to size characters.

If size is greater than the current size, the string is extended to make it size characters long with the extra characters added to the end. The new characters are uninitialized.

If size is less than the current size, characters are removed from the end.

Example:

     QString s = "Hello world";
     s.resize(5);
     // s == "Hello"

     s.resize(8);
     // s == "Hello???" (where ? stands for any character)

If you want to append a certain number of identical characters to the string, use operator+=() as follows rather than resize():

     QString t = "Hello";
     t += QString(10, 'X');
     // t == "HelloXXXXXXXXXX"

If you want to expand the string so that it reaches a certain width and fill the new positions with a particular character, use the leftJustified() function:

     QString r = "Hello";
     r = r.leftJustified(10, ' ');
     // r == "Hello     "

See also truncate() and reserve().

QString QString::right ( int n ) const

Returns a substring that contains the n rightmost characters of the string.

The entire string is returned if n is greater than size() or less than zero.

     QString x = "Pineapple";
     QString y = x.right(5);      // y == "apple"

See also left(), mid(), and endsWith().

QString QString::rightJustified ( int width, QChar fill = QLatin1Char( ' ' ), bool truncate = false ) const

Returns a string of size() width that contains the fill character followed by the string. For example:

     QString s = "apple";
     QString t = s.rightJustified(8, '.');    // t == "...apple"

If truncate is false and the size() of the string is more than width, then the returned string is a copy of the string.

If truncate is true and the size() of the string is more than width, then the resulting string is truncated at position width.

     QString str = "Pineapple";
     str = str.rightJustified(5, '.', true);    // str == "Pinea"

See also leftJustified().

QString QString::section ( QChar sep, int start, int end = -1, SectionFlags flags = SectionDefault ) const

This function returns a section of the string.

This string is treated as a sequence of fields separated by the character, sep. The returned string consists of the fields from position start to position end inclusive. If end is not specified, all fields from position start to the end of the string are included. Fields are numbered 0, 1, 2, etc., counting from the left, and -1, -2, etc., counting from right to left.

The flags argument can be used to affect some aspects of the function's behavior, e.g. whether to be case sensitive, whether to skip empty fields and how to deal with leading and trailing separators; see SectionFlags.

     QString str;
     QString csv = "forename,middlename,surname,phone";
     QString path = "/usr/local/bin/myapp"; // First field is empty
     QString::SectionFlag flag = QString::SectionSkipEmpty;

     str = csv.section(',', 2, 2);   // str == "surname"
     str = path.section('/', 3, 4);  // str == "bin/myapp"
     str = path.section('/', 3, 3, flag); // str == "myapp"

If start or end is negative, we count fields from the right of the string, the right-most field being -1, the one from right-most field being -2, and so on.

     str = csv.section(',', -3, -2);  // str == "middlename,surname"
     str = path.section('/', -1); // str == "myapp"

See also split().

QString QString::section ( const QString & sep, int start, int end = -1, SectionFlags flags = SectionDefault ) const

This is an overloaded member function, provided for convenience.

     QString str;
     QString data = "forename**middlename**surname**phone";

     str = data.section("**", 2, 2); // str == "surname"
     str = data.section("**", -3, -2); // str == "middlename**surname"

See also split().

QString QString::section ( const QRegExp & reg, int start, int end = -1, SectionFlags flags = SectionDefault ) const

This is an overloaded member function, provided for convenience.

This string is treated as a sequence of fields separated by the regular expression, reg.

     QString line = "forename\tmiddlename  surname \t \t phone";
     QRegExp sep("\\s+");
     str = line.section(sep, 2, 2); // s == "surname"
     str = line.section(sep, -3, -2); // s == "middlename  surname"

Warning: Using this QRegExp version is much more expensive than the overloaded string and character versions.

See also split() and simplified().

QString & QString::setNum ( int n, int base = 10 )

Sets the string to the printed value of n in the specified base, and returns a reference to the string.

The base is 10 by default and must be between 2 and 36. For bases other than 10, n is treated as an unsigned integer.

     QString str;
     str.setNum(1234);       // str == "1234"

QString & QString::setNum ( uint n, int base = 10 )

This is an overloaded member function, provided for convenience.

QString & QString::setNum ( long n, int base = 10 )

This is an overloaded member function, provided for convenience.

QString & QString::setNum ( ulong n, int base = 10 )

This is an overloaded member function, provided for convenience.

QString & QString::setNum ( qlonglong n, int base = 10 )

This is an overloaded member function, provided for convenience.

QString & QString::setNum ( qulonglong n, int base = 10 )

This is an overloaded member function, provided for convenience.

QString & QString::setNum ( short n, int base = 10 )

This is an overloaded member function, provided for convenience.

QString & QString::setNum ( ushort n, int base = 10 )

This is an overloaded member function, provided for convenience.

QString & QString::setNum ( double n, char format = 'g', int precision = 6 )

This is an overloaded member function, provided for convenience.

Sets the string to the printed value of n, formatted according to the given format and precision, and returns a reference to the string.

The format can be 'f', 'F', 'e', 'E', 'g' or 'G' (see arg() for an explanation of the formats).

Unlike QLocale::toString(), this function doesn't honor the user's locale settings.

QString & QString::setNum ( float n, char format = 'g', int precision = 6 )

This is an overloaded member function, provided for convenience.

Sets the string to the printed value of n, formatted according to the given format and precision, and returns a reference to the string.

QString & QString::setUnicode ( const QChar * unicode, int size )

Resizes the string to size characters and copies unicode into the string.

If unicode is 0, nothing is copied, but the string is still resized to size.

See also unicode() and setUtf16().

QString & QString::setUtf16 ( const ushort * unicode, int size )

Resizes the string to size characters and copies unicode into the string.

If unicode is 0, nothing is copied, but the string is still resized to size.

See also utf16() and setUnicode().

QString QString::simplified () const

Returns a string that has whitespace removed from the start and the end, and that has each sequence of internal whitespace replaced with a single space.

Whitespace means any character for which QChar::isSpace() returns true. This includes the ASCII characters '\t', '\n', '\v', '\f', '\r', and ' '.

Example:

     QString str = "  lots\t of\nwhitespace\r\n ";
     str = str.simplified();
     // str == "lots of whitespace";

See also trimmed().

int QString::size () const

Returns the number of characters in this string.

The last character in the string is at position size() - 1. In addition, QString ensures that the character at position size() is always '\0', so that you can use the return value of data() and constData() as arguments to functions that expect '\0'-terminated strings.

Example:

     QString str = "World";
     int n = str.size();         // n == 5
     str.data()[0];              // returns 'W'
     str.data()[4];              // returns 'd'
     str.data()[5];              // returns '\0'

See also isEmpty() and resize().

QStringList QString::split ( const QString & sep, SplitBehavior behavior = KeepEmptyParts, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

Splits the string into substrings wherever sep occurs, and returns the list of those strings. If sep does not match anywhere in the string, split() returns a single-element list containing this string.

cs specifies whether sep should be matched case sensitively or case insensitively.

If behavior is QString::SkipEmptyParts, empty entries don't appear in the result. By default, empty entries are kept.

Example:

     QString str = "a,,b,c";

     QStringList list1 = str.split(",");
     // list1: [ "a", "", "b", "c" ]

     QStringList list2 = str.split(",", QString::SkipEmptyParts);
     // list2: [ "a", "b", "c" ]

See also QStringList::join() and section().

QStringList QString::split ( const QChar & sep, SplitBehavior behavior = KeepEmptyParts, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

QStringList QString::split ( const QRegExp & rx, SplitBehavior behavior = KeepEmptyParts ) const

This is an overloaded member function, provided for convenience.

Splits the string into substrings wherever the regular expression rx matches, and returns the list of those strings. If rx does not match anywhere in the string, split() returns a single-element list containing this string.

Here's an example where we extract the words in a sentence using one or more whitespace characters as the separator:

     QString str;
     QStringList list;

     str = "Some  text\n\twith  strange whitespace.";
     list = str.split(QRegExp("\\s+"));
     // list: [ "Some", "text", "with", "strange", "whitespace." ]

Here's a similar example, but this time we use any sequence of non-word characters as the separator:

     str = "This time, a normal English sentence.";
     list = str.split(QRegExp("\\W+"), QString::SkipEmptyParts);
     // list: [ "This", "time", "a", "normal", "English", "sentence" ]

Here's a third example where we use a zero-length assertion, \b (word boundary), to split the string into an alternating sequence of non-word and word tokens:

     str = "Now: this sentence fragment.";
     list = str.split(QRegExp("\\b"));
     // list: [ "", "Now", ": ", "this", " ", "sentence", " ", "fragment", "." ]

See also QStringList::join() and section().

QString & QString::sprintf ( const char * cformat, ... )

Safely builds a formatted string from the format string cformat and an arbitrary list of arguments.

The %lc escape sequence expects a unicode character of type ushort (as returned by QChar::unicode()). The %ls escape sequence expects a pointer to a zero-terminated array of unicode characters of type ushort (as returned by QString::utf16()).

The format string supports most of the conversion specifiers provided by printf() in the standard C++ library. It doesn't honor the length modifiers (e.g. h for short, ll for long long). If you need those, use the standard snprintf() function instead:

     size_t BufSize;
     char buf[BufSize];

     ::snprintf(buf, BufSize, "%lld", 123456789LL);
     QString str = QString::fromAscii(buf);

Warning: We do not recommend using QString::sprintf() in new Qt code. Instead, consider using QTextStream or arg(), both of which support Unicode strings seamlessly and are type-safe. Here's an example that uses QTextStream:

     QString result;
     QTextStream(&result) << "pi = " << 3.14;
     // result == "pi = 3.14"

For translations, especially if the strings contains more than one escape sequence, you should consider using the arg() function instead. This allows the order of the replacements to be controlled by the translator.

See also arg().

void QString::squeeze ()

Releases any memory not required to store the character data.

The sole purpose of this function is to provide a means of fine tuning QString's memory usage. In general, you will rarely ever need to call this function.

See also reserve() and capacity().

bool QString::startsWith ( const QString & s, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

Returns true if the string starts with s; otherwise returns false.

If cs is Qt::CaseSensitive (the default), the search is case sensitive; otherwise the search is case insensitive.

     QString str = "Bananas";
     str.startsWith("Ban");     // returns true
     str.startsWith("Car");     // returns false

See also endsWith().

bool QString::startsWith ( const QLatin1String & s, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

bool QString::startsWith ( const QChar & c, Qt::CaseSensitivity cs = Qt::CaseSensitive ) const

This is an overloaded member function, provided for convenience.

Returns true if the string starts with c; otherwise returns false.

QByteArray QString::toAscii () const

Returns an 8-bit ASCII representation of the string as a QByteArray.

If a codec has been set using QTextCodec::setCodecForCStrings(), it is used to convert Unicode to 8-bit char; otherwise this function does the same as toLatin1().

See also fromAscii(), toLatin1(), toUtf8(), toLocal8Bit(), and QTextCodec.

double QString::toDouble ( bool * ok = 0 ) const

Returns the string converted to a double value.

Returns 0.0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

     QString str = "1234.56";
     double val = str.toDouble();   // val == 1234.56

Various string formats for floating point numbers can be converted to double values:

     bool ok;
     double d;

     d = QString( "1234.56e-02" ).toDouble(&ok); // ok == true, d == 12.3456

This function tries to interpret the string according to the current locale. The current locale is determined from the system at application startup and can be changed by calling QLocale::setDefault(). If the string cannot be interpreted according to the current locale, this function falls back on the "C" locale.

     QLocale::setDefault(QLocale::C);
     d = QString( "1234,56" ).toDouble(&ok); // ok == false
     d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56

     QLocale::setDefault(QLocale::German);
     d = QString( "1234,56" ).toDouble(&ok); // ok == true, d == 1234.56
     d = QString( "1234.56" ).toDouble(&ok); // ok == true, d == 1234.56

Due to the ambiguity between the decimal point and thousands group separator in various locales, this function does not handle thousands group separators. If you need to convert such numbers, see QLocale::toDouble().

     QLocale::setDefault(QLocale::C);
     d = QString( "1234,56" ).toDouble(&ok); // ok == false

Warning: If the string contains trailing whitespace this function will fail, and set *ok to false if ok is not 0. Leading whitespace is ignored.

See also number(), QLocale::setDefault(), QLocale::toDouble(), and trimmed().

float QString::toFloat ( bool * ok = 0 ) const

Returns the string converted to a float value.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true. Returns 0.0 if the conversion fails.

Example:

     QString str1 = "1234.56";
     str1.toFloat();             // returns 1234.56

     bool ok;
     QString str2 = "R2D2";
     str2.toFloat(&ok);          // returns 0.0, sets ok to false

See also number(), toDouble(), and toInt().

int QString::toInt ( bool * ok = 0, int base = 10 ) const

Returns the string converted to an int using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

Example:

     QString str = "FF";
     bool ok;
     int hex = str.toInt(&ok, 16);       // hex == 255, ok == true
     int dec = str.toInt(&ok, 10);       // dec == 0, ok == false

See also number(), toUInt(), and toDouble().

QByteArray QString::toLatin1 () const

Returns a Latin-1 representation of the string as a QByteArray. The returned byte array is undefined if the string contains non-Latin1 characters.

See also fromLatin1(), toAscii(), toUtf8(), toLocal8Bit(), and QTextCodec.

QByteArray QString::toLocal8Bit () const

Returns the local 8-bit representation of the string as a QByteArray. The returned byte array is undefined if the string contains characters not supported by the local 8-bit encoding.

QTextCodec::codecForLocale() is used to perform the conversion from Unicode.

See also fromLocal8Bit(), toAscii(), toLatin1(), toUtf8(), and QTextCodec.

long QString::toLong ( bool * ok = 0, int base = 10 ) const

Returns the string converted to a long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

Example:

     QString str = "FF";
     bool ok;

     long hex = str.toLong(&ok, 16);     // hex == 255, ok == true
     long dec = str.toLong(&ok, 10);     // dec == 0, ok == false

See also number(), toULong(), and toInt().

qlonglong QString::toLongLong ( bool * ok = 0, int base = 10 ) const

Returns the string converted to a long long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

Example:

     QString str = "FF";
     bool ok;

     qint64 hex = str.toLongLong(&ok, 16);      // hex == 255, ok == true
     qint64 dec = str.toLongLong(&ok, 10);      // dec == 0, ok == false

See also number(), toULongLong(), and toInt().

QString QString::toLower () const

Returns a lowercase copy of the string.

     QString str = "TROlltECH";
     str = str.toLower();        // str == "trolltech"

See also toUpper().

short QString::toShort ( bool * ok = 0, int base = 10 ) const

Returns the string converted to a short using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

Example:

     QString str = "FF";
     bool ok;

     short hex = str.toShort(&ok, 16);   // hex == 255, ok == true
     short dec = str.toShort(&ok, 10);   // dec == 0, ok == false

See also number(), toUShort(), and toInt().

std::string QString::toStdString () const

Returns a std::string object with the data contained in this QString. The Unicode data is converted into 8-bit characters using the toAscii() function.

This operator is mostly useful to pass a QString to a function that accepts a std::string object.

If the QString contains non-ASCII Unicode characters, using this operator can lead to loss of information. You can disable this operator by defining QT_NO_CAST_TO_ASCII when you compile your applications. You then need to call toAscii() (or toLatin1() or toUtf8() or toLocal8Bit()) explicitly if you want to convert the data to const char * and pass the return value on to the std::string constructor.

This operator is only available if Qt is configured with STL compatibility enabled.

See also toAscii(), toLatin1(), toUtf8(), and toLocal8Bit().

std::wstring QString::toStdWString () const

Returns a std::wstring object with the data contained in this QString. The std::wstring is encoded in utf16 on platforms where wchar_t is 2 bytes wide (e.g. windows) and in ucs4 on platforms where wchar_t is 4 bytes wide (most Unix systems).

This operator is mostly useful to pass a QString to a function that accepts a std::wstring object.

This operator is only available if Qt is configured with STL compatibility enabled.

See also utf16(), toAscii(), toLatin1(), toUtf8(), and toLocal8Bit().

uint QString::toUInt ( bool * ok = 0, int base = 10 ) const

Returns the string converted to an unsigned int using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

Example:

     QString str = "FF";
     bool ok;

     uint hex = str.toUInt(&ok, 16);     // hex == 255, ok == true
     uint dec = str.toUInt(&ok, 10);     // dec == 0, ok == false

See also number() and toInt().

ulong QString::toULong ( bool * ok = 0, int base = 10 ) const

Returns the string converted to an unsigned long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

Example:

     QString str = "FF";
     bool ok;

     ulong hex = str.toULong(&ok, 16);   // hex == 255, ok == true
     ulong dec = str.toULong(&ok, 10);   // dec == 0, ok == false

See also number().

qulonglong QString::toULongLong ( bool * ok = 0, int base = 10 ) const

Returns the string converted to an unsigned long long using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

Example:

     QString str = "FF";
     bool ok;

     quint64 hex = str.toULongLong(&ok, 16);    // hex == 255, ok == true
     quint64 dec = str.toULongLong(&ok, 10);    // dec == 0, ok == false

See also number() and toLongLong().

ushort QString::toUShort ( bool * ok = 0, int base = 10 ) const

Returns the string converted to an unsigned short using base base, which is 10 by default and must be between 2 and 36, or 0. Returns 0 if the conversion fails.

If a conversion error occurs, *ok is set to false; otherwise *ok is set to true.

If base is 0, the C language convention is used: If the string begins with "0x", base 16 is used; if the string begins with "0", base 8 is used; otherwise, base 10 is used.

Example:

     QString str = "FF";
     bool ok;

     ushort hex = str.toUShort(&ok, 16);     // hex == 255, ok == true
     ushort dec = str.toUShort(&ok, 10);     // dec == 0, ok == false

See also number() and toShort().

QVector<uint> QString::toUcs4 () const

Returns a UCS-4 representation of the string as a QVector<uint>.

This function was introduced in Qt 4.2.

See also fromUtf8(), toAscii(), toLatin1(), toLocal8Bit(), QTextCodec, fromUcs4(), and toWCharArray().

QString QString::toUpper () const

Returns an uppercase copy of the string.

     QString str = "TeXt";
     str = str.toUpper();        // str == "TEXT"

See also toLower().

QByteArray QString::toUtf8 () const

Returns a UTF-8 representation of the string as a QByteArray.

See also fromUtf8(), toAscii(), toLatin1(), toLocal8Bit(), and QTextCodec.

int QString::toWCharArray ( wchar_t * array ) const

Fills the array with the data contained in this QString object. The array is encoded in utf16 on platforms where wchar_t is 2 bytes wide (e.g. windows) and in ucs4 on platforms where wchar_t is 4 bytes wide (most Unix systems).

array has to be allocated by the caller and contain enough space to hold the complete string (allocating the array with the same length as the string is always sufficient).

returns the actual length of the string in array.

This function was introduced in Qt 4.2.

See also utf16(), toUcs4(), toAscii(), toLatin1(), toUtf8(), toLocal8Bit(), and toStdWString().

QString QString::trimmed () const

Returns a string that has whitespace removed from the start and the end.

Whitespace means any character for which QChar::isSpace() returns true. This includes the ASCII characters '\t', '\n', '\v', '\f', '\r', and ' '.

Example:

     QString str = "  lots\t of\nwhitespace\r\n ";
     str = str.trimmed();
     // str == "lots\t of\nwhitespace"

Unlike simplified(), trimmed() leaves internal whitespace alone.

See also simplified().

void QString::truncate ( int position )

Truncates the string at the given position index.

If the specified position index is beyond the end of the string, nothing happens.

Example:

     QString str = "Vladivostok";
     str.truncate(4);
     // str == "Vlad"

See also chop(), resize(), and left().

const QChar * QString::unicode () const

Returns a '\0'-terminated Unicode representation of the string. The result remains valid until the string is modified.

See also setUnicode() and utf16().

const ushort * QString::utf16 () const

Returns the QString as a '\0'-terminated array of unsigned shorts. The result remains valid until the string is modified.

See also setUtf16() and unicode().

QString & QString::vsprintf ( const char * cformat, va_list ap )

Equivalent method to sprintf(), but takes a va_list ap instead a list of variable arguments. See the sprintf() documentation for an explanation of cformat.

This method does not call the va_end macro, the caller is responsible to call va_end on ap.

See also sprintf().

bool QString::operator!= ( const QString & other ) const

Returns true if this string is not equal to string other; otherwise returns false.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings with localeAwareCompare().

bool QString::operator!= ( const QLatin1String & other ) const

This is an overloaded member function, provided for convenience.

bool QString::operator!= ( const QByteArray & other ) const

This is an overloaded member function, provided for convenience.

The other byte array is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator!= ( const char * other ) const

This is an overloaded member function, provided for convenience.

The other const char pointer is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::operator+= ( const QString & other )

Appends the string other onto the end of this string and returns a reference to this string.

Example:

     QString x = "free";
     QString y = "dom";
     x += y;
     // x == "freedom"

This operation is typically very fast (constant time), because QString preallocates extra space at the end of the string data so it can grow without reallocating the entire string each time.

See also append() and prepend().

QString & QString::operator+= ( const QLatin1String & str )

This is an overloaded member function, provided for convenience.

Appends the Latin-1 string str to this string.

QString & QString::operator+= ( const QByteArray & ba )

This is an overloaded member function, provided for convenience.

Appends the byte array ba to this string. The byte array is converted to Unicode using the fromAscii() function.

You can disable this function by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::operator+= ( const char * str )

This is an overloaded member function, provided for convenience.

Appends the string str to this string. The const char pointer is converted to Unicode using the fromAscii() function.

You can disable this function by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::operator+= ( char ch )

This is an overloaded member function, provided for convenience.

Appends the character ch to this string. The character is converted to Unicode using the fromAscii() function.

You can disable this function by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::operator+= ( QChar ch )

This is an overloaded member function, provided for convenience.

Appends the character ch to the string.

bool QString::operator< ( const QString & other ) const

Returns true if this string is lexically less than string other; otherwise returns false.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings using the QString::localeAwareCompare() function.

bool QString::operator< ( const QLatin1String & other ) const

This is an overloaded member function, provided for convenience.

bool QString::operator< ( const QByteArray & other ) const

This is an overloaded member function, provided for convenience.

The other byte array is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator< ( const char * other ) const

This is an overloaded member function, provided for convenience.

The other const char pointer is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator<= ( const QString & other ) const

Returns true if this string is lexically less than or equal to string other; otherwise returns false.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings with localeAwareCompare().

bool QString::operator<= ( const QLatin1String & other ) const

This is an overloaded member function, provided for convenience.

bool QString::operator<= ( const QByteArray & other ) const

This is an overloaded member function, provided for convenience.

The other byte array is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator<= ( const char * other ) const

This is an overloaded member function, provided for convenience.

The other const char pointer is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::operator= ( const QString & other )

Assigns other to this string and returns a reference to this string.

QString & QString::operator= ( const QLatin1String & str )

This is an overloaded member function, provided for convenience.

Assigns the Latin-1 string str to this string.

QString & QString::operator= ( const QByteArray & ba )

This is an overloaded member function, provided for convenience.

Assigns ba to this string. The byte array is converted to Unicode using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for exaple.

QString & QString::operator= ( const char * str )

This is an overloaded member function, provided for convenience.

Assigns str to this string. The const char pointer is converted to Unicode using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::operator= ( char ch )

This is an overloaded member function, provided for convenience.

Assigns character ch to this string. The character is converted to Unicode using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QString & QString::operator= ( QChar ch )

This is an overloaded member function, provided for convenience.

Sets the string to contain the single character ch.

bool QString::operator== ( const QString & other ) const

Returns true if string other is equal to this string; otherwise returns false.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings with localeAwareCompare().

bool QString::operator== ( const QLatin1String & other ) const

This is an overloaded member function, provided for convenience.

bool QString::operator== ( const QByteArray & other ) const

This is an overloaded member function, provided for convenience.

The other byte array is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator== ( const char * other ) const

This is an overloaded member function, provided for convenience.

The other const char pointer is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator> ( const QString & other ) const

Returns true if this string is lexically greater than string other; otherwise returns false.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings with localeAwareCompare().

bool QString::operator> ( const QLatin1String & other ) const

This is an overloaded member function, provided for convenience.

bool QString::operator> ( const QByteArray & other ) const

This is an overloaded member function, provided for convenience.

The other byte array is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator> ( const char * other ) const

This is an overloaded member function, provided for convenience.

The other const char pointer is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator>= ( const QString & other ) const

Returns true if this string is lexically greater than or equal to string other; otherwise returns false.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings with localeAwareCompare().

bool QString::operator>= ( const QLatin1String & other ) const

This is an overloaded member function, provided for convenience.

bool QString::operator>= ( const QByteArray & other ) const

This is an overloaded member function, provided for convenience.

The other byte array is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

bool QString::operator>= ( const char * other ) const

This is an overloaded member function, provided for convenience.

The other const char pointer is converted to a QString using the fromAscii() function.

You can disable this operator by defining QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want to ensure that all user-visible strings go through QObject::tr(), for example.

QCharRef QString::operator[] ( int position )

Returns the character at the specified position in the string as a modifiable reference.

Example:

     QString str;

     if (str[0] == QChar('?'))
         str[0] = QChar('_');

The return value is of type QCharRef, a helper class for QString. When you get an object of type QCharRef, you can use it as if it were a QChar &. If you assign to it, the assignment will apply to the character in the QString from which you got the reference.

See also at().

const QChar QString::operator[] ( int position ) const

This is an overloaded member function, provided for convenience.

QCharRef QString::operator[] ( uint position )

This is an overloaded member function, provided for convenience.

Returns the character at the specified position in the string as a modifiable reference. Equivalent to at(position).

const QChar QString::operator[] ( uint position ) const

This is an overloaded member function, provided for convenience.

Related Non-Members

bool operator!= ( const char * s1, const QString & s2 )

This is an overloaded member function, provided for convenience.

Returns true if s1 is not equal to s2; otherwise returns false.

For s1 != 0, this is equivalent to compare(\a s1, \a s2) != 0. Note that no string is equal to s1 being 0.

See also QString::compare().

const QString operator+ ( const QString & s1, const QString & s2 )

This is an overloaded member function, provided for convenience.

Returns a string which is the result of concatenating s1 and s2.

const QString operator+ ( const QString & s1, const char * s2 )

This is an overloaded member function, provided for convenience.

Returns a string which is the result of concatenating s1 and s2 (s2 is converted to Unicode using the QString::fromAscii() function).

See also QString::fromAscii().

const QString operator+ ( const char * s1, const QString & s2 )

This is an overloaded member function, provided for convenience.

Returns a string which is the result of concatenating s1 and s2 (s1 is converted to Unicode using the QString::fromAscii() function).

See also QString::fromAscii().

const QString operator+ ( const QString & s, char ch )

This is an overloaded member function, provided for convenience.

Returns a string which is the result of concatenating the string s and the character ch.

const QString operator+ ( char ch, const QString & s )

This is an overloaded member function, provided for convenience.

Returns a string which is the result of concatenating the character ch and the string s.

bool operator< ( const char * s1, const QString & s2 )

This is an overloaded member function, provided for convenience.

Returns true if s1 is lexically less than s2; otherwise returns false. For s1 != 0, this is equivalent to compare(s1, s2) < 0.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings using the QString::localeAwareCompare() function.

See also QString::compare().

QDataStream & operator<< ( QDataStream & stream, const QString & string )

This is an overloaded member function, provided for convenience.

Writes the given string to the specified stream.

See also Format of the QDataStream Operators.

bool operator<= ( const char * s1, const QString & s2 )

This is an overloaded member function, provided for convenience.

Returns true if s1 is lexically less than or equal to s2; otherwise returns false. For s1 != 0, this is equivalent to compare(s1, s2) <= 0.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings with QString::localeAwareCompare().

See also QString::compare().

bool operator== ( const char * s1, const QString & s2 )

This is an overloaded member function, provided for convenience.

Returns true if s1 is equal to s2; otherwise returns false. Note that no string is equal to s1 being 0.

Equivalent to s1 != 0 && compare(s1, s2) == 0.

See also QString::compare().

bool operator> ( const char * s1, const QString & s2 )

This is an overloaded member function, provided for convenience.

Returns true if s1 is lexically greater than s2; otherwise returns false. Equivalent to compare(s1, s2) > 0.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings using the QString::localeAwareCompare() function.

See also QString::compare().

bool operator>= ( const char * s1, const QString & s2 )

This is an overloaded member function, provided for convenience.

Returns true if s1 is lexically greater than or equal to s2; otherwise returns false. For s1 != 0, this is equivalent to compare(s1, s2) >= 0.

The comparison is based exclusively on the numeric Unicode values of the characters and is very fast, but is not what a human would expect. Consider sorting user-interface strings using the QString::localeAwareCompare() function.

QDataStream & operator>> ( QDataStream & stream, QString & string )

This is an overloaded member function, provided for convenience.

Reads a string from the specified stream into the given string.

See also Format of the QDataStream Operators.

Macro Documentation

QT_NO_CAST_FROM_ASCII

Disables automatic conversions from 8-bit strings (char *) to unicode QStrings

See also QT_NO_CAST_TO_ASCII.

QT_NO_CAST_TO_ASCII

disables automatic conversion from QString to ASCII 8-bit strings (char *)

See also QT_NO_CAST_FROM_ASCII.

Member Function Documentation

const char * QString::ascii () const

Use toAscii() instead.

Warning: This function is not reentrant.

See also setAscii().

QChar QString::constref ( uint i ) const

Use at() instead.

bool QString::contains ( QChar c, bool cs ) const

This is an overloaded member function, provided for convenience.

Use the contains(QChar, Qt::CaseSensitive) overload instead.

bool QString::contains ( const QString & s, bool cs ) const

This is an overloaded member function, provided for convenience.

Use the contains(QString, Qt::CaseSensitive) overload instead.

QString QString::copy () const

Use simple assignment instead. QString is implicitly shared so if a copy is modified only the copy is changed.

bool QString::endsWith ( const QString & s, bool cs ) const

This is an overloaded member function, provided for convenience.

Use the endsWith(QString, Qt::CaseSensitive) overload instead.

int QString::find ( QChar c, int i = 0, bool cs = true ) const

Use indexOf() instead.

int QString::find ( const QString & s, int i = 0, bool cs = true ) const

This is an overloaded member function, provided for convenience.

Use indexOf() instead.

int QString::find ( const QRegExp & rx, int i = 0 ) const

This is an overloaded member function, provided for convenience.

Use indexOf() instead.

int QString::findRev ( QChar c, int i = -1, bool cs = true ) const

Use lastIndexOf() instead.

int QString::findRev ( const QString & s, int i = -1, bool cs = true ) const

This is an overloaded member function, provided for convenience.

Use lastIndexOf() instead.

int QString::findRev ( const QRegExp & rx, int i = -1 ) const

This is an overloaded member function, provided for convenience.

Use lastIndexOf() instead.

QString QString::fromUcs2 ( const ushort * unicode, int size = -1 )   [static]

Use fromUtf16() instead.

const char * QString::latin1 () const

Use toLatin1() instead.

Warning: This function is not reentrant.

See also setLatin1().

QString QString::leftJustify ( int width, QChar fill = QLatin1Char( ' ' ), bool trunc = false ) const

Use leftJustified() instead.

QByteArray QString::local8Bit () const

Use toLocal8Bit() instead.

Warning: This function is not reentrant.

QString QString::lower () const

Use toLower() instead.

QChar & QString::ref ( uint i )

Use operator[]() instead.

QString & QString::remove ( QChar c, bool cs )

This is an overloaded member function, provided for convenience.

Use the remove(QChar, Qt::CaseSensitive) overload instead.

QString & QString::remove ( const QString & s, bool cs )

This is an overloaded member function, provided for convenience.

Use the remove(QString, Qt::CaseSensitive) overload instead.

QString & QString::replace ( QChar c, const QString & after, bool cs )

This is an overloaded member function, provided for convenience.

Use the replace(QChar, QString, Qt::CaseSensitive) overload instead.

QString & QString::replace ( const QString & before, const QString & after, bool cs )

This is an overloaded member function, provided for convenience.

Use the replace(QString, QString, Qt::CaseSensitive) overload instead.

QString & QString::replace ( char c, const QString & after, bool cs )

This is an overloaded member function, provided for convenience.

Use the replace(QChar, QString, Qt::CaseSensitive) overload instead.

QString & QString::replace ( char c, const QString & after, Qt::CaseSensitivity cs )

This is an overloaded member function, provided for convenience.

Use the replace(QChar, QString, Qt::CaseSensitive) overload instead.

QString QString::rightJustify ( int width, QChar fill = QLatin1Char( ' ' ), bool trunc = false ) const

Use rightJustified() instead.

QString & QString::setAscii ( const char * str, int len = -1 )

Use fromAscii() instead.

See also ascii().

QString & QString::setLatin1 ( const char * str, int len = -1 )

Use fromLatin1() instead.

See also latin1().

void QString::setLength ( int nl )

Use resize() instead.

See also length().

QString & QString::setUnicodeCodes ( const ushort * unicode_as_ushorts, int size )

Use setUtf16() instead.

QString QString::simplifyWhiteSpace () const

Use simplified() instead.

bool QString::startsWith ( const QString & s, bool cs ) const

This is an overloaded member function, provided for convenience.

Use the startsWith(QString, Qt::CaseSensitive) overload instead.

QString QString::stripWhiteSpace () const

Use trimmed() instead.

const ushort * QString::ucs2 () const

Use utf16() instead.

QString QString::upper () const

Use toUpper() instead.

QByteArray QString::utf8 () const

Use toUtf8() instead.

Warning: This function is not reentrant.

QString::operator const char * () const

Use toAscii().constData() instead.