pqOutputWidget.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 pqOutputWidget_h
#define pqOutputWidget_h

#include <QWidget>

#include "pqCoreModule.h" // for exports
#include <QScopedPointer> // for QScopedPointer.

class pqOutputWidget;

namespace OutputWidgetInternals
{
class OutputWindow;
};

Q_DECLARE_METATYPE(QtMsgType); // NOLINT(performance-no-int-to-ptr)

class PQCORE_EXPORT MessageHandler : public QObject
{
  Q_OBJECT
public:
  MessageHandler(QObject* parent = nullptr);

  static void install(pqOutputWidget* widget);

  static void handler(QtMsgType type, const QMessageLogContext&, const QString& msg);

  static void handlerVTK(QtMsgType type, const QString& msg);

Q_SIGNALS:
  void message(QtMsgType type, const QString& msg);
  void showMessage(QString msg, QtMsgType type);

private:
  static MessageHandler* instance();

private Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void displayMessage(QtMsgType type, const QString& msg);
};

class PQCORE_EXPORT pqOutputWidget : public QWidget
{
  Q_OBJECT
  typedef QWidget Superclass;
  Q_PROPERTY(QString settingsKey READ settingsKey WRITE setSettingsKey);

public:
  pqOutputWidget(QWidget* parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
  ~pqOutputWidget() override;

  void suppress(const QStringList& substrs);


  void setSettingsKey(const QString& key);
  const QString& settingsKey() const;


  void setFontSize(int fontSize);

  bool shouldOpenForNewMessages();

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  bool displayMessage(const QString& message, QtMsgType type = QtInfoMsg);

  void alwaysOpenForNewMessages(bool val);

  void showFullMessages(bool val);

  void copyToClipboard();

  void saveToFile();

  void clear();

  void showEvent(QShowEvent* event) override;

Q_SIGNALS:
  void messageDisplayed(const QString& message, int type);

protected:
  virtual bool suppress(const QString& message, QtMsgType type);

  virtual QString extractSummary(const QString& message, QtMsgType type);

private:
  Q_DISABLE_COPY(pqOutputWidget);

  class pqInternals;
  QScopedPointer<pqInternals> Internals;
  friend class OutputWidgetInternals::OutputWindow;
};

#endif