widget to show Qt and VTK messages.
More...
#include <pqOutputWidget.h>
Inherits QWidget.
|
| pqOutputWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags()) |
|
| ~pqOutputWidget () override |
|
void | suppress (const QStringList &substrs) |
| Add substrings to match with message to determine whether they should be suppressed. More...
|
|
|
void | setSettingsKey (const QString &key) |
| Set the settings key that will be used to restore/save the state for the "Show full messages" button. More...
|
|
const QString & | settingsKey () const |
| Set the settings key that will be used to restore/save the state for the "Show full messages" button. More...
|
|
|
void | setFontSize (int fontSize) |
| Set/get the font size in points for the output console text. More...
|
|
widget to show Qt and VTK messages.
pqOutputWidget is QWidget subclass that can capture and show messages generated by Qt as well as VTK. On instantiation, it installs handlers to handle Qt and VTK messages.
Definition at line 105 of file pqOutputWidget.h.
◆ pqOutputWidget()
pqOutputWidget::pqOutputWidget |
( |
QWidget * |
parent = nullptr , |
|
|
Qt::WindowFlags |
f = Qt::WindowFlags() |
|
) |
| |
◆ ~pqOutputWidget()
pqOutputWidget::~pqOutputWidget |
( |
| ) |
|
|
override |
◆ suppress() [1/2]
void pqOutputWidget::suppress |
( |
const QStringList & |
substrs | ) |
|
Add substrings to match with message to determine whether they should be suppressed.
◆ setSettingsKey()
void pqOutputWidget::setSettingsKey |
( |
const QString & |
key | ) |
|
Set the settings key that will be used to restore/save the state for the "Show full messages" button.
By default "pqOutputWidget" will be used.
◆ settingsKey()
const QString& pqOutputWidget::settingsKey |
( |
| ) |
const |
Set the settings key that will be used to restore/save the state for the "Show full messages" button.
By default "pqOutputWidget" will be used.
◆ setFontSize()
void pqOutputWidget::setFontSize |
( |
int |
fontSize | ) |
|
Set/get the font size in points for the output console text.
◆ displayMessage
bool pqOutputWidget::displayMessage |
( |
const QString & |
message, |
|
|
QtMsgType |
type = QtInfoMsg |
|
) |
| |
|
slot |
Display a message in the widget.
There's generally no need to use this since one can have the same effect by triggering the message through Qt or VTK message notification mechanisms.
- Returns
- true if the message was displayed, otherwise false.
◆ showFullMessages
void pqOutputWidget::showFullMessages |
( |
bool |
val | ) |
|
|
slot |
Show full messages instead of grouped messages.
◆ copyToClipboard
void pqOutputWidget::copyToClipboard |
( |
| ) |
|
|
slot |
Copy output text to the clipboard.
◆ saveToFile
void pqOutputWidget::saveToFile |
( |
| ) |
|
|
slot |
Saves output text to a file.
◆ clear
void pqOutputWidget::clear |
( |
| ) |
|
|
slot |
◆ messageDisplayed
void pqOutputWidget::messageDisplayed |
( |
const QString & |
message, |
|
|
int |
type |
|
) |
| |
|
signal |
Signal fired any time a message is displayed.
◆ suppress() [2/2]
virtual bool pqOutputWidget::suppress |
( |
const QString & |
message, |
|
|
QtMsgType |
type |
|
) |
| |
|
protectedvirtual |
Returns true
if the message must be suppressed/ignored.
◆ extractSummary()
virtual QString pqOutputWidget::extractSummary |
( |
const QString & |
message, |
|
|
QtMsgType |
type |
|
) |
| |
|
protectedvirtual |
Extract a summary string from the message and returns that.
◆ OutputWidgetInternals::OutputWindow
friend class OutputWidgetInternals::OutputWindow |
|
friend |
◆ settingsKey
QString pqOutputWidget::settingsKey |
|
readwrite |
The documentation for this class was generated from the following file: