QgsMessageViewer Class Reference

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

#include <qgsmessageviewer.h>

Inheritance diagram for QgsMessageViewer:

Collaboration diagram for QgsMessageViewer:

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 More...
virtual void	appendMessage (const QString &message)
	message to be appended to the current text More...
virtual void	showMessage (bool blocking=true)
	display the message to the user More...
virtual void	setTitle (const QString &title)
	set title for the messages More...
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 More...

Private Slots
void	on_checkBox_toggled (bool)

Private Attributes
QString	mCheckBoxQSettingsLabel

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

Detailed Description

A generic message view for displaying QGIS messages.

Definition at line 30 of file qgsmessageviewer.h.

Constructor & Destructor Documentation

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

Definition at line 21 of file qgsmessageviewer.cpp.

References mCheckBoxQSettingsLabel, setCheckBoxState(), and setCheckBoxVisible().

QgsMessageViewer::~QgsMessageViewer

(

)

Definition at line 39 of file qgsmessageviewer.cpp.

Member Function Documentation

void QgsMessageViewer::appendMessage ( const QString &  message )

virtual

message to be appended to the current text

Implements QgsMessageOutput.

Definition at line 55 of file qgsmessageviewer.cpp.

Qt::CheckState QgsMessageViewer::checkBoxState

(

)

Definition at line 103 of file qgsmessageviewer.cpp.

void QgsMessageViewer::on_checkBox_toggled ( bool  toggled )

privateslot

Definition at line 114 of file qgsmessageviewer.cpp.

References mCheckBoxQSettingsLabel.

void QgsMessageViewer::setCheckBoxQSettingsLabel

(

QString

label

)

Definition at line 108 of file qgsmessageviewer.cpp.

References mCheckBoxQSettingsLabel.

void QgsMessageViewer::setCheckBoxState

(

Qt::CheckState

state

)

Definition at line 98 of file qgsmessageviewer.cpp.

Referenced by QgsMessageViewer().

void QgsMessageViewer::setCheckBoxText

(

const QString &

text

)

Definition at line 88 of file qgsmessageviewer.cpp.

void QgsMessageViewer::setCheckBoxVisible

(

bool

visible

)

Definition at line 93 of file qgsmessageviewer.cpp.

Referenced by QgsMessageViewer().

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

virtual

set message, it won't be displayed until

Implements QgsMessageOutput.

Definition at line 61 of file qgsmessageviewer.cpp.

References QgsMessageOutput::MessageHtml, setMessageAsHtml(), and setMessageAsPlainText().

void QgsMessageViewer::setMessageAsHtml

(

const QString &

msg

)

Definition at line 45 of file qgsmessageviewer.cpp.

Referenced by QgsExpressionBuilderWidget::on_lblPreview_linkActivated(), setMessage(), QgsDataDefinedButton::showDescriptionDialog(), and QgsOWSSourceSelect::showError().

void QgsMessageViewer::setMessageAsPlainText

(

const QString &

msg

)

Definition at line 50 of file qgsmessageviewer.cpp.

Referenced by setMessage(), and QgsOWSSourceSelect::showError().

void QgsMessageViewer::setTitle ( const QString &  title )

virtual

set title for the messages

Implements QgsMessageOutput.

Definition at line 83 of file qgsmessageviewer.cpp.

void QgsMessageViewer::showMessage ( bool  blocking = true )

virtual

display the message to the user

Implements QgsMessageOutput.

Definition at line 69 of file qgsmessageviewer.cpp.

Referenced by QgsOWSSourceSelect::showError().

Member Data Documentation

QString QgsMessageViewer::mCheckBoxQSettingsLabel

private

Definition at line 71 of file qgsmessageviewer.h.

Referenced by on_checkBox_toggled(), QgsMessageViewer(), and setCheckBoxQSettingsLabel().

---

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

• /tmp/buildd/qgis-2.4.0+unstable1/src/gui/qgsmessageviewer.h
• /tmp/buildd/qgis-2.4.0+unstable1/src/gui/qgsmessageviewer.cpp