QCollator Class

QStringList sortedStrings(QStringList seq)
{
    QCollator order;
    std::sort(seq.begin(), seq.end(), order);
    return seq;
}

Member Function Documentation

QCollator::QCollator()

Constructs a QCollator using the default locale's collation locale.

The system locale, when used as default locale, may have a collation locale other than itself (e.g. on Unix, if LC_COLLATE is set differently to LANG in the environment). All other locales are their own collation locales.

See also setLocale(), QLocale::collation(), and QLocale::setDefault().

[explicit] QCollator::QCollator(const QLocale &locale)

Constructs a QCollator using the given locale.

See also setLocale().

QCollator::QCollator(const QCollator &other)

Creates a copy of other.

[noexcept] QCollator::QCollator(QCollator &&other)

Move constructor. Moves from other into this collator.

[noexcept] QCollator::~QCollator()

Destroys this collator.

Qt::CaseSensitivity QCollator::caseSensitivity() const

Returns case sensitivity of the collator.

This defaults to case-sensitive until set.

See also setCaseSensitivity().

int QCollator::compare(QStringView s1, QStringView s2) const

Compares s1 with s2.

Returns a negative integer if s1 is less than s2, a positive integer if it is greater than s2, and zero if they are equal.

int QCollator::compare(const QString &s1, const QString &s2) const

int QCollator::compare(const QChar *s1, qsizetype len1, const QChar *s2, qsizetype len2) const

Compares s1 with s2. len1 and len2 specify the lengths of the QChar arrays pointed to by s1 and s2.

Returns a negative integer if s1 is less than s2, a positive integer if it is greater than s2, and zero if they are equal.

[static, since 6.3] int QCollator::defaultCompare(QStringView s1, QStringView s2)

Compares the strings s1 and s2, returning their sorting order. This function performs the same operation as compare() on a default-constructed QCollator object.

This function was introduced in Qt 6.3.

See also compare() and defaultSortKey().

[static, since 6.3] QCollatorSortKey QCollator::defaultSortKey(QStringView key)

Returns the sort key for the string key. This function performs the same operation as sortKey() on a default-constructed QCollator object.

This function was introduced in Qt 6.3.

See also sortKey() and defaultCompare().

bool QCollator::ignorePunctuation() const

Returns whether punctuation and symbols are ignored when collating.

When true, strings are compared as if all punctuation and symbols were removed from each string.

See also setIgnorePunctuation().

QLocale QCollator::locale() const

Returns the locale of the collator.

Unless supplied to the constructor or by calling setLocale(), the system's default collation locale is used.

See also setLocale() and QLocale::collation().

bool QCollator::numericMode() const

Returns true if numeric sorting is enabled, false otherwise.

When true, numerals are recognized as numbers and sorted in arithmetic order; for example, 100 sortes after 99. When false, numbers are sorted in lexical order, so that 100 sorts before 99 (because 1 is before 9). By default, this option is disabled.

See also setNumericMode().

[since 6.13] QCollator::CollationOptions QCollator::options() const

Returns the collation options currently set on the collator.

This function was introduced in Qt 6.13.

See also setOptions() and CollationOption.

void QCollator::setCaseSensitivity(Qt::CaseSensitivity cs)

Sets the case-sensitivity of the collator to cs.

See also caseSensitivity().

void QCollator::setIgnorePunctuation(bool on)

Ignores punctuation and symbols if on is true, attends to them if false.

See also ignorePunctuation().

void QCollator::setLocale(const QLocale &locale)

Sets the locale of the collator to locale.

See also locale().

void QCollator::setNumericMode(bool on)

Enables numeric sorting mode when on is true.

See also numericMode().

[since 6.13] void QCollator::setOptions(QCollator::CollationOptions options)

Sets the collation options to options. This allows configuring multiple collation settings at once.

This function was introduced in Qt 6.13.

See also options() and CollationOption.

QCollatorSortKey QCollator::sortKey(const QString &string) const

Returns a sortKey for string.

Creating the sort key is usually somewhat slower, than using the compare() methods directly. But if the string is compared repeatedly (e.g. when sorting a whole list of strings), it's usually faster to create the sort keys for each string and then sort using the keys.

[noexcept] void QCollator::swap(QCollator &other)

Swaps this collator with other. This operation is very fast and never fails.

bool QCollator::operator()(QStringView s1, QStringView s2) const

A QCollator can be used as the comparison function of a sorting algorithm. It returns true if s1 sorts before s2, otherwise false.

See also compare().

bool QCollator::operator()(const QString &s1, const QString &s2) const

[noexcept] QCollator &QCollator::operator=(QCollator &&other)

Move-assigns other to this QCollator instance.

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

Assigns other to this collator.