A bar for displaying non-blocking messages to the user. More...

#include <qgsmessagebar.h>

Collaboration diagram for QgsMessageBar:

Public Types
enum	MessageLevel { INFO = 0, WARNING = 1, CRITICAL = 2 }

Public Slots
bool	popWidget ()
bool	clearWidgets ()

Signals
void	widgetAdded (QgsMessageBarItem *item)
	emitted when a message widget is added to the bar
void	widgetRemoved (QgsMessageBarItem *item)
	emitted when a message widget was removed from the bar

Public Member Functions
	QgsMessageBar (QWidget *parent=0)
	~QgsMessageBar ()
void	pushItem (QgsMessageBarItem *item)
QgsMessageBarItem *	pushWidget (QWidget *widget, MessageLevel level=INFO, int duration=0)
bool	popWidget (QgsMessageBarItem *item)
void	pushMessage (const QString &text, MessageLevel level=INFO, int duration=0)
	convenience method for pushing a message to the bar
void	pushMessage (const QString &title, const QString &text, MessageLevel level=INFO, int duration=0)
	convenience method for pushing a message with title to the bar

Static Public Member Functions
static QgsMessageBarItem *	createMessage (const QString &text, QWidget *parent=0)
	make out a widget containing a message to be displayed on the bar
static QgsMessageBarItem *	createMessage (const QString &title, const QString &text, QWidget *parent=0)
	make out a widget containing title and message to be displayed on the bar
static QgsMessageBarItem *	createMessage (QWidget widget, QWidget parent=0)
	make out a widget containing title and message to be displayed on the bar

Protected Member Functions
void	mousePressEvent (QMouseEvent *e)

Private Slots
void	updateItemCount ()
	updates count of items in widget list
void	updateCountdown ()
	updates the countdown for widgets that have a timeout duration
void	resetCountdown ()

Private Member Functions
void	popItem (QgsMessageBarItem *item)
void	showItem (QgsMessageBarItem *item)

Private Attributes
QgsMessageBarItem *	mCurrentItem
QList< QgsMessageBarItem * >	mItems
QMenu *	mCloseMenu
QToolButton *	mCloseBtn
QGridLayout *	mLayout
QLabel *	mItemCount
QAction *	mActionCloseAll
QTimer *	mCountdownTimer
QProgressBar *	mCountProgress
QString	mCountStyleSheet

Detailed Description

A bar for displaying non-blocking messages to the user.

Note: added in 1.9

Definition at line 43 of file qgsmessagebar.h.

Member Enumeration Documentation

enum QgsMessageBar::MessageLevel

Enumerator:

INFO
WARNING
CRITICAL

Definition at line 48 of file qgsmessagebar.h.

Constructor & Destructor Documentation

QgsMessageBar::QgsMessageBar ( QWidget * parent = 0 )

Definition at line 33 of file qgsmessagebar.cpp.

References clearWidgets(), QgsApplication::getThemeIcon(), mActionCloseAll, mCloseBtn, mCloseMenu, mCountdownTimer, mCountProgress, mCountStyleSheet, mItemCount, mLayout, popWidget(), tr, updateCountdown(), updateItemCount(), widgetAdded(), and widgetRemoved().

QgsMessageBar::~QgsMessageBar ( )

Definition at line 100 of file qgsmessagebar.cpp.

Member Function Documentation

bool QgsMessageBar::clearWidgets ( )

slot

remove all items from the bar's widget list

Returns: true if all items were removed, false otherwise

Definition at line 194 of file qgsmessagebar.cpp.

References mCurrentItem, mItems, and popWidget().

Referenced by QgsMessageBar().

QgsMessageBarItem * QgsMessageBar::createMessage	(	const QString &	text,
		QWidget *	parent = `0`
	)

static

make out a widget containing a message to be displayed on the bar

Definition at line 277 of file qgsmessagebar.cpp.

References INFO.

