mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-23 18:32:49 +00:00

for better shortcut stealing, e.g. for actions with more than one shortcut Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
111 lines
3.5 KiB
C++
111 lines
3.5 KiB
C++
/* 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) 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 KGLOBALACCEL_H
|
|
#define KGLOBALACCEL_H
|
|
|
|
#include <QWidget>
|
|
|
|
#include "kdeui_export.h"
|
|
#include "kaction.h"
|
|
#include "kglobal.h"
|
|
|
|
struct KGlobalShortcutInfo
|
|
{
|
|
QString componentFriendlyName;
|
|
QString friendlyName;
|
|
QString contextFriendlyName;
|
|
};
|
|
|
|
/**
|
|
* @short Configurable global shortcut support
|
|
*
|
|
* KGlobalAccel allows you to have global accelerators that are independent of the focused window.
|
|
* Unlike regular shortcuts, the application's window does not need focus for them to be activated.
|
|
*
|
|
* @see KAction
|
|
* @see KKeySequenceWidget
|
|
* @see KShortcutsEditor
|
|
*/
|
|
class KDEUI_EXPORT KGlobalAccel : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/// Creates a new KGlobalAccel object
|
|
KGlobalAccel();
|
|
|
|
/// Destructor
|
|
~KGlobalAccel();
|
|
|
|
/**
|
|
* Returns (and creates if necessary) the singleton instance
|
|
*/
|
|
static KGlobalAccel *self();
|
|
|
|
/**
|
|
* Returns a list of global shortcuts registered for the shortcut @p seq.
|
|
*
|
|
* If the list contains more that one entry it means the component that registered the
|
|
* shortcuts uses global shortcut contexts. All returned shortcuts belong to the same
|
|
* component.
|
|
*
|
|
* @since 4.2
|
|
*/
|
|
QList<KGlobalShortcutInfo> getGlobalShortcutsByKey(const QKeySequence &seq);
|
|
|
|
/**
|
|
* Check if the shortcut @p seq is available, when checking for conflicts the action specified
|
|
* as @p exception is not considered.
|
|
*
|
|
* @since 4.2
|
|
*/
|
|
bool isGlobalShortcutAvailable(const QKeySequence &seq,
|
|
const QAction *exception = nullptr);
|
|
|
|
/**
|
|
* Take away the given shortcut from the named action it belongs to. This applies to all
|
|
* actions with global shortcuts in any KDE application except the @p exception if not null.
|
|
*
|
|
* @see promptStealShortcutSystemwide()
|
|
*/
|
|
void stealShortcutSystemwide(const QKeySequence &seq,
|
|
const QAction *exception = nullptr);
|
|
|
|
/**
|
|
* Show a messagebox to inform the user that a global shorcut is already occupied and ask to
|
|
* take it away from its current action(s). This is GUI only, so nothing will be actually
|
|
* changed.
|
|
*
|
|
* @see stealShortcutSystemwide()
|
|
*
|
|
* @since 4.2
|
|
*/
|
|
static bool promptStealShortcutSystemwide(QWidget *parent,
|
|
const QList<KGlobalShortcutInfo> &shortcuts,
|
|
const QKeySequence &seq);
|
|
|
|
private:
|
|
friend class KAction;
|
|
class KGlobalAccelPrivate *const d;
|
|
};
|
|
|
|
#endif // KGLOBALACCEL_H
|