/************************************************************************ * This file has been generated automatically from * * * * src/gui/qgsmessagebar.h * * * * Do not edit manually ! Edit header and run scripts/sipify.pl again * ************************************************************************/ class QgsMessageBar: QFrame { %Docstring 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. %End %TypeHeaderCode #include "qgsmessagebar.h" %End public: QgsMessageBar( QWidget *parent /TransferThis/ = 0 ); %Docstring Constructor for QgsMessageBar %End void pushItem( QgsMessageBarItem *item /Transfer/ ); %Docstring 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``. %End QgsMessageBarItem *pushWidget( QWidget *widget /Transfer/, Qgis::MessageLevel level = Qgis::Info, int duration = 0 ); %Docstring Display a ``widget`` as a message on the bar, after hiding the currently visible one and putting it in a stack. :param widget: message widget to display :param level: is Qgis.Info, Warning, Critical or Success :param duration: timeout duration of message in seconds, 0 value indicates no timeout (i.e. the message must be manually cleared by the user). %End bool popWidget( QgsMessageBarItem *item ); %Docstring 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. :param item: previously added item to remove. :return: ``True`` if ``item`` was removed, ``False`` otherwise %End static QgsMessageBarItem *createMessage( const QString &text, QWidget *parent = 0 ) /Factory/; %Docstring Creates message bar item widget containing a message ``text`` to be displayed on the bar. The caller takes ownership of the returned item. .. note:: This is a low-level API call. Users are recommended to use the high-level pushMessage() API call instead. %End static QgsMessageBarItem *createMessage( const QString &title, const QString &text, QWidget *parent = 0 ) /Factory/; %Docstring 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. .. note:: This is a low-level API call. Users are recommended to use the high-level pushMessage() API call instead. %End static QgsMessageBarItem *createMessage( QWidget *widget, QWidget *parent = 0 ) /Factory/; %Docstring Creates message bar item widget containing a custom ``widget`` to be displayed on the bar. The caller takes ownership of the returned item. .. note:: This is a low-level API call. Users are recommended to use the high-level pushWidget() API call instead. %End void pushMessage( const QString &text, Qgis::MessageLevel level = Qgis::Info, int duration = 5 ); %Docstring 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. %End void pushMessage( const QString &title, const QString &text, Qgis::MessageLevel level = Qgis::Info, int duration = 5 ); %Docstring 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. %End void pushMessage( const QString &title, const QString &text, const QString &showMore, Qgis::MessageLevel level = Qgis::Info, int duration = 5 ); %Docstring 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. %End QgsMessageBarItem *currentItem(); %Docstring Returns the current visible item, or ``None`` if no item is shown. %End QList items(); %Docstring Returns a list of all items currently visible or queued for the bar. .. versionadded:: 3.14 %End signals: void widgetAdded( QgsMessageBarItem *item ); %Docstring Emitted whenever an ``item`` is added to the bar. %End void widgetRemoved( QgsMessageBarItem *item ); %Docstring Emitted whenever an ``item`` was removed from the bar. %End public slots: bool popWidget(); %Docstring 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. :return: ``True`` if the widget was removed, ``False`` otherwise %End bool clearWidgets(); %Docstring Removes all items from the bar. :return: ``True`` if all items were removed, ``False`` otherwise %End void pushSuccess( const QString &title, const QString &message ); %Docstring Pushes a success ``message`` with default timeout to the message bar. :param title: title string for message :param message: The message to be displayed .. versionadded:: 2.8 %End void pushInfo( const QString &title, const QString &message ); %Docstring Pushes a information ``message`` with default timeout to the message bar. :param title: title string for message :param message: The message to be displayed .. versionadded:: 2.8 %End void pushWarning( const QString &title, const QString &message ); %Docstring Pushes a warning ``message`` with default timeout to the message bar. :param title: title string for message :param message: The message to be displayed .. versionadded:: 2.8 %End void pushCritical( const QString &title, const QString &message ); %Docstring Pushes a critical warning ``message`` with default timeout to the message bar. :param title: title string for message :param message: The message to be displayed .. versionadded:: 2.8 %End protected: virtual void mousePressEvent( QMouseEvent *e ); }; /************************************************************************ * This file has been generated automatically from * * * * src/gui/qgsmessagebar.h * * * * Do not edit manually ! Edit header and run scripts/sipify.pl again * ************************************************************************/