kdelibs/kdeui/widgets/kshortcutwidget.h

87 lines
2.8 KiB
C
Raw Normal View History

2014-11-13 01:04:59 +02:00
/* This file is part of the KDE libraries
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 KSHORTCUTWIDGET_H
#define KSHORTCUTWIDGET_H
#include <QtGui/QWidget>
#include "kshortcut.h"
class KActionCollection;
class KShortcutWidgetPrivate;
/**
* \image html kshortcutwidget.png "KDE Shortcut Widget"
*/
class KDEUI_EXPORT KShortcutWidget : public QWidget
{
Q_OBJECT
Q_PROPERTY(bool modifierlessAllowed READ isModifierlessAllowed WRITE setModifierlessAllowed)
public:
KShortcutWidget(QWidget *parent = 0);
~KShortcutWidget();
void setModifierlessAllowed(bool allow);
bool isModifierlessAllowed();
void setClearButtonsShown(bool show);
KShortcut shortcut() const;
/**
* Set a list of action collections to check against for conflictuous shortcut.
*
* If there is a conflictuous shortcut with a KAction, and that his shortcut can be configured
* (KAction::isShortcutConfigurable() returns true) the user will be prompted for eventually steal
* the shortcut from this action
*
* Global shortcuts are automatically checked for conflicts
*
* Don't forget to call applyStealShortcut to actually steal the shortcut.
*
* @since 4.1
*/
void setCheckActionCollections(const QList<KActionCollection *>& actionCollections);
Q_SIGNALS:
void shortcutChanged(const KShortcut &cut);
public Q_SLOTS:
void setShortcut(const KShortcut &cut);
void clearShortcut();
/**
* Actually remove the shortcut that the user wanted to steal, from the
* action that was using it.
*
* To be called before you apply your changes.
* No shortcuts are stolen until this function is called.
*/
void applyStealShortcut();
private:
Q_PRIVATE_SLOT(d, void priKeySequenceChanged(const QKeySequence &))
Q_PRIVATE_SLOT(d, void altKeySequenceChanged(const QKeySequence &))
private:
friend class KShortcutWidgetPrivate;
KShortcutWidgetPrivate *const d;
};
#endif //KSHORTCUTWIDGET_H