qgsshortcutsmanager.h

Go to the documentation of this file.

/***************************************************************************
    qgsshortcutsmanager.h
    ---------------------
    begin                : May 2009
    copyright            : (C) 2009 by Martin Dobias
    email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSSHORTCUTSMANAGER_H
#define QGSSHORTCUTSMANAGER_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QAction>
#include <QHash>
#include <QList>
 
class QShortcut;

class GUI_EXPORT QgsShortcutsManager : public QObject
{
    Q_OBJECT
 
  public:
    enum class CommonAction
    {
      CodeToggleComment, 
      CodeReformat,      
      CodeRunScript,     
      CodeRunSelection,  
    };
    Q_ENUM( CommonAction )
 
    
    QgsShortcutsManager( QObject *parent SIP_TRANSFERTHIS = nullptr, const QString &settingsRoot = "/shortcuts/" );
 
    ~QgsShortcutsManager() override;

    void registerAllChildren( QObject *object, bool recursive = false, const QString &section = QString() );

    void registerAllChildActions( QObject *object, bool recursive = false, const QString &section = QString() );

    void registerAllChildShortcuts( QObject *object, bool recursive = false, const QString &section = QString() );

    bool registerAction( QAction *action, const QString &defaultShortcut = QString(), const QString &section = QString() );

    void initializeCommonAction( QAction *action, CommonAction commonAction );

    bool registerShortcut( QShortcut *shortcut, const QString &defaultSequence = QString(), const QString &section = QString() );

    bool unregisterAction( QAction *action );

    bool unregisterShortcut( QShortcut *shortcut );

    QList<QAction *> listActions() const;

    QList<QShortcut *> listShortcuts() const;

    QList<QObject *> listAll() const;

    QString objectDefaultKeySequence( QObject *object ) const;

    QString defaultKeySequence( QAction *action ) const;

    QString defaultKeySequence( QShortcut *shortcut ) const;

    bool setKeySequence( const QString &name, const QString &sequence );

    bool setObjectKeySequence( QObject *object, const QString &sequence );

    bool setKeySequence( QAction *action, const QString &sequence );

    bool setKeySequence( QShortcut *shortcut, const QString &sequence );

    QObject *objectForSequence( const QKeySequence &sequence ) const;

    QAction *actionForSequence( const QKeySequence &sequence ) const;

    QShortcut *shortcutForSequence( const QKeySequence &sequence ) const;

    QKeySequence sequenceForCommonAction( CommonAction action ) const;

    QAction *actionByName( const QString &name ) const;

    QShortcut *shortcutByName( const QString &name ) const;

    QString settingsPath() const { return mSettingsPath; }

    QString objectSettingKey( QObject *object ) const;

    QObject *objectForSettingKey( const QString &name ) const;
 
  private slots:
 
    void actionDestroyed( QAction *action );
    void shortcutDestroyed( QShortcut *shortcut );
 
  private:
    typedef QHash<QAction *, QPair<QString, QString>> ActionsHash;
    typedef QHash<QShortcut *, QPair<QString, QString>> ShortcutsHash;
 
    ActionsHash mActions;
    ShortcutsHash mShortcuts;
    QString mSettingsPath;
    QHash< int, QAction * > mCommonActions;
    QHash< QAction *, CommonAction > mLinkedCommonActions;
 
    static QString formatActionToolTip( const QString &toolTip );

    void updateActionToolTip( QAction *action, const QString &sequence );
};
 
// clazy:excludeall=qstring-allocations
 
#endif // QGSSHORTCUTSMANAGER_H