Subgroup: Message
Class: QgsMessageBar¶
-
class
qgis.gui.
QgsMessageBar
(parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QFrame
Constructor for QgsMessageBar
A bar for displaying non-blocking messages to the user.
Methods
actionEvent
changeEvent
childEvent
clearWidgets
Remove all items from the bar’s widget list closeEvent
connectNotify
contextMenuEvent
create
createMessage
make out a widget containing a message to be displayed on the bar currentItem
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
drawFrame
dropEvent
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
initPainter
initStyleOption
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
popWidget
Remove the passed widget from the bar (if previously added), then display the next one in the stack if any or hide the bar pushCritical
Pushes a critical warning with default timeout to the message bar pushInfo
Pushes a information message with default timeout to the message bar pushItem
Display a message item on the bar after hiding the currently visible one and putting it in a stack. pushMessage
convenience method for pushing a message to the bar pushSuccess
Pushes a success message with default timeout to the message bar pushWarning
Pushes a warning with default timeout to the message bar pushWidget
Display a widget as a message on the bar after hiding the currently visible one and putting it in a stack. receivers
resizeEvent
sender
senderSignalIndex
sharedPainter
showEvent
tabletEvent
timerEvent
updateMicroFocus
wheelEvent
Signals
widgetAdded
emitted when a message widget is added to the bar [signal] widgetRemoved
emitted when a message widget was removed from the bar [signal] Attributes
-
actionEvent
()¶
-
changeEvent
()¶
-
childEvent
()¶
-
clearWidgets
(self) → bool¶ Remove all items from the bar’s widget list
Returns: true if all items were removed, false otherwise
-
closeEvent
()¶
-
connectNotify
()¶
-
contextMenuEvent
()¶
-
create
()¶
-
createMessage
(text: str, parent: QWidget = None) → QgsMessageBarItem¶ make out a widget containing a message to be displayed on the bar
createMessage(title: str, text: str, parent: QWidget = None) -> QgsMessageBarItem make out a widget containing title and message to be displayed on the bar
createMessage(widget: QWidget, parent: QWidget = None) -> QgsMessageBarItem make out a widget containing title and message to be displayed on the bar
-
currentItem
(self) → QgsMessageBarItem¶
-
customEvent
()¶
-
destroy
()¶
-
disconnectNotify
()¶
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
drawFrame
()¶
-
dropEvent
()¶
-
enterEvent
()¶
-
event
()¶
-
focusInEvent
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPreviousChild
()¶
-
hideEvent
()¶
-
initPainter
()¶
-
initStyleOption
()¶
-
inputMethodEvent
()¶
-
isSignalConnected
()¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
leaveEvent
()¶
-
metric
()¶
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
(self, e: QMouseEvent)¶
-
mouseReleaseEvent
()¶
-
moveEvent
()¶
-
nativeEvent
()¶
-
paintEvent
()¶
-
popWidget
(self, item: QgsMessageBarItem) → bool¶ 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 popWidget(self) -> bool 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
-
pushCritical
(self, title: str, message: str)¶ Pushes a critical warning with default timeout to the message bar
Parameters: - title – title string for message
- message – The message to be displayed
New in version 2.8.
-
pushInfo
(self, title: str, message: str)¶ Pushes a information message with default timeout to the message bar
Parameters: - title – title string for message
- message – The message to be displayed
New in version 2.8.
-
pushItem
(self, item: QgsMessageBarItem)¶ 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
-
pushMessage
(self, text: str, level: Qgis.MessageLevel = Qgis.Info, duration: int = 5)¶ convenience method for pushing a message to the bar
pushMessage(self, title: str, text: str, level: Qgis.MessageLevel = Qgis.Info, duration: int = 5) convenience method for pushing a message with title to the bar
-
pushSuccess
(self, title: str, message: str)¶ Pushes a success message with default timeout to the message bar
Parameters: - title – title string for message
- message – The message to be displayed
New in version 2.8.
-
pushWarning
(self, title: str, message: str)¶ Pushes a warning with default timeout to the message bar
Parameters: - title – title string for message
- message – The message to be displayed
New in version 2.8.
-
pushWidget
(self, widget: QWidget, level: Qgis.MessageLevel = Qgis.Info, duration: int = 0) → QgsMessageBarItem¶ 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
-
receivers
()¶
-
resizeEvent
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
showEvent
()¶
-
tabletEvent
()¶
-
timerEvent
()¶
-
updateMicroFocus
()¶
-
wheelEvent
()¶
-
widgetAdded
¶ emitted when a message widget is added to the bar [signal]
-
widgetRemoved
¶ emitted when a message widget was removed from the bar [signal]
-