QCollator Class▲
-
Header: QCollator
-
Since: Qt 5.2
-
qmake: QT += core
-
Group: QCollator is part of i18n, string-processing, Implicitly Shared Classes
Detailed Description▲
QCollator is initialized with a QLocale and an optional collation strategy. It tries to initialize the collator with the specified values. The collator can then be used to compare and sort strings in a locale dependent fashion.
A QCollator object can be used together with template based sorting algorithms such as std::sort to sort a list of QStrings.
In addition to the locale and collation strategy, several optional flags can be set that influence the result of the collation.
Member Function Documentation▲
[since 5.13] QCollator::QCollator()▲
Constructs a QCollator using the system's default collation locale.
This function was introduced in Qt 5.13.
See Also▲
See also setLocale(), QLocale::collation()
[explicit] QCollator::QCollator(const QLocale &locale)▲
QCollator::QCollator(const QCollator &other)▲
Creates a copy of other.
QCollator::QCollator(QCollator &&other)▲
Move constructor. Moves from other into this collator.
Note that a moved-from QCollator can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.
QCollator::~QCollator()▲
Destroys the collator.
Qt::CaseSensitivity QCollator::caseSensitivity() const▲
[since 5.13] int QCollator::compare(QStringView s1, QStringView s2) const▲
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.
This function was introduced in Qt 5.13.
int QCollator::compare(const QString &s1, const QString &s2) const▲
This is an overloaded function.
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.
int QCollator::compare(const QStringRef &s1, const QStringRef &s2) const▲
This is an overloaded function.
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.
int QCollator::compare(const QChar *s1, int len1, const QChar *s2, int len2) const▲
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.
bool QCollator::ignorePunctuation() const▲
Returns true if punctuation characters and symbols are ignored when determining sort order.
See Also▲
See also setIgnorePunctuation()
QLocale QCollator::locale() const▲
bool QCollator::numericMode() const▲
void QCollator::setCaseSensitivity(Qt::CaseSensitivity sensitivity)▲
void QCollator::setIgnorePunctuation(bool on)▲
If on is set to true, punctuation characters and symbols are ignored when determining sort order.
The default is locale dependent.
This method is not currently supported if Qt is configured to not use ICU on Linux.
See Also▲
See also ignorePunctuation()
void QCollator::setLocale(const QLocale &locale)▲
void QCollator::setNumericMode(bool on)▲
Enables numeric sorting mode when on is set to true.
This will enable proper sorting of numeric digits, so that e.g. 100 sorts after 99.
By default this mode is off.
See Also▲
See also numericMode()
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.
Not supported with the C (a.k.a. POSIX) locale on Darwin.
void QCollator::swap(QCollator &other)▲
Swaps this collator with other. This function is very fast and never fails.
QCollator &QCollator::operator=(const QCollator &other)▲
Assigns other to this collator.
QCollator &QCollator::operator=(QCollator &&other)▲
Move-assigns from other to this collator.
Note that a moved-from QCollator can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.