kkeysequencewidget.h

Go to the documentation of this file.

// vim: noexpandtab ts=4 sw=4
/* This file is part of the KDE libraries
    Copyright (C) 2001, 2002 Ellis Whitehead <ellis@kde.org>
    Copyright (C) 2007 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 KKEYSEQUENCEWIDGET_H
#define KKEYSEQUENCEWIDGET_H

#include <QtCore/QList>
#include <QtGui/QPushButton>

#include <kshortcut.h>


class KKeySequenceWidgetPrivate;
class QAction;
class KAction;
class KActionCollection;

class KDEUI_EXPORT KKeySequenceWidget: public QWidget
{
    Q_OBJECT

    Q_FLAGS(ShortcutTypes)

    Q_PROPERTY(
            bool multiKeyShortcutsAllowed
            READ multiKeyShortcutsAllowed
            WRITE setMultiKeyShortcutsAllowed )

    Q_PROPERTY(
            ShortcutTypes checkForConflictsAgainst
            READ checkForConflictsAgainst
            WRITE setCheckForConflictsAgainst )

    Q_PROPERTY(
            bool modifierlessAllowed
            READ isModifierlessAllowed
            WRITE setModifierlessAllowed )

public:
    enum Validation {
        Validate = 0,
        NoValidate = 1
    };

    explicit KKeySequenceWidget(QWidget *parent = 0);

    virtual ~KKeySequenceWidget();


        enum ShortcutType {
            None           = 0x00,      
            LocalShortcuts = 0x01,      
            StandardShortcuts = 0x02,   
            GlobalShortcuts = 0x03      
        };
        Q_DECLARE_FLAGS(ShortcutTypes, ShortcutType)

        
        void setCheckForConflictsAgainst( ShortcutTypes types );

        ShortcutTypes checkForConflictsAgainst() const;

        void setMultiKeyShortcutsAllowed(bool);
        bool multiKeyShortcutsAllowed() const;

        void setModifierlessAllowed(bool allow);

        bool isModifierlessAllowed();

        void setClearButtonShown(bool show);


    bool isKeySequenceAvailable(const QKeySequence &seq) const;

    QKeySequence keySequence() const;

    void setCheckActionCollections(const QList<KActionCollection *>& actionCollections);

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setCheckActionList(const QList<QAction*> &checkList);
#endif

    void setComponentName(const QString &componentName);


Q_SIGNALS:

    void keySequenceChanged(const QKeySequence &seq);

    void stealShortcut(const QKeySequence &seq, KAction *action);

public Q_SLOTS:

    void captureKeySequence();

    void setKeySequence(const QKeySequence &seq, Validation val = NoValidate);

    void clearKeySequence();

    void applyStealShortcut();

private:
    Q_PRIVATE_SLOT(d, void doneRecording())

private:
    friend class KKeySequenceWidgetPrivate;
    KKeySequenceWidgetPrivate *const d;

    Q_DISABLE_COPY(KKeySequenceWidget)
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KKeySequenceWidget::ShortcutTypes)

#endif //KKEYSEQUENCEWIDGET_H