QCollatorSortKey Class | Qt Core 5.6

Qt 5.6 | Qt Core | C++ Classes | QCollatorSortKey

Qt 5.6.2 Reference Documentation

# QCollatorSortKey Class

The QCollatorSortKey class can be used to speed up string collation. More...

Header: | #include <QCollatorSortKey>
qmake: | QT += core
Since: | Qt 5.2

- List of all members, including inherited members

Note: All functions in this class are reentrant.

## Public Functions

| QCollatorSortKey(const QCollatorSortKey &other)
| ~QCollatorSortKey()
int | compare(const QCollatorSortKey &otherKey) const
void | swap(QCollatorSortKey &other)
QCollatorSortKey & | operator=(const QCollatorSortKey &other)
QCollatorSortKey & | operator=(QCollatorSortKey &&other)

## Related Non-Members

bool | operator<(const QCollatorSortKey &lhs, const QCollatorSortKey &rhs)

## Detailed Description

The QCollatorSortKey class can be used to speed up string collation.

The QCollatorSortKey class is always created by QCollator::sortKey() and is used for fast strings collation, for example when collating many strings.

See also QCollator and QCollator::sortKey().

## Member Function Documentation

### QCollatorSortKey::QCollatorSortKey(const QCollatorSortKey &other)

Constructs a copy of the other collator key.

### QCollatorSortKey::~QCollatorSortKey()

Destroys the collator key.

### int QCollatorSortKey::compare(const QCollatorSortKey &otherKey) const

Compares the key to otherKey. Returns a negative value if the key is less than otherKey, 0 if the key is equal to otherKey or a positive value if the key is greater than otherKey.

See also operator<().

### void QCollatorSortKey::swap(QCollatorSortKey &other)

Swaps this collator key with other.

### QCollatorSortKey &QCollatorSortKey::operator=(const QCollatorSortKey &other)

Assigns other to this collator key.

### QCollatorSortKey &QCollatorSortKey::operator=(QCollatorSortKey &&other)

Move-assigns other to this collator key.

## Related Non-Members

### bool operator<(const QCollatorSortKey &lhs, const QCollatorSortKey &rhs)

According to the QCollator that created the keys, returns `true` if lhs should be sorted before rhs; otherwise returns `false`.

See also QCollatorSortKey::compare().