QGIS API Documentation
2.12.0-Lyon
|
Interface for showing messages from QGIS in GUI independent way. More...
#include <qgsmessageoutput.h>
Public Types | |
enum | MessageType { MessageText, MessageHtml } |
message can be in plain text or in html format More... | |
Public Member Functions | |
virtual | ~QgsMessageOutput () |
virtual destructor More... | |
virtual void | appendMessage (const QString &message)=0 |
message to be appended to the current text More... | |
virtual void | setMessage (const QString &message, MessageType msgType)=0 |
set message, it won't be displayed until More... | |
virtual void | setTitle (const QString &title)=0 |
set title for the messages More... | |
virtual void | showMessage (bool blocking=true)=0 |
display the message to the user and deletes itself More... | |
Static Public Member Functions | |
static QgsMessageOutput * | createMessageOutput () |
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... | |
Interface for showing messages from QGIS in GUI independent way.
This class provides abstraction of a dialog for showing output to the user. By default QgsMessageConsoleOutput will be used if not overridden with other message output creator function.
QGIS application uses QgsMessageView class for displaying a dialog to the user.
Object deletes itself when it's not needed anymore. Children should use signal destroyed() to notify the deletion
Definition at line 38 of file qgsmessageoutput.h.
|
virtual |
virtual destructor
Definition at line 41 of file qgsmessageoutput.cpp.
|
pure virtual |
message to be appended to the current text
Implemented in QgsMessageOutputConsole, and QgsMessageViewer.
|
static |
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)
Definition at line 36 of file qgsmessageoutput.cpp.
|
pure virtual |
set message, it won't be displayed until
Implemented in QgsMessageOutputConsole, and QgsMessageViewer.
|
static |
sets function that will be used to create message output
Definition at line 31 of file qgsmessageoutput.cpp.
|
pure virtual |
set title for the messages
Implemented in QgsMessageOutputConsole, and QgsMessageViewer.
|
pure virtual |
display the message to the user and deletes itself
Implemented in QgsMessageOutputConsole, and QgsMessageViewer.
|
static |
Display the blocking message to the user.
Definition at line 46 of file qgsmessageoutput.cpp.