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

A generic message view for displaying QGIS messages. More...

#include <qgsmessageviewer.h>

Inheritance diagram for QgsMessageViewer:
Inheritance graph
[legend]

Public Member Functions

 QgsMessageViewer (QWidget *parent=0, Qt::WindowFlags fl=QgisGui::ModalDialogFlags, bool deleteOnClose=true)
 ~QgsMessageViewer ()
virtual void setMessage (const QString &message, MessageType msgType)
 set message, it won't be displayed until
virtual void appendMessage (const QString &message)
 message to be appended to the current text
virtual void showMessage (bool blocking=true)
 display the message to the user
virtual void setTitle (const QString &title)
 set title for the messages
void setMessageAsHtml (const QString &msg)
void setMessageAsPlainText (const QString &msg)
void setCheckBoxText (const QString &text)
void setCheckBoxVisible (bool visible)
void setCheckBoxState (Qt::CheckState state)
Qt::CheckState checkBoxState ()
void setCheckBoxQSettingsLabel (QString label)
- Public Member Functions inherited from QgsMessageOutput
virtual ~QgsMessageOutput ()
 virtual destructor

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
static QgsMessageOutputcreateMessageOutput ()
 function that returns new class derived from QgsMessageOutput (don't forget to delete it then)

Detailed Description

A generic message view for displaying QGIS messages.

Constructor & Destructor Documentation

QgsMessageViewer::QgsMessageViewer ( QWidget *  parent = 0,
Qt::WindowFlags  fl = QgisGui::ModalDialogFlags,
bool  deleteOnClose = true 
)
QgsMessageViewer::~QgsMessageViewer ( )

Member Function Documentation

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

message to be appended to the current text

Implements QgsMessageOutput.

Qt::CheckState QgsMessageViewer::checkBoxState ( )
void QgsMessageViewer::setCheckBoxQSettingsLabel ( QString  label)
void QgsMessageViewer::setCheckBoxState ( Qt::CheckState  state)
void QgsMessageViewer::setCheckBoxText ( const QString &  text)
void QgsMessageViewer::setCheckBoxVisible ( bool  visible)
void QgsMessageViewer::setMessage ( const QString &  message,
MessageType  msgType 
)
virtual

set message, it won't be displayed until

Implements QgsMessageOutput.

void QgsMessageViewer::setMessageAsHtml ( const QString &  msg)
void QgsMessageViewer::setMessageAsPlainText ( const QString &  msg)
void QgsMessageViewer::setTitle ( const QString &  title)
virtual

set title for the messages

Implements QgsMessageOutput.

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

display the message to the user

Implements QgsMessageOutput.


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