kshortcutseditor.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1997 Nicolas Hadacek <hadacek@kde.org>
    Copyright (C) 2001,2001 Ellis Whitehead <ellis@kde.org>
    Copyright (C) 2006 Hamish Rodda <rodda@kde.org>
    Copyright (C) 2007 Roberto Raggi <roberto@kdevelop.org>
    Copyright (C) 2007 Andreas Hartmetz <ahartmetz@gmail.com>
    Copyright (C) 2008 Michael Jansen <kde@michael-jansen.biz>

    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 KSHORTCUTSEDITOR_H
#define KSHORTCUTSEDITOR_H

#include <QtGui/QWidget>
#include "kgesture.h"

class KActionCollection;
class KConfig;
class KConfigBase;
class KConfigGroup;
class KGlobalAccel;
class KShortcut;
class KShortcutsEditorPrivate;

// KShortcutsEditor expects that the list of existing shortcuts is already
// free of conflicts. If it is not, nothing will crash, but your users
// won't like the resulting behavior.


class KDEUI_EXPORT KShortcutsEditor : public QWidget
{
    Q_OBJECT

public:
    enum ActionType {
        WidgetAction      = Qt::WidgetShortcut      /*0*/,
        WindowAction      = Qt::WindowShortcut      /*1*/,
        ApplicationAction = Qt::ApplicationShortcut /*2*/,
        GlobalAction      = 4,
        AllActions        = 0xffffffff
    };
    Q_DECLARE_FLAGS(ActionTypes, ActionType)

    enum LetterShortcuts {
        LetterShortcutsDisallowed = 0,
        LetterShortcutsAllowed
    };

    KShortcutsEditor(KActionCollection *collection, QWidget *parent, ActionTypes actionTypes = AllActions, LetterShortcuts allowLetterShortcuts = LetterShortcutsAllowed);

    explicit KShortcutsEditor( QWidget* parent, ActionTypes actionTypes = AllActions, LetterShortcuts allowLetterShortcuts = LetterShortcutsAllowed );

    virtual ~KShortcutsEditor();

    bool isModified() const;

    void clearCollections();

    void addCollection(KActionCollection *, const QString &title = QString());


    void undoChanges();

    void save();

    void commit();


    void clearConfiguration();

    void writeConfiguration( KConfigGroup* config = 0 ) const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void exportConfiguration( KConfig *config) const;
#endif
    void exportConfiguration( KConfigBase *config) const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void importConfiguration( KConfig *config);
#endif
    void importConfiguration( KConfigBase *config);


Q_SIGNALS:
    void keyChange();

public Q_SLOTS:
    void resizeColumns();

    void allDefault();

        void printShortcuts() const;

private:
    Q_PRIVATE_SLOT(d, void capturedShortcut(QVariant, const QModelIndex &))

private:
    friend class KShortcutsDialog;
    friend class KShortcutsEditorPrivate;
    KShortcutsEditorPrivate *const d;
    Q_DISABLE_COPY(KShortcutsEditor)
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KShortcutsEditor::ActionTypes)

#endif // KSHORTCUTSEDITOR_H