pqOutputWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqOutputWidget.h
5 
6  Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 ========================================================================*/
32 #ifndef pqOutputWidget_h
33 #define pqOutputWidget_h
34 
35 #include <QWidget>
36 
37 #include "pqCoreModule.h" // for exports
38 #include <QScopedPointer> // for QScopedPointer.
39 
40 class pqOutputWidget;
41 
43 {
44 class OutputWindow;
45 };
46 
47 Q_DECLARE_METATYPE(QtMsgType)
61 class PQCORE_EXPORT MessageHandler : public QObject
62 {
63  Q_OBJECT
64 public:
65  MessageHandler(QObject* parent = nullptr);
66 
73  static void install(pqOutputWidget* widget);
74 
78  static void handler(QtMsgType type, const QMessageLogContext&, const QString& msg);
79 
83  static void handlerVTK(QtMsgType type, const QString& msg);
84 
85 Q_SIGNALS:
86  void message(QtMsgType type, const QString& msg);
87  void showMessage(QString msg, QtMsgType type);
88 
89 private:
90  static MessageHandler* instance();
91 
92 private Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
93  void displayMessage(QtMsgType type, const QString& msg);
94 };
95 
105 class PQCORE_EXPORT pqOutputWidget : public QWidget
106 {
107  Q_OBJECT
108  typedef QWidget Superclass;
109  Q_PROPERTY(QString settingsKey READ settingsKey WRITE setSettingsKey);
110 
111 public:
112  pqOutputWidget(QWidget* parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
113  ~pqOutputWidget() override;
114 
119  void suppress(const QStringList& substrs);
120 
122 
126  void setSettingsKey(const QString& key);
127  const QString& settingsKey() const;
129 
131 
134  void setFontSize(int fontSize);
136 
140  bool shouldOpenForNewMessages();
141 
142 public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
150  bool displayMessage(const QString& message, QtMsgType type = QtInfoMsg);
151 
155  void alwaysOpenForNewMessages(bool val);
156 
160  void showFullMessages(bool val);
161 
165  void copyToClipboard();
166 
170  void saveToFile();
171 
175  void clear();
176 
180  void showEvent(QShowEvent* event) override;
181 
182 Q_SIGNALS:
186  void messageDisplayed(const QString& message, int type);
187 
188 protected:
192  virtual bool suppress(const QString& message, QtMsgType type);
193 
197  virtual QString extractSummary(const QString& message, QtMsgType type);
198 
199 private:
200  Q_DISABLE_COPY(pqOutputWidget)
201 
202  class pqInternals;
203  QScopedPointer<pqInternals> Internals;
204  friend class OutputWidgetInternals::OutputWindow;
205 };
206 
207 #endif
type
widget to show Qt and VTK messages.
void VTKPVADAPTORSCTH_EXPORT handler(int sig)
#define PQCORE_EXPORT
Definition: pqCoreModule.h:15
widget to show Qt and VTK messages.