QGIS API Documentation  2.9.0-Master
Signals | Public Member Functions | List of all members
QgsMessageOutputConsole Class Reference

Default implementation of message output interface. More...

#include <qgsmessageoutput.h>

Inheritance diagram for QgsMessageOutputConsole:
Inheritance graph
[legend]

Signals

void destroyed ()
 signals that object will be destroyed and shouldn't be used anymore More...
 

Public Member Functions

 QgsMessageOutputConsole ()
 
virtual void appendMessage (const QString &message) override
 message to be appended to the current text More...
 
virtual void setMessage (const QString &message, MessageType msgType) override
 set message, it won't be displayed until More...
 
virtual void setTitle (const QString &title) override
 set title for the messages More...
 
virtual void showMessage (bool blocking=true) override
 sends the message to the standard output More...
 
- Public Member Functions inherited from QgsMessageOutput
virtual ~QgsMessageOutput ()
 virtual destructor More...
 

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

Default implementation of message output interface.

This class outputs messages to the standard output. Therefore it might be the right choice for apps without GUI.

Definition at line 87 of file qgsmessageoutput.h.

Constructor & Destructor Documentation

QgsMessageOutputConsole::QgsMessageOutputConsole ( )

Definition at line 57 of file qgsmessageoutput.cpp.

Member Function Documentation

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

message to be appended to the current text

Implements QgsMessageOutput.

Definition at line 69 of file qgsmessageoutput.cpp.

void QgsMessageOutputConsole::destroyed ( )
signal

signals that object will be destroyed and shouldn't be used anymore

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

set message, it won't be displayed until

Implements QgsMessageOutput.

Definition at line 63 of file qgsmessageoutput.cpp.

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

set title for the messages

Implements QgsMessageOutput.

Definition at line 87 of file qgsmessageoutput.cpp.

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

sends the message to the standard output

Implements QgsMessageOutput.

Definition at line 74 of file qgsmessageoutput.cpp.


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