QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Signals | Public Member Functions | Private Attributes | List of all members
QgsMessageOutputConsole Class Reference

Default implementation of message output interface. More...

#include <qgsmessageoutput.h>

Inheritance diagram for QgsMessageOutputConsole:
Inheritance graph
[legend]
Collaboration diagram for QgsMessageOutputConsole:
Collaboration graph
[legend]

Signals

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

Public Member Functions

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

Private Attributes

QString mMessage
 stores current message More...
 
QString mTitle
 stores current title More...
 
MessageType mMsgType
 

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 void setMessageOutputCreator (MESSAGE_OUTPUT_CREATOR f)
 sets function that will be used to create message output More...
 
static QgsMessageOutputcreateMessageOutput ()
 function that returns new class derived from QgsMessageOutput (don't forget to delete it then) 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 82 of file qgsmessageoutput.h.

Constructor & Destructor Documentation

QgsMessageOutputConsole::QgsMessageOutputConsole ( )

Definition at line 48 of file qgsmessageoutput.cpp.

Member Function Documentation

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

message to be appended to the current text

Implements QgsMessageOutput.

Definition at line 59 of file qgsmessageoutput.cpp.

References mMessage.

void QgsMessageOutputConsole::destroyed ( )
signal

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

Referenced by showMessage().

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

set message, it won't be displayed until

Implements QgsMessageOutput.

Definition at line 53 of file qgsmessageoutput.cpp.

References mMessage, and mMsgType.

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

set title for the messages

Implements QgsMessageOutput.

Definition at line 77 of file qgsmessageoutput.cpp.

References mTitle.

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

sends the message to the standard output

Implements QgsMessageOutput.

Definition at line 64 of file qgsmessageoutput.cpp.

References destroyed(), QgsMessageLog::logMessage(), QgsMessageOutput::MessageHtml, mMessage, mMsgType, mTitle, and tr.

Member Data Documentation

QString QgsMessageOutputConsole::mMessage
private

stores current message

Definition at line 107 of file qgsmessageoutput.h.

Referenced by appendMessage(), setMessage(), and showMessage().

MessageType QgsMessageOutputConsole::mMsgType
private

Definition at line 112 of file qgsmessageoutput.h.

Referenced by setMessage(), and showMessage().

QString QgsMessageOutputConsole::mTitle
private

stores current title

Definition at line 110 of file qgsmessageoutput.h.

Referenced by setTitle(), and showMessage().


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