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

**

** Copyright (C) 2009 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 QSHORTCUTMAP_P_H

#define QSHORTCUTMAP_P_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

//

#include "QtGui/qkeysequence.h"

#include "QtCore/qvector.h"

#include "QtCore/qscopedpointer.h"

QT_BEGIN_NAMESPACE

#ifndef QT_NO_SHORTCUT

// To enable dump output uncomment below

//#define Dump_QShortcutMap

class QKeyEvent;

struct QShortcutEntry;

class QShortcutMapPrivate;

class QGraphicsWidget;

class QWidget;

class QAction;

class QObject;

class QShortcutMap

{

    Q_DECLARE_PRIVATE(QShortcutMap)

public:

    QShortcutMap();

    ~QShortcutMap();

    int addShortcut(QObject *owner, const QKeySequence &key, Qt::ShortcutContext context);

    int removeShortcut(int id, QObject *owner, const QKeySequence &key = QKeySequence());

    int setShortcutEnabled(bool enable, int id, QObject *owner, const QKeySequence &key = QKeySequence());

    int setShortcutAutoRepeat(bool on, int id, QObject *owner, const QKeySequence &key = QKeySequence());

    void resetState();

    QKeySequence::SequenceMatch nextState(QKeyEvent *e);

    QKeySequence::SequenceMatch state();

    void dispatchEvent(QKeyEvent *e);

    bool tryShortcutEvent(QObject *o, QKeyEvent *e);

#ifdef Dump_QShortcutMap

    void dumpMap() const;

#endif

    bool hasShortcutForKeySequence(const QKeySequence &seq) const;

private:

    bool correctWidgetContext(Qt::ShortcutContext context, QWidget *w, QWidget *active_window) const;

#ifndef QT_NO_GRAPHICSVIEW

    bool correctGraphicsWidgetContext(Qt::ShortcutContext context, QGraphicsWidget *w, QWidget *active_window) const;

#endif

#ifndef QT_NO_ACTION

    bool correctContext(Qt::ShortcutContext context,QAction *a, QWidget *active_window) const;

#endif

    QScopedPointer<QShortcutMapPrivate> d_ptr;

    QKeySequence::SequenceMatch find(QKeyEvent *e);

    QKeySequence::SequenceMatch matches(const QKeySequence &seq1, const QKeySequence &seq2) const;

    QVector<const QShortcutEntry *> matches() const;

    void createNewSequences(QKeyEvent *e, QVector<QKeySequence> &ksl);

    void clearSequence(QVector<QKeySequence> &ksl);

    bool correctContext(const QShortcutEntry &item) const;

    int translateModifiers(Qt::KeyboardModifiers modifiers);

};

#endif // QT_NO_SHORTCUT

QT_END_NAMESPACE

#endif // QSHORTCUTMAP_P_H