kglobalaccel.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) 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 "kdeui_export.h"
#include "kaction.h"
#include "kglobalshortcutinfo.h"

#include <QtCore/QObject>

class QWidget;
class KShortcut;
class KComponentData;
class OrgKdeKglobalaccelComponentInterface;

class KDEUI_EXPORT KGlobalAccel : public QObject
{
    Q_OBJECT

public:

    enum actionIdFields
    {
        ComponentUnique = 0,        
        ActionUnique = 1,           
        ComponentFriendly = 2,      
        ActionFriendly = 3          
    };

    static KGlobalAccel *self();

    static void stealShortcutSystemwide(const QKeySequence &seq);

    static void activateGlobalShortcutContext(
            const QString &contextUnique,
            const QString &contextFriendly,
            const KComponentData &component = KGlobal::mainComponent());

    static bool cleanComponent(const QString &componentUnique);


    static bool isComponentActive(const QString &componentName);

    static QList<KGlobalShortcutInfo> getGlobalShortcutsByKey(const QKeySequence &seq);

    static bool isGlobalShortcutAvailable(
            const QKeySequence &seq,
            const QString &component = QString());

    static bool promptStealShortcutSystemwide(
            QWidget *parent,
            const QList<KGlobalShortcutInfo> &shortcuts,
            const QKeySequence &seq);

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool isEnabled() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setEnabled(bool enabled);
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void overrideMainComponentData(const KComponentData &componentData);
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QList<QStringList> allMainComponents();
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QList<QStringList> allActionsForComponent(const QStringList &actionId);
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED static QStringList findActionNameSystemwide(const QKeySequence &seq);
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED static bool promptStealShortcutSystemwide(QWidget *parent, const QStringList &actionIdentifier, const QKeySequence &seq);
#endif

private:

    friend class KAction;

    KGlobalAccel();

    ~KGlobalAccel();

    OrgKdeKglobalaccelComponentInterface* getComponent(const QString &componentUnique);

    class KGlobalAccelPrivate *const d;

    Q_PRIVATE_SLOT(d, void _k_invokeAction(const QString &, const QString &, qlonglong))
    Q_PRIVATE_SLOT(d, void _k_shortcutGotChanged(const QStringList&, const QList<int>&))
    Q_PRIVATE_SLOT(d, void _k_serviceOwnerChanged(const QString&, const QString&, const QString&))
};

#endif // _KGLOBALACCEL_H_