QgsMessageBarItem * QgsMessageBar::createMessage	(	const QString &	title,
		const QString &	text,
		QWidget *	parent = `0`
	)

static

make out a widget containing title and message to be displayed on the bar

Definition at line 283 of file qgsmessagebar.cpp.

References INFO.

QgsMessageBarItem * QgsMessageBar::createMessage	(	QWidget *	widget,
		QWidget *	parent = `0`
	)

static

make out a widget containing title and message to be displayed on the bar

Definition at line 288 of file qgsmessagebar.cpp.

References INFO.

void QgsMessageBar::mousePressEvent ( QMouseEvent * e )

protected

Definition at line 104 of file qgsmessagebar.cpp.

References mCountdownTimer, mCountProgress, and mCountStyleSheet.

void QgsMessageBar::popItem ( QgsMessageBarItem * item )

private

Definition at line 121 of file qgsmessagebar.cpp.

References mCurrentItem, mItems, mLayout, showItem(), and widgetRemoved().

Referenced by popWidget().

bool QgsMessageBar::popWidget ( QgsMessageBarItem * item )

remove the passed widget from the bar (if previously added), then display the next one in the stack if any or hide the bar

Parameters

item	item to remove

Returns: true if the widget was removed, false otherwise

Definition at line 157 of file qgsmessagebar.cpp.

References mCurrentItem, mItems, and popItem().

bool QgsMessageBar::popWidget ( )

slot

remove the currently displayed widget from the bar and display the next in the stack if any or hide the bar

Returns: true if the widget was removed, false otherwise

Definition at line 181 of file qgsmessagebar.cpp.

References mCurrentItem, popItem(), and resetCountdown().

Referenced by clearWidgets(), pushItem(), QgsMessageBar(), and updateCountdown().

void QgsMessageBar::pushItem ( QgsMessageBarItem * item )

display a message item on the bar after hiding the currently visible one and putting it in a stack.

Parameters

item	item to display

Definition at line 247 of file qgsmessagebar.cpp.

References popWidget(), resetCountdown(), and showItem().

Referenced by pushMessage(), and pushWidget().

void QgsMessageBar::pushMessage	(	const QString &	text,
		MessageLevel	level = `INFO`,
		int	duration = `0`
	)

inline

convenience method for pushing a message to the bar

Definition at line 87 of file qgsmessagebar.h.

References pushMessage().

Referenced by pushMessage().

void QgsMessageBar::pushMessage	(	const QString &	title,
		const QString &	text,
		QgsMessageBar::MessageLevel	level = `INFO`,
		int	duration = `0`
	)

convenience method for pushing a message with title to the bar

Definition at line 271 of file qgsmessagebar.cpp.

References pushItem().

QgsMessageBarItem * QgsMessageBar::pushWidget	(	QWidget *	widget,
		QgsMessageBar::MessageLevel	level = `INFO`,
		int	duration = `0`
	)

display a widget as a message on the bar after hiding the currently visible one and putting it in a stack.

Parameters

widget	message widget to display
level	is QgsMessageBar::INFO, WARNING or CRITICAL
duration	timeout duration of message in seconds, 0 value indicates no timeout

Definition at line 255 of file qgsmessagebar.cpp.

References pushItem(), QgsMessageBarItem::setDuration(), and QgsMessageBarItem::setLevel().

void QgsMessageBar::resetCountdown ( )

privateslot

Definition at line 310 of file qgsmessagebar.cpp.

References mCountdownTimer, mCountProgress, and mCountStyleSheet.

Referenced by popWidget(), pushItem(), and updateCountdown().

void QgsMessageBar::showItem ( QgsMessageBarItem * item )

private

Definition at line 208 of file qgsmessagebar.cpp.

References QgsMessageBarItem::duration(), QgsMessageBarItem::getStyleSheet(), mCountdownTimer, mCountProgress, mCurrentItem, mItems, mLayout, and widgetAdded().

Referenced by popItem(), and pushItem().