QGIS API Documentation  3.20.0-Odense (decaadbb31)
Public Member Functions | List of all members
QgsMessageLogNotifyBlocker Class Reference

Temporarily blocks the application QgsMessageLog (see QgsApplication::messageLog()) from emitting the messageReceived( bool ) signal for the lifetime of the object. More...

#include <qgsmessagelog.h>

Public Member Functions

 QgsMessageLogNotifyBlocker ()
 Constructor for QgsMessageLogNotifyBlocker. More...
 
 QgsMessageLogNotifyBlocker (const QgsMessageLogNotifyBlocker &other)=delete
 QgsMessageLogNotifyBlocker cannot be copied. More...
 
 ~QgsMessageLogNotifyBlocker ()
 
QgsMessageLogNotifyBlockeroperator= (const QgsMessageLogNotifyBlocker &other)=delete
 QgsMessageLogNotifyBlocker cannot be copied. More...
 

Detailed Description

Temporarily blocks the application QgsMessageLog (see QgsApplication::messageLog()) from emitting the messageReceived( bool ) signal for the lifetime of the object.

Using this blocker allows messages to be logged without causing user interface hints flagging message log errors to be created.

QgsMessageLogNotifyBlocker supports "stacked" blocking, so two QgsMessageLogNotifyBlocker created will both need to be destroyed before the messageReceived( bool ) signal is emitted again.

Since
QGIS 3.2

Definition at line 104 of file qgsmessagelog.h.

Constructor & Destructor Documentation

◆ QgsMessageLogNotifyBlocker() [1/2]

QgsMessageLogNotifyBlocker::QgsMessageLogNotifyBlocker ( )

Constructor for QgsMessageLogNotifyBlocker.

This will block the log from emitting the messageReceived( bool ) signal for the lifetime of this object.

Definition at line 71 of file qgsmessagelog.cpp.

◆ QgsMessageLogNotifyBlocker() [2/2]

QgsMessageLogNotifyBlocker::QgsMessageLogNotifyBlocker ( const QgsMessageLogNotifyBlocker other)
delete

QgsMessageLogNotifyBlocker cannot be copied.

◆ ~QgsMessageLogNotifyBlocker()

QgsMessageLogNotifyBlocker::~QgsMessageLogNotifyBlocker ( )

Definition at line 76 of file qgsmessagelog.cpp.

Member Function Documentation

◆ operator=()

QgsMessageLogNotifyBlocker& QgsMessageLogNotifyBlocker::operator= ( const QgsMessageLogNotifyBlocker other)
delete

QgsMessageLogNotifyBlocker cannot be copied.


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