QOrganizerItemSortOrder Class
The QOrganizerItemSortOrder class defines how a list of organizer items should be ordered according to some criteria. More...
Header: | #include <QOrganizerItemSortOrder> |
Public Types
enum | BlankPolicy { BlanksFirst, BlanksLast } |
Public Functions
QOrganizerItemSortOrder() | |
QOrganizerItemSortOrder(const QOrganizerItemSortOrder &other) | |
~QOrganizerItemSortOrder() | |
BlankPolicy | blankPolicy() const |
Qt::CaseSensitivity | caseSensitivity() const |
int | detailField() const |
QOrganizerItemDetail::DetailType | detailType() const |
Qt::SortOrder | direction() const |
bool | isValid() const |
void | setBlankPolicy(BlankPolicy blankPolicy) |
void | setCaseSensitivity(Qt::CaseSensitivity sensitivity) |
void | setDetail(QOrganizerItemDetail::DetailType detailType, int field = -1) |
void | setDirection(Qt::SortOrder direction) |
operator QList<QOrganizerItemSortOrder>() const | |
bool | operator!=(const QOrganizerItemSortOrder &other) const |
QOrganizerItemSortOrder & | operator=(const QOrganizerItemSortOrder &other) |
bool | operator==(const QOrganizerItemSortOrder &other) const |
Related Non-Members
Q_ORGANIZER_EXPORT | operator<<(QDebug dbg, const QOrganizerItemSortOrder &sortOrder) |
Detailed Description
The QOrganizerItemSortOrder class defines how a list of organizer items should be ordered according to some criteria.
Member Type Documentation
enum QOrganizerItemSortOrder::BlankPolicy
Enumerates the ways in which the sort order interprets blanks when sorting organizer items.
Constant | Value | Description |
---|---|---|
QOrganizerItemSortOrder::BlanksFirst | 0 | Considers blank values to evaluate to less than all other values in comparisons. |
QOrganizerItemSortOrder::BlanksLast | 1 | Considers blank values to evaluate to greater than all other values in comparisons. |
Member Function Documentation
QOrganizerItemSortOrder::QOrganizerItemSortOrder()
Constructs a new sort order
QOrganizerItemSortOrder::QOrganizerItemSortOrder(const QOrganizerItemSortOrder &other)
Constructs a copy of the other sort order.
QOrganizerItemSortOrder::~QOrganizerItemSortOrder()
Frees any memory in use by this sort order
BlankPolicy QOrganizerItemSortOrder::blankPolicy() const
Returns the blank policy of the sort order.
See also setBlankPolicy().
Qt::CaseSensitivity QOrganizerItemSortOrder::caseSensitivity() const
Returns the case sensitivity of the sort order.
See also setCaseSensitivity().
int QOrganizerItemSortOrder::detailField() const
Returns the detail field which will be inspected to perform sorting.
See also setDetail().
QOrganizerItemDetail::DetailType QOrganizerItemSortOrder::detailType() const
Returns the type of the detail which will be inspected to perform sorting.
See also setDetail().
Qt::SortOrder QOrganizerItemSortOrder::direction() const
Returns the direction of the sort order.
See also setDirection().
bool QOrganizerItemSortOrder::isValid() const
Returns true if the sort order is able to be used to sort a list of organizer items; otherwise, returns false.
void QOrganizerItemSortOrder::setBlankPolicy(BlankPolicy blankPolicy)
Sets the sort order's policy on blank values with respect to sorting to blankPolicy.
See also blankPolicy().
void QOrganizerItemSortOrder::setCaseSensitivity(Qt::CaseSensitivity sensitivity)
Sets the case sensitivity of the sort order to sensitivity.
See also caseSensitivity().
void QOrganizerItemSortOrder::setDetail(QOrganizerItemDetail::DetailType detailType, int field = -1)
Sets the type of detail which will be inspected for sorting to detailType, and the field of the detail to field.
If field is not specified, or equal to -1, the organizer item with a detail of the specified type would appear before or after the organizer item that lacks a detail of the specified type, according to blankPolicy().
See also detailType() and detailField().
void QOrganizerItemSortOrder::setDirection(Qt::SortOrder direction)
Sets the sort order direction to direction.
See also direction().
QOrganizerItemSortOrder::operator QList<QOrganizerItemSortOrder>() const
Constructs a new list of sort orders containing only the current sort order.
bool QOrganizerItemSortOrder::operator!=(const QOrganizerItemSortOrder &other) const
Returns true if this sort order is not identical to the other sort order.
See also operator==().
QOrganizerItemSortOrder &QOrganizerItemSortOrder::operator=(const QOrganizerItemSortOrder &other)
Assigns this sort order to be equal to other.
bool QOrganizerItemSortOrder::operator==(const QOrganizerItemSortOrder &other) const
Returns true if this sort order is identical to the other sort order.
See also operator!=().
Related Non-Members
Q_ORGANIZER_EXPORT operator<<(QDebug dbg, const QOrganizerItemSortOrder &sortOrder)
Outputs sortOrder to the debug stream dbg.