QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
A bar for displaying non-blocking messages to the user. More...
#include <qgsmessagebar.h>
Public Slots | |
bool | clearWidgets () |
Removes all items from the bar. | |
bool | popWidget () |
Remove the currently displayed item from the bar and display the next item in the stack. | |
void | pushCritical (const QString &title, const QString &message) |
Pushes a critical warning message that must be manually dismissed by the user. | |
void | pushInfo (const QString &title, const QString &message) |
Pushes a information message with default timeout to the message bar. | |
void | pushSuccess (const QString &title, const QString &message) |
Pushes a success message with default timeout to the message bar. | |
void | pushWarning (const QString &title, const QString &message) |
Pushes a warning message that must be manually dismissed by the user. | |
Signals | |
void | widgetAdded (QgsMessageBarItem *item) |
Emitted whenever an item is added to the bar. | |
void | widgetRemoved (QgsMessageBarItem *item) |
Emitted whenever an item was removed from the bar. | |
Public Member Functions | |
QgsMessageBar (QWidget *parent=nullptr) | |
Constructor for QgsMessageBar. | |
QgsMessageBarItem * | currentItem () |
Returns the current visible item, or nullptr if no item is shown. | |
QList< QgsMessageBarItem * > | items () |
Returns a list of all items currently visible or queued for the bar. | |
bool | popWidget (QgsMessageBarItem *item) |
Remove the specified item from the bar, and display the next most recent one in the stack. | |
void | pushItem (QgsMessageBarItem *item) |
Display a message item on the bar, after hiding the currently visible one and putting it in a stack. | |
void | pushMessage (const QString &text, Qgis::MessageLevel level=Qgis::MessageLevel::Info, int duration=-1) |
A convenience method for pushing a message with the specified text to the bar. | |
void | pushMessage (const QString &title, const QString &text, const QString &showMore, Qgis::MessageLevel level=Qgis::MessageLevel::Info, int duration=-1) |
A convenience method for pushing a message with the specified title and text to the bar. | |
void | pushMessage (const QString &title, const QString &text, Qgis::MessageLevel level=Qgis::MessageLevel::Info, int duration=-1) |
A convenience method for pushing a message with the specified title and text to the bar. | |
QgsMessageBarItem * | pushWidget (QWidget *widget, Qgis::MessageLevel level=Qgis::MessageLevel::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. | |
Static Public Member Functions | |
static QgsMessageBarItem * | createMessage (const QString &text, QWidget *parent=nullptr) |
Creates message bar item widget containing a message text to be displayed on the bar. | |
static QgsMessageBarItem * | createMessage (const QString &title, const QString &text, QWidget *parent=nullptr) |
Creates message bar item widget containing a title and message text to be displayed on the bar. | |
static QgsMessageBarItem * | createMessage (QWidget *widget, QWidget *parent=nullptr) |
Creates message bar item widget containing a custom widget to be displayed on the bar. | |
static int | defaultMessageTimeout (Qgis::MessageLevel level=Qgis::MessageLevel::NoLevel) |
Returns the default timeout in seconds for timed messages of the specified level. | |
Protected Member Functions | |
void | mousePressEvent (QMouseEvent *e) override |
Friends | |
class | TestQgsMessageBar |
A bar for displaying non-blocking messages to the user.
QgsMessageBar is a reusable widget which allows for providing feedback to users in a non-intrusive way. Messages are shown in a horizontal bar widget, which is styled automatically to reflect the severity ("message level") of the displayed message (e.g. warning messages are styled in an orange color scheme, critical errors are shown in red, etc).
The message bar supports automatic stacking of multiple messages, so that only the most recent message is shown to users. Users can then manually dismiss individual messages to remove them from the stack, causing the next-most-recent message to be shown. If no messages are available to show then the message bar automatically hides.
The class also supports pushing custom widgets to the notification stack via the pushWidget() method.
Definition at line 60 of file qgsmessagebar.h.
QgsMessageBar::QgsMessageBar | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsMessageBar.
Definition at line 37 of file qgsmessagebar.cpp.
|
slot |
Removes all items from the bar.
true
if all items were removed, false
otherwise Definition at line 184 of file qgsmessagebar.cpp.
|
static |
Creates message bar item widget containing a message text to be displayed on the bar.
The caller takes ownership of the returned item.
Definition at line 392 of file qgsmessagebar.cpp.
|
static |
Creates message bar item widget containing a title and message text to be displayed on the bar.
The caller takes ownership of the returned item.
Definition at line 398 of file qgsmessagebar.cpp.
|
static |
Creates message bar item widget containing a custom widget to be displayed on the bar.
The caller takes ownership of the returned item.
Definition at line 403 of file qgsmessagebar.cpp.
QgsMessageBarItem * QgsMessageBar::currentItem | ( | ) |
Returns the current visible item, or nullptr
if no item is shown.
Definition at line 382 of file qgsmessagebar.cpp.
|
static |
Returns the default timeout in seconds for timed messages of the specified level.
Definition at line 217 of file qgsmessagebar.cpp.
QList< QgsMessageBarItem * > QgsMessageBar::items | ( | ) |
Returns a list of all items currently visible or queued for the bar.
Definition at line 387 of file qgsmessagebar.cpp.
|
overrideprotected |
Definition at line 113 of file qgsmessagebar.cpp.
|
slot |
Remove the currently displayed item from the bar and display the next item in the stack.
If no remaining items are present, the bar will be hidden.
true
if the widget was removed, false
otherwise Definition at line 172 of file qgsmessagebar.cpp.
bool QgsMessageBar::popWidget | ( | QgsMessageBarItem * | item | ) |
Remove the specified item from the bar, and display the next most recent one in the stack.
If no messages remain in the stack, then the bar will be hidden.
item | previously added item to remove. |
true
if item was removed, false
otherwise Definition at line 163 of file qgsmessagebar.cpp.
|
slot |
Pushes a critical warning message that must be manually dismissed by the user.
Before QGIS 3.18 the default timeout was used.
title | title string for message |
message | The message to be displayed |
Definition at line 212 of file qgsmessagebar.cpp.
|
slot |
Pushes a information message with default timeout to the message bar.
title | title string for message |
message | The message to be displayed |
Definition at line 202 of file qgsmessagebar.cpp.
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 item.
Definition at line 297 of file qgsmessagebar.cpp.
void QgsMessageBar::pushMessage | ( | const QString & | text, |
Qgis::MessageLevel | level = Qgis::MessageLevel::Info , |
||
int | duration = -1 |
||
) |
A convenience method for pushing a message with the specified text to the bar.
The level argument specifies the desired message level (severity) of the message, which controls how the message bar is styled.
The optional duration argument can be used to specify the message timeout in seconds. If duration is set to 0, then the message must be manually dismissed by the user. Since QGIS 3.18, a duration of -1 indicates that the default timeout for the message level should be used.
Definition at line 408 of file qgsmessagebar.cpp.
void QgsMessageBar::pushMessage | ( | const QString & | title, |
const QString & | text, | ||
const QString & | showMore, | ||
Qgis::MessageLevel | level = Qgis::MessageLevel::Info , |
||
int | duration = -1 |
||
) |
A convenience method for pushing a message with the specified title and text to the bar.
Additional message content specified via showMore will be shown when the user presses a "more" button.
The level argument specifies the desired message level (severity) of the message, which controls how the message bar is styled.
The optional duration argument can be used to specify the message timeout in seconds. If duration is set to 0, then the message must be manually dismissed by the user. Since QGIS 3.18, a duration of -1 indicates that the default timeout for the message level should be used.
Definition at line 350 of file qgsmessagebar.cpp.
void QgsMessageBar::pushMessage | ( | const QString & | title, |
const QString & | text, | ||
Qgis::MessageLevel | level = Qgis::MessageLevel::Info , |
||
int | duration = -1 |
||
) |
A convenience method for pushing a message with the specified title and text to the bar.
The level argument specifies the desired message level (severity) of the message, which controls how the message bar is styled.
The optional duration argument can be used to specify the message timeout in seconds. If duration is set to 0, then the message must be manually dismissed by the user. Since QGIS 3.18, a duration of -1 indicates that the default timeout for the message level should be used.
Definition at line 337 of file qgsmessagebar.cpp.
|
slot |
Pushes a success message with default timeout to the message bar.
title | title string for message |
message | The message to be displayed |
Definition at line 197 of file qgsmessagebar.cpp.
|
slot |
Pushes a warning message that must be manually dismissed by the user.
Before QGIS 3.18 the default timeout was used.
title | title string for message |
message | The message to be displayed |
Definition at line 207 of file qgsmessagebar.cpp.
QgsMessageBarItem * QgsMessageBar::pushWidget | ( | QWidget * | widget, |
Qgis::MessageLevel | level = Qgis::MessageLevel::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.
widget | message widget to display |
level | is Qgis::MessageLevel::Info, Warning, Critical or Success |
duration | timeout duration of message in seconds, 0 value indicates no timeout (i.e. the message must be manually cleared by the user). |
Definition at line 321 of file qgsmessagebar.cpp.
|
signal |
Emitted whenever an item is added to the bar.
|
signal |
Emitted whenever an item was removed from the bar.
|
friend |
Definition at line 276 of file qgsmessagebar.h.