MessageHandler Class Reference

Inheritance diagram for MessageHandler:

Signals
void	sigDeliverMessage (QtMsgType type, const QString &message)

Public Member Functions
bool	isLoggingEnabled () const
void	setLoggingEnabled (bool value)
	~MessageHandler ()

Public Attributes
std::unique_ptr< MessageForwarderThread >	m_forwarderThread
QtMessageHandler	m_originalMessageHandler {nullptr}

Detailed Description

MessageHandler is the main object that handles management of the debug message delivery. It creates a backgroud thread and set up all the connections when requested.

MessageHandler is a singleton, i.e. it will be reused by all the logging dockers we have in any of Krita's windows.

Definition at line 112 of file LogDockerDock.cpp.

Constructor & Destructor Documentation

~MessageHandler()

MessageHandler::~MessageHandler ( )

inline

Definition at line 116 of file LogDockerDock.cpp.

                      {
        setLoggingEnabled(false);
    }

References setLoggingEnabled().

Member Function Documentation

isLoggingEnabled()

bool MessageHandler::isLoggingEnabled ( ) const

inline

Definition at line 138 of file LogDockerDock.cpp.

                                  {
        return m_originalMessageHandler;
    }

References m_originalMessageHandler.

setLoggingEnabled()

void MessageHandler::setLoggingEnabled ( bool value )

inline

Definition at line 120 of file LogDockerDock.cpp.

                                       {
        if (value == isLoggingEnabled()) return;
        
        if (value) {
            const QtMessageHandler oldHandler = qInstallMessageHandler(kritaLoggerMessageHandler);
            m_originalMessageHandler = oldHandler;
            m_forwarderThread.reset(new MessageForwarderThread());
            connect(m_forwarderThread.get(), &MessageForwarderThread::sigDeliverMessage, this, &MessageHandler::sigDeliverMessage);
            m_forwarderThread->start();
        } else {
            qInstallMessageHandler(nullptr);
            m_originalMessageHandler = nullptr;
            m_forwarderThread->pushExitFlag();
            m_forwarderThread->wait();
            m_forwarderThread.reset();
        }
    }

References isLoggingEnabled(), kritaLoggerMessageHandler(), m_forwarderThread, m_originalMessageHandler, MessageForwarderThread::sigDeliverMessage(), sigDeliverMessage(), and value().

sigDeliverMessage

void MessageHandler::sigDeliverMessage ( QtMsgType type, const QString & message )

signal

Member Data Documentation

m_forwarderThread

std::unique_ptr<MessageForwarderThread> MessageHandler::m_forwarderThread

Definition at line 147 of file LogDockerDock.cpp.

m_originalMessageHandler

QtMessageHandler MessageHandler::m_originalMessageHandler {nullptr}

Definition at line 146 of file LogDockerDock.cpp.

{nullptr};

---

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

• plugins/dockers/logdocker/LogDockerDock.cpp