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

#include <qgsmessagebar.h>

Inheritance diagram for QgsMessageBar:

Public Slots
bool	clearWidgets ()
	Remove all items from the bar's widget list. More...

bool	popWidget ()
	Remove the currently displayed widget from the bar and display the next in the stack if any or hide the bar. More...

void	pushCritical (const QString &title, const QString &message)
	Pushes a critical warning with default timeout to the message bar. More...

void	pushInfo (const QString &title, const QString &message)
	Pushes a information message with default timeout to the message bar. More...

void	pushSuccess (const QString &title, const QString &message)
	Pushes a success message with default timeout to the message bar. More...

void	pushWarning (const QString &title, const QString &message)
	Pushes a warning with default timeout to the message bar. More...

Signals
void	widgetAdded (QgsMessageBarItem *item)
	emitted when a message widget is added to the bar More...

void	widgetRemoved (QgsMessageBarItem *item)
	emitted when a message widget was removed from the bar More...

Public Member Functions
	QgsMessageBar (QWidget *parent=nullptr)
	Constructor for QgsMessageBar. More...

QgsMessageBarItem *	currentItem ()

bool	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. More...

void	pushItem (QgsMessageBarItem *item)
	Display a message item on the bar after hiding the currently visible one and putting it in a stack. More...

void	pushMessage (const QString &text, Qgis::MessageLevel level=Qgis::Info, int duration=5)
	convenience method for pushing a message to the bar More...

void	pushMessage (const QString &title, const QString &text, Qgis::MessageLevel level=Qgis::Info, int duration=5)
	convenience method for pushing a message with title to the bar More...

void	pushMessage (const QString &title, const QString &text, const QString &showMore, Qgis::MessageLevel level=Qgis::Info, int duration=5)
	convenience method for pushing a message to the bar with a detail text which be shown when pressing a "more" button More...

QgsMessageBarItem *	pushWidget (QWidget *widget, Qgis::MessageLevel level=Qgis::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. More...

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

static QgsMessageBarItem *	createMessage (const QString &title, const QString &text, QWidget *parent=nullptr)
	make out a widget containing title and message to be displayed on the bar More...

static QgsMessageBarItem *	createMessage (QWidget widget, QWidget parent=nullptr)
	make out a widget containing title and message to be displayed on the bar More...

Protected Member Functions
void	mousePressEvent (QMouseEvent *e) override

Detailed Description

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

Definition at line 45 of file qgsmessagebar.h.

Constructor & Destructor Documentation

◆ QgsMessageBar()

QgsMessageBar::QgsMessageBar ( QWidget * parent = nullptr )

Constructor for QgsMessageBar.

Definition at line 35 of file qgsmessagebar.cpp.

Member Function Documentation

◆ clearWidgets

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.

◆ createMessage() [1/3]

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

static

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

Definition at line 328 of file qgsmessagebar.cpp.

◆ createMessage() [2/3]

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

static

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

Definition at line 334 of file qgsmessagebar.cpp.

◆ createMessage() [3/3]

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

static

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

Definition at line 339 of file qgsmessagebar.cpp.

◆ currentItem()

QgsMessageBarItem* QgsMessageBar::currentItem ( )

inline

Definition at line 95 of file qgsmessagebar.h.

◆ mousePressEvent()

void QgsMessageBar::mousePressEvent ( QMouseEvent * e )

overrideprotected

Definition at line 104 of file qgsmessagebar.cpp.

◆ popWidget() [1/2]

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.

◆ popWidget [2/2]

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.

◆ pushCritical

void QgsMessageBar::pushCritical	(	const QString &	title,
		const QString &	message
	)

slot

Pushes a critical warning with default timeout to the message bar.

Parameters

title	title string for message
message	The message to be displayed

Since: QGIS 2.8

Definition at line 223 of file qgsmessagebar.cpp.

◆ pushInfo

void QgsMessageBar::pushInfo	(	const QString &	title,
		const QString &	message
	)

slot

Pushes a information message with default timeout to the message bar.

Parameters

title	title string for message
message	The message to be displayed

Since: QGIS 2.8

Definition at line 213 of file qgsmessagebar.cpp.

◆ pushItem()

void QgsMessageBar::pushItem ( QgsMessageBarItem * item )

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

The message bar will take ownership of the item.

Parameters

item	Item to display

Definition at line 267 of file qgsmessagebar.cpp.

◆ pushMessage() [1/3]

void QgsMessageBar::pushMessage	(	const QString &	text,
		Qgis::MessageLevel	level = `Qgis::Info`,
		int	duration = `5`
	)

inline

convenience method for pushing a message to the bar

Definition at line 88 of file qgsmessagebar.h.

◆ pushMessage() [2/3]

void QgsMessageBar::pushMessage	(	const QString &	title,
		const QString &	text,
		Qgis::MessageLevel	level = `Qgis::Info`,
		int	duration = `5`
	)

convenience method for pushing a message with title to the bar

Definition at line 296 of file qgsmessagebar.cpp.

◆ pushMessage() [3/3]

void QgsMessageBar::pushMessage	(	const QString &	title,
		const QString &	text,
		const QString &	showMore,
		Qgis::MessageLevel	level = `Qgis::Info`,
		int	duration = `5`
	)

convenience method for pushing a message to the bar with a detail text which be shown when pressing a "more" button

Definition at line 302 of file qgsmessagebar.cpp.

◆ pushSuccess

void QgsMessageBar::pushSuccess	(	const QString &	title,
		const QString &	message
	)

slot

Pushes a success message with default timeout to the message bar.

Parameters

title	title string for message
message	The message to be displayed

Since: QGIS 2.8

Definition at line 208 of file qgsmessagebar.cpp.

◆ pushWarning

void QgsMessageBar::pushWarning	(	const QString &	title,
		const QString &	message
	)

slot

Pushes a warning with default timeout to the message bar.

Parameters

title	title string for message
message	The message to be displayed

Since: QGIS 2.8

Definition at line 218 of file qgsmessagebar.cpp.

◆ pushWidget()

QgsMessageBarItem * QgsMessageBar::pushWidget	(	QWidget *	widget,
		Qgis::MessageLevel	level = `Qgis::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 Qgis::Info, Warning, Critical or Success
duration	timeout duration of message in seconds, 0 value indicates no timeout

Definition at line 280 of file qgsmessagebar.cpp.

◆ widgetAdded

void QgsMessageBar::widgetAdded ( QgsMessageBarItem * item )

signal

emitted when a message widget is added to the bar

◆ widgetRemoved

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-3.2.0+99unstable/src/gui/qgsmessagebar.h
/tmp/buildd/qgis-3.2.0+99unstable/src/gui/qgsmessagebar.cpp

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsMessageBar()

Member Function Documentation

◆ clearWidgets

◆ createMessage() [1/3]

◆ createMessage() [2/3]

◆ createMessage() [3/3]

◆ currentItem()

◆ mousePressEvent()

◆ popWidget() [1/2]

◆ popWidget [2/2]

◆ pushCritical

◆ pushInfo

◆ pushItem()

◆ pushMessage() [1/3]

◆ pushMessage() [2/3]

◆ pushMessage() [3/3]

◆ pushSuccess

◆ pushWarning

◆ pushWidget()

◆ widgetAdded

◆ widgetRemoved