pqModalShortcut.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqModalShortcut_h
#define pqModalShortcut_h

#include "pqProxy.h"
#include <QKeySequence>
#include <QObject>

class QAction;
class QShortcut;
class pqModalShortcut;

class PQCORE_EXPORT pqModalShortcut : public QObject
{
  Q_OBJECT;

public:
  using Superclass = QObject;
  ~pqModalShortcut() override;

  void setContextWidget(
    QWidget* contextWidget, Qt::ShortcutContext contextArea = Qt::WindowShortcut);

  bool isEnabled() const;
  void setEnabled(bool shouldEnable, bool changeFocus = true);

  QKeySequence keySequence() const;

Q_SIGNALS:
  void enabled();

  void disabled();

  void unregister();

  void activated();

protected:
  friend class pqKeySequences;
  pqModalShortcut(const QKeySequence& key, QAction* action = nullptr, QWidget* parent = nullptr);

  QKeySequence m_key;
  QPointer<QShortcut> m_shortcut;
  QPointer<QAction> m_action;
};

#endif