QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Member Functions | List of all members
QgsMessageViewer Class Reference

A generic message view for displaying QGIS messages. More...

#include <qgsmessageviewer.h>

Inheritance diagram for QgsMessageViewer:
Inheritance graph
[legend]

Public Member Functions

 QgsMessageViewer (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, bool deleteOnClose=true)
 
void appendMessage (const QString &message) override
 message to be appended to the current text More...
 
Qt::CheckState checkBoxState ()
 
void setCheckBoxQgsSettingsLabel (const QString &label)
 
void setCheckBoxState (Qt::CheckState state)
 
void setCheckBoxText (const QString &text)
 
void setCheckBoxVisible (bool visible)
 
void setMessage (const QString &message, MessageType msgType) override
 Sets message, it won't be displayed until. More...
 
void setMessageAsHtml (const QString &msg)
 
void setMessageAsPlainText (const QString &msg)
 
void setTitle (const QString &title) override
 Sets title for the messages. More...
 
void showMessage (bool blocking=true) override
 display the message to the user and deletes itself More...
 
- Public Member Functions inherited from QgsMessageOutput
virtual ~QgsMessageOutput ()=default
 

Additional Inherited Members

- Public Types inherited from QgsMessageOutput
enum  MessageType { MessageText , MessageHtml }
 message can be in plain text or in html format More...
 
- Static Public Member Functions inherited from QgsMessageOutput
static QgsMessageOutputcreateMessageOutput ()
 function that returns new class derived from QgsMessageOutput (don't forget to delete it then if showMessage(bool) is not used showMessage(bool) deletes the instance) More...
 
static void setMessageOutputCreator (MESSAGE_OUTPUT_CREATOR f)
 sets function that will be used to create message output More...
 
static void showMessage (const QString &title, const QString &message, MessageType msgType)
 Display the blocking message to the user. More...
 

Detailed Description

A generic message view for displaying QGIS messages.

Definition at line 32 of file qgsmessageviewer.h.

Constructor & Destructor Documentation

◆ QgsMessageViewer()

QgsMessageViewer::QgsMessageViewer ( QWidget *  parent = nullptr,
Qt::WindowFlags  fl = QgsGuiUtils::ModalDialogFlags,
bool  deleteOnClose = true 
)

Definition at line 22 of file qgsmessageviewer.cpp.

Member Function Documentation

◆ appendMessage()

void QgsMessageViewer::appendMessage ( const QString &  message)
overridevirtual

message to be appended to the current text

Implements QgsMessageOutput.

Definition at line 51 of file qgsmessageviewer.cpp.

◆ checkBoxState()

Qt::CheckState QgsMessageViewer::checkBoxState ( )

Definition at line 98 of file qgsmessageviewer.cpp.

◆ setCheckBoxQgsSettingsLabel()

void QgsMessageViewer::setCheckBoxQgsSettingsLabel ( const QString &  label)

Definition at line 103 of file qgsmessageviewer.cpp.

◆ setCheckBoxState()

void QgsMessageViewer::setCheckBoxState ( Qt::CheckState  state)

Definition at line 93 of file qgsmessageviewer.cpp.

◆ setCheckBoxText()

void QgsMessageViewer::setCheckBoxText ( const QString &  text)

Definition at line 83 of file qgsmessageviewer.cpp.

◆ setCheckBoxVisible()

void QgsMessageViewer::setCheckBoxVisible ( bool  visible)

Definition at line 88 of file qgsmessageviewer.cpp.

◆ setMessage()

void QgsMessageViewer::setMessage ( const QString &  message,
MessageType  msgType 
)
overridevirtual

Sets message, it won't be displayed until.

Implements QgsMessageOutput.

Definition at line 57 of file qgsmessageviewer.cpp.

◆ setMessageAsHtml()

void QgsMessageViewer::setMessageAsHtml ( const QString &  msg)

Definition at line 41 of file qgsmessageviewer.cpp.

◆ setMessageAsPlainText()

void QgsMessageViewer::setMessageAsPlainText ( const QString &  msg)

Definition at line 46 of file qgsmessageviewer.cpp.

◆ setTitle()

void QgsMessageViewer::setTitle ( const QString &  title)
overridevirtual

Sets title for the messages.

Implements QgsMessageOutput.

Definition at line 78 of file qgsmessageviewer.cpp.

◆ showMessage()

void QgsMessageViewer::showMessage ( bool  blocking = true)
overridevirtual

display the message to the user and deletes itself

Implements QgsMessageOutput.

Definition at line 65 of file qgsmessageviewer.cpp.


The documentation for this class was generated from the following files: