pqShortcutDecorator.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 pqShortcutDecorator_h
#define pqShortcutDecorator_h

#include "pqPropertyWidgetDecorator.h"

class pqModalShortcut;

class QColor;

class PQCOMPONENTS_EXPORT pqShortcutDecorator : public pqPropertyWidgetDecorator
{
  Q_OBJECT;

public:
  using Superclass = pqPropertyWidgetDecorator;
  pqShortcutDecorator(pqPropertyWidget* parent);
  pqShortcutDecorator(vtkPVXMLElement*, pqPropertyWidget* parent);

  void addShortcut(pqModalShortcut* shortcut);

  bool isEnabled() const;

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  virtual void setEnabled(bool enable, bool refocusWhenEnabling = false);

protected Q_SLOTS:
  virtual void onShortcutEnabled();
  virtual void onShortcutDisabled();

protected: // NOLINT(readability-redundant-access-specifiers)
  pqPropertyWidget* propertyWidget() const;
  bool eventFilter(QObject* obj, QEvent* event) override;
  void markFrame(bool active, const QColor& frameColor);

  // All the shortcuts that decorate the property widget.
  // These will all be enabled/disabled en banc.
  QList<QPointer<pqModalShortcut>> m_shortcuts;
  // Note when the user has pressed the mouse inside the widget and not released it.
  bool m_pressed;
  // Prevent recursive signaling inside onShortcutEnabled/onShortcutDisabled.
  bool m_silent;
  // Should shortcuts set the keyboard focus to their context widget?
  // This is set to true when users explicitly click on the widget frame
  // and false otherwise (so that programmatic changes to the widget made
  // in response to other events do not interrupt a user; for example,
  // using the arrow keys in the pipeline browser to change pipelines
  // should not move the keyboard focus away from the pipeline browser).
  // Note that this only applies when enabling shortcuts (since disabling
  // a shortcut would never require a refocus).
  bool m_allowRefocus;
};

#endif // pqShortcutDecorator_h