QCollator

The QCollator class compares strings according to a localized collation algorithm. More

Inheritance diagram of PySide6.QtCore.QCollator

New in version 5.2.

Synopsis

Functions

Detailed Description

QCollator is initialized with a QLocale . It can then be used to compare and sort strings in using the ordering appropriate to the locale.

A QCollator object can be used together with template-based sorting algorithms, such as std::sort(), to sort a list with QString entries.

sortedStrings = QStringList(QStringList seq)

    order = QCollator()
    std::sort(seq.begin(), seq.end(), order)
    return seq

In addition to the locale, several optional flags can be set that influence the result of the collation.

Note

On Linux, Qt is normally compiled to use ICU. When it isn’t, all options are ignored and the only supported locales are the system default (that setlocale(LC_COLLATE, nullptr) would report) and the “C” locale.

class PySide6.QtCore.QCollator

PySide6.QtCore.QCollator(arg__1)

PySide6.QtCore.QCollator(locale)

Parameters

Constructs a QCollator using the system’s default collation locale.

PySide6.QtCore.QCollator.caseSensitivity()
Return type

CaseSensitivity

Returns case sensitivity of the collator.

This defaults to case-sensitive until set.

Note

In the C locale, when case-sensitive, all lower-case letters sort after all upper-case letters, where most locales sort each lower-case letter either immediately before or immediately after its upper-case partner. Thus “Zap” sorts before “ape” in the C locale but after in most others.

PySide6.QtCore.QCollator.compare(s1, s2)
Parameters
  • s1QStringView

  • s2QStringView

Return type

int

Compares s1 with s2.

Returns an integer less than, equal to, or greater than zero depending on whether s1 sorts before, with or after s2.

PySide6.QtCore.QCollator.compare(s1, len1, s2, len2)
Parameters
  • s1QChar

  • len1 – int

  • s2QChar

  • len2 – int

Return type

int

This is an overloaded function.

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

Returns an integer less than, equal to, or greater than zero depending on whether s1 sorts before, with or after s2.

PySide6.QtCore.QCollator.compare(s1, s2)
Parameters
  • s1 – str

  • s2 – str

Return type

int

PySide6.QtCore.QCollator.ignorePunctuation()
Return type

bool

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.

PySide6.QtCore.QCollator.locale()
Return type

PySide6.QtCore.QLocale

Returns the locale of the collator.

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

PySide6.QtCore.QCollator.numericMode()
Return type

bool

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()

PySide6.QtCore.QCollator.operator()(s1, s2)
Parameters
  • s1QStringView

  • s2QStringView

Return type

bool

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()

PySide6.QtCore.QCollator.operator()(s1, s2)
Parameters
  • s1 – str

  • s2 – str

Return type

bool

PySide6.QtCore.QCollator.setCaseSensitivity(cs)
Parameters

csCaseSensitivity

Sets the case-sensitivity of the collator to cs.

PySide6.QtCore.QCollator.setIgnorePunctuation(on)
Parameters

on – bool

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

PySide6.QtCore.QCollator.setLocale(locale)
Parameters

localePySide6.QtCore.QLocale

Sets the locale of the collator to locale.

See also

locale()

PySide6.QtCore.QCollator.setNumericMode(on)
Parameters

on – bool

Enables numeric sorting mode when on is true.

See also

numericMode()

PySide6.QtCore.QCollator.sortKey(string)
Parameters

string – str

Return type

PySide6.QtCore.QCollatorSortKey

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

Note

Not supported with the C (a.k.a. POSIX) locale on Darwin.

PySide6.QtCore.QCollator.swap(other)
Parameters

otherPySide6.QtCore.QCollator

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