A bar for displaying non-blocking messages to the user.
More...
#include <qgsmessagebar.h>
|
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...
|
|
A bar for displaying non-blocking messages to the user.
Definition at line 45 of file qgsmessagebar.h.
◆ QgsMessageBar()
QgsMessageBar::QgsMessageBar |
( |
QWidget * |
parent = nullptr | ) |
|
◆ 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 193 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 301 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 307 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 312 of file qgsmessagebar.cpp.
◆ currentItem()
◆ mousePressEvent()
void QgsMessageBar::mousePressEvent |
( |
QMouseEvent * |
e | ) |
|
|
overrideprotected |
◆ popWidget() [1/2]
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
-
- Returns
- true if the widget was removed, false otherwise
Definition at line 156 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 180 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 222 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 212 of file qgsmessagebar.cpp.
◆ pushItem()
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
-
Definition at line 266 of file qgsmessagebar.cpp.
◆ pushMessage() [1/2]
convenience method for pushing a message to the bar
Definition at line 88 of file qgsmessagebar.h.
◆ pushMessage() [2/2]
convenience method for pushing a message with title to the bar
Definition at line 295 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 207 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 217 of file qgsmessagebar.cpp.
◆ pushWidget()
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 279 of file qgsmessagebar.cpp.
◆ widgetAdded
emitted when a message widget is added to the bar
◆ widgetRemoved
emitted when a message widget was removed from the bar
The documentation for this class was generated from the following files: