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

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

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

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $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 QKEYSEQUENCE_H

#define QKEYSEQUENCE_H

#include <QtCore/qnamespace.h>

#include <QtCore/qstring.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

#ifndef QT_NO_SHORTCUT

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

  QKeySequence stream functions

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

#ifndef QT_NO_DATASTREAM

class QKeySequence;

Q_GUI_EXPORT QDataStream &operator<<(QDataStream &in, const QKeySequence &ks);

Q_GUI_EXPORT QDataStream &operator>>(QDataStream &out, QKeySequence &ks);

#endif

#ifdef qdoc

void qt_set_sequence_auto_mnemonic(bool b);

#endif

class QVariant;

class QKeySequencePrivate;

class Q_GUI_EXPORT QKeySequence

{

public:

    enum StandardKey {

        UnknownKey,

        HelpContents,

        WhatsThis,

        Open,

        Close,

        Save,

        New,

        Delete,

        Cut,

        Copy,

        Paste,

        Undo,

        Redo,

        Back,

        Forward,

        Refresh,

        ZoomIn,

        ZoomOut,

        Print,

        AddTab,

        NextChild,

        PreviousChild,

        Find,

        FindNext,

        FindPrevious,

        Replace,

        SelectAll,

        Bold,

        Italic,

        Underline,

        MoveToNextChar,

        MoveToPreviousChar,

        MoveToNextWord,

        MoveToPreviousWord,

        MoveToNextLine,

        MoveToPreviousLine,

        MoveToNextPage,

        MoveToPreviousPage,

        MoveToStartOfLine,

        MoveToEndOfLine,

        MoveToStartOfBlock,

        MoveToEndOfBlock,

        MoveToStartOfDocument,

        MoveToEndOfDocument,

        SelectNextChar,

        SelectPreviousChar,

        SelectNextWord,

        SelectPreviousWord,

        SelectNextLine,

        SelectPreviousLine,

        SelectNextPage,

        SelectPreviousPage,

        SelectStartOfLine,

        SelectEndOfLine,

        SelectStartOfBlock,

        SelectEndOfBlock,

        SelectStartOfDocument,

        SelectEndOfDocument,

        DeleteStartOfWord,

        DeleteEndOfWord,

        DeleteEndOfLine,

        InsertParagraphSeparator,

        InsertLineSeparator,

        SaveAs,

        Preferences,

        Quit

     };

    enum SequenceFormat {

        NativeText,

        PortableText

    };

    QKeySequence();

    QKeySequence(const QString &key);

    QKeySequence(const QString &key, SequenceFormat format);

    QKeySequence(int k1, int k2 = 0, int k3 = 0, int k4 = 0);

    QKeySequence(const QKeySequence &ks);

    QKeySequence(StandardKey key);

    ~QKeySequence();

    uint count() const; // ### Qt 5: return 'int'

    bool isEmpty() const;

    enum SequenceMatch {

        NoMatch,

        PartialMatch,

        ExactMatch

#ifdef QT3_SUPPORT

        , Identical = ExactMatch

#endif

    };

    QString toString(SequenceFormat format = PortableText) const;

    static QKeySequence fromString(const QString &str, SequenceFormat format = PortableText);

    SequenceMatch matches(const QKeySequence &seq) const;

    static QKeySequence mnemonic(const QString &text);

    static QList<QKeySequence> keyBindings(StandardKey key);

    // ### Qt 5: kill 'operator QString' - it's evil

    operator QString() const;

    operator QVariant() const;

    operator int() const;

    int operator[](uint i) const;

    QKeySequence &operator=(const QKeySequence &other);

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

    inline bool operator!= (const QKeySequence &other) const

    { return !(*this == other); }

    bool operator< (const QKeySequence &ks) const;

    inline bool operator> (const QKeySequence &other) const

    { return other < *this; }

    inline bool operator<= (const QKeySequence &other) const

    { return !(other < *this); }

    inline bool operator>= (const QKeySequence &other) const

    { return !(*this < other); }

    bool isDetached() const;

private:

    static int decodeString(const QString &ks);

    static QString encodeString(int key);

    int assign(const QString &str);

    int assign(const QString &str, SequenceFormat format);

    void setKey(int key, int index);

    QKeySequencePrivate *d;

    friend Q_GUI_EXPORT QDataStream &operator<<(QDataStream &in, const QKeySequence &ks);

    friend Q_GUI_EXPORT QDataStream &operator>>(QDataStream &in, QKeySequence &ks);

    friend class Q3AccelManager;

    friend class QShortcutMap;

    friend class QShortcut;

public:

    typedef QKeySequencePrivate * DataPtr;

    inline DataPtr &data_ptr() { return d; }

};

Q_DECLARE_TYPEINFO(QKeySequence, Q_MOVABLE_TYPE);

Q_DECLARE_SHARED(QKeySequence)

#ifndef QT_NO_DEBUG_STREAM

Q_GUI_EXPORT QDebug operator<<(QDebug, const QKeySequence &);

#endif

#else

class Q_GUI_EXPORT QKeySequence

{

public:

    QKeySequence() {}

    QKeySequence(int) {}

};

#endif // QT_NO_SHORTCUT

QT_END_NAMESPACE

QT_END_HEADER

#endif // QKEYSEQUENCE_H