Core::MessageManager Namespace

namespace Core::MessageManager

The MessageManager namespace is used to post messages in the General Messages pane. More...

Header: #include <coreplugin/messagemanager.h>

Functions

Q_DECL_IMPORT writeDisrupting(const class QString &message)
Q_DECL_IMPORT writeDisrupting(const int &messages)
Q_DECL_IMPORT writeFlashing(const class QString &message)
Q_DECL_IMPORT writeFlashing(const int &messages)
Q_DECL_IMPORT writeSilently(const class QString &message)
Q_DECL_IMPORT writeSilently(const int &messages)

Detailed Description

Function Documentation

Q_DECL_IMPORT MessageManager::writeDisrupting(const class QString &message)

Writes the message to the General Messages pane and brings the pane to the front.

This might interrupt a user's workflow, so only use this as a direct response to something a user did, like explicitly running a tool.

See also writeSilently() and writeFlashing().

Q_DECL_IMPORT MessageManager::writeDisrupting(const int &messages)

This function overloads MessageManager::writeDisrupting().

Q_DECL_IMPORT MessageManager::writeFlashing(const class QString &message)

Writes the message to the General Messages pane and flashes the output pane button.

This notifies the user that something important has happened that might require the user's attention. Use sparingly, since continually flashing the button is annoying, especially if the condition is something the user might not be able to fix.

See also writeSilently() and writeDisrupting().

Q_DECL_IMPORT MessageManager::writeFlashing(const int &messages)

This function overloads MessageManager::writeFlashing().

Q_DECL_IMPORT MessageManager::writeSilently(const class QString &message)

Writes the message to the General Messages pane without any further action.

This is the preferred method of posting messages, since it does not interrupt the user.

See also writeFlashing() and writeDisrupting().

Q_DECL_IMPORT MessageManager::writeSilently(const int &messages)

This function overloads MessageManager::writeSilently().