kshortcut.h

Go to the documentation of this file.

/*  This file is part of the KDE libraries
    Copyright (C) 2001,2002 Ellis Whitehead <ellis@kde.org>
    Copyright (C) 2006 Hamish Rodda <rodda@kde.org>
    Copyright (C) 2006 Andreas Hartmetz <ahartmetz@gmail.com>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KSHORTCUT_H
#define KSHORTCUT_H

#include <kdeui_export.h>

#include <QtCore/QList>
#include <QtCore/QMetaType>
#include <QtGui/QKeySequence>

class KShortcutPrivate;

class KDEUI_EXPORT KShortcut
{
public:
    enum EmptyHandling {
        KeepEmpty = 0,
        RemoveEmpty
    };

    KShortcut();

    explicit KShortcut(const QKeySequence &primary);

    KShortcut(const QKeySequence &primary, const QKeySequence &alternate);

    explicit KShortcut(int keyQtPri, int keyQtAlt = 0);

    KShortcut(const KShortcut &other);

    explicit KShortcut(const QString &description);

    explicit KShortcut(const QList<QKeySequence> &seqs);

    ~KShortcut();

    QKeySequence primary() const;

    QKeySequence alternate() const;

    bool isEmpty() const;

    bool contains(const QKeySequence &needle) const;

    bool conflictsWith(const QKeySequence &needle) const;

    QString toString() const;

    QString toString(QKeySequence::SequenceFormat format) const;

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

    bool operator!=(const KShortcut &other) const;

    operator QList<QKeySequence>() const;

    QList<QKeySequence> toList(enum EmptyHandling handleEmpty = RemoveEmpty) const;

    operator QVariant() const;

    void setPrimary(const QKeySequence &keySeq);

    void setAlternate(const QKeySequence &keySeq);

    void remove(const QKeySequence &keySeq, enum EmptyHandling handleEmpty = RemoveEmpty);

    KShortcut &operator=(const KShortcut &other);

private:
    class KShortcutPrivate *const d;
};

uint qHash(int);
inline uint qHash(const KShortcut &key)
{
    return qHash(key.primary()[0]) + qHash(key.primary()[1]);
}

inline uint qHash(const QKeySequence &key)
{
    uint hash = 0;
    for(uint i = 0; i < key.count(); i++)
       hash += qHash(key[i]);
    return hash;
}

Q_DECLARE_METATYPE(KShortcut)

#endif // KSHORTCUT_H