QgsMessageBar Class Reference

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

#include <qgsmessagebar.h>

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)

Detailed Description

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

Member Enumeration Documentation

enum QgsMessageBar::MessageLevel

Enumerator:

INFO
WARNING
CRITICAL

Constructor & Destructor Documentation

QgsMessageBar::QgsMessageBar

(

QWidget *

parent = 0

)

QgsMessageBar::~QgsMessageBar

(

)

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

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

static

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

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

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

static

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

void QgsMessageBar::mousePressEvent ( QMouseEvent *  e )

protected

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

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

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

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

inline

convenience method for pushing a message to the bar

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

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

void QgsMessageBar::widgetAdded ( QgsMessageBarItem *  item )

signal

emitted when a message widget is added to the bar

void QgsMessageBar::widgetRemoved ( QgsMessageBarItem *  item )

signal

emitted when a message widget was removed from the bar

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmessagebar.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmessagebar.cpp