QGIS API Documentation 3.27.0-Master (75dc696944)
qgsmessageviewer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmessageviewer.h - description
3 -------------------
4 begin : Wed Jun 4 2003
5 copyright : (C) 2002 by Gary E.Sherman
6 email : sherman at mrcc.com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17#ifndef QGSMESSAGEVIEWER_H
18#define QGSMESSAGEVIEWER_H
19
20#include "ui_qgsmessageviewer.h"
21#include "qgsguiutils.h"
22#include "qgsmessageoutput.h"
23#include "qgis_gui.h"
24
25#include <QString>
26
27
32class GUI_EXPORT QgsMessageViewer: public QDialog, public QgsMessageOutput, private Ui::QgsMessageViewer
33{
34 Q_OBJECT
35 public:
36 QgsMessageViewer( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, bool deleteOnClose = true );
37
38 void setMessage( const QString &message, MessageType msgType ) override;
39
40 void appendMessage( const QString &message ) override;
41
42 void showMessage( bool blocking = true ) override;
43
44 void setTitle( const QString &title ) override;
45
46 // Call one of the setMessage...() functions first.
47 // Subsequent calls to appendMessage use the format as determined
48 // by the call to setMessage...()
49
50 // Treats the given text as html.
51 void setMessageAsHtml( const QString &msg );
52 // Treats the given text as plain text
53 void setMessageAsPlainText( const QString &msg );
54 // A checkbox that can be used for something like
55 // "don't show this message again"
56 void setCheckBoxText( const QString &text );
57 // Make the checkbox visible/invisible
58 void setCheckBoxVisible( bool visible );
59 // Sets the check state
60 void setCheckBoxState( Qt::CheckState state );
61 // Get checkbox state
62 Qt::CheckState checkBoxState();
63 // Specifies a QgsSettings tag to store/retrieve the checkbox
64 // state to/from. Use an empty QString to disable this feature.
65 void setCheckBoxQgsSettingsLabel( const QString &label );
66
67 private slots:
68 void checkBox_toggled( bool );
69
70
71 private:
72 QString mCheckBoxQgsSettingsLabel;
73};
74
75#endif
Interface for showing messages from QGIS in GUI independent way.
MessageType
message can be in plain text or in html format
virtual void showMessage(bool blocking=true)=0
display the message to the user and deletes itself
virtual void appendMessage(const QString &message)=0
message to be appended to the current text
virtual void setMessage(const QString &message, MessageType msgType)=0
Sets message, it won't be displayed until.
virtual void setTitle(const QString &title)=0
Sets title for the messages.
A generic message view for displaying QGIS messages.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53