/****************************************************************************

**

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Mobility Components.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QCONTACTSORTORDER_H

#define QCONTACTSORTORDER_H

#include "qtcontactsglobal.h"

#include <QString>

#include <QSharedData>

#include <QList>

QTM_BEGIN_NAMESPACE

class QContactSortOrderPrivate;

class Q_CONTACTS_EXPORT QContactSortOrder

{

public:

    QContactSortOrder();

    ~QContactSortOrder();

    QContactSortOrder(const QContactSortOrder& other);

    QContactSortOrder& operator=(const QContactSortOrder& other);

    enum BlankPolicy {

        BlanksFirst,

        BlanksLast,

    };

    /* Mutators */

    void setDetailDefinitionName(const QString& definitionName, const QString& fieldName);

    void setBlankPolicy(BlankPolicy blankPolicy);

    void setDirection(Qt::SortOrder direction);

    void setCaseSensitivity(Qt::CaseSensitivity sensitivity);

    /* Accessors */

    QString detailDefinitionName() const;

    QString detailFieldName() const;

    BlankPolicy blankPolicy() const;

    Qt::SortOrder direction() const;

    Qt::CaseSensitivity caseSensitivity() const;

    bool isValid() const;

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

    bool operator!=(const QContactSortOrder& other) const {return !operator==(other);}

    /* Convenience cast */

    operator QList<QContactSortOrder>() const {return QList<QContactSortOrder>() << *this;}

private:

    QSharedDataPointer<QContactSortOrderPrivate> d;

};

QTM_END_NAMESPACE

Q_DECLARE_TYPEINFO(QTM_PREPEND_NAMESPACE(QContactSortOrder), Q_MOVABLE_TYPE);

#endif