QContactSortOrder Class

The QContactSortOrder class defines how a list of contacts should be ordered according to some criteria More...

Header: #include <QContactSortOrder>

Public Types

enum BlankPolicy { BlanksFirst, BlanksLast }

Public Functions

QContactSortOrder()
QContactSortOrder(const QContactSortOrder & other)
~QContactSortOrder()
BlankPolicy blankPolicy() const
Qt::CaseSensitivity caseSensitivity() const
int detailField() const
QContactDetail::DetailType detailType() const
Qt::SortOrder direction() const
bool isValid() const
void setBlankPolicy(BlankPolicy blankPolicy)
void setCaseSensitivity(Qt::CaseSensitivity sensitivity)
void setDetailType(QContactDetail::DetailType type, int field = -1)
void setDirection(Qt::SortOrder direction)
operator QList<QContactSortOrder>() const
bool operator!=(const QContactSortOrder & other) const
QContactSortOrder & operator=(const QContactSortOrder & other)
bool operator==(const QContactSortOrder & other) const

Detailed Description

The QContactSortOrder class defines how a list of contacts should be ordered according to some criteria

Member Type Documentation

enum QContactSortOrder::BlankPolicy

Enumerates the ways in which the sort order interprets blanks when sorting contacts

ConstantValueDescription
QContactSortOrder::BlanksFirst0Considers blank values to evaluate to less than all other values in comparisons
QContactSortOrder::BlanksLast1Considers blank values to evaluate to greater than all other values in comparisons

Member Function Documentation

QContactSortOrder::QContactSortOrder()

Constructs a new sort order

QContactSortOrder::QContactSortOrder(const QContactSortOrder & other)

Constructs a copy of the other sort order

QContactSortOrder::~QContactSortOrder()

Frees any memory in use by this sort order

BlankPolicy QContactSortOrder::blankPolicy() const

Returns the blank policy of the sort order

See also setBlankPolicy().

Qt::CaseSensitivity QContactSortOrder::caseSensitivity() const

Returns the case sensitivity of the sort order

See also setCaseSensitivity().

int QContactSortOrder::detailField() const

Returns the detail field which the sorting order will be based on.

See also setDetailType().

QContactDetail::DetailType QContactSortOrder::detailType() const

Returns the type of the details which will be inspected to perform sorting. Note that if a contact has multiple details of the definition, the result of the sorting is undefined.

See also setDetailType().

Qt::SortOrder QContactSortOrder::direction() const

Returns the direction of the sort order

See also setDirection().

bool QContactSortOrder::isValid() const

Returns true if the sort order is able to be used to sort a list of contacts; otherwise, returns false

void QContactSortOrder::setBlankPolicy(BlankPolicy blankPolicy)

Sets the sort order's policy on blank values with respect to sorting to blankPolicy

See also blankPolicy().

void QContactSortOrder::setCaseSensitivity(Qt::CaseSensitivity sensitivity)

Sets the case sensitivity of the sort order to sensitivity

See also caseSensitivity().

void QContactSortOrder::setDetailType(QContactDetail::DetailType type, int field = -1)

Sets the type of the details which will be inspected to perform sorting to type and the name of those details' fields which contains the value which contacts will be sorted by to field

If field is not specified, or equal to -1, the contact with a detail of the specified type would appear before or after the contact that lacks a detail of the specified type, according to blankPolicy().

See also detailType() and detailField().

void QContactSortOrder::setDirection(Qt::SortOrder direction)

Sets the sort order direction to direction

See also direction().

QContactSortOrder::operator QList<QContactSortOrder>() const

Constructs a new list of sort orders containing only the current sort order

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

Returns true if this sort order is not identical to the other sort order

See also operator==().

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

Assigns this sort order to be equal to other

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

Returns true if this sort order is identical to the other sort order

See also operator!=().