pqKeyEventFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause

#ifndef pqKeyEventFilter_h
#define pqKeyEventFilter_h

#include "pqCoreModule.h"

#include <QObject>

#include <QList>
#include <QMap>
#include <QSharedPointer>

class QKeyEvent;

class PQCORE_EXPORT pqKeyEventFilter : public QObject
{
  Q_OBJECT;
  typedef QObject Superclass;

public:
  pqKeyEventFilter(QObject* parent);
  ~pqKeyEventFilter() override;

  enum KeyCategory
  {
    Accept,
    Reject,
    TextInput,
    Motion,
    Focus
  };

  void filter(QObject* monitored);


  void forwardTypes(QObject* monitored, QList<int> types);
  void forwardType(QObject* monitored, int type);

Q_SIGNALS:
  void textChanged(int key);

  void accepted(bool modified);

  void rejected();

  void motion(int key);

  void focusChanged();

protected:
  bool eventFilter(QObject* obj, QEvent* event) override;

private:
  bool isAcceptType(int key);
  bool isRejectType(int key);
  bool isTextUpdateType(QChar key);
  bool isMotionType(int key);
  bool isFocusType(int key);

  bool shouldHandle(QObject* obj, int type);

  QMap<QObject*, QList<int>> ForwardTypes;
  QList<QObject*> Monitored;

  QSharedPointer<QKeyEvent> LastEvent;
};

#endif