qgsmessagebar.h

Go to the documentation of this file.

/***************************************************************************
                          qgsmessagebar.h  -  description
                             -------------------
    begin                : June 2012
    copyright            : (C) 2012 by Giuseppe Sucameli
    email                : sucameli at faunalia dot it
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSMESSAGEBAR_H
#define QGSMESSAGEBAR_H

#include <qgisgui.h>

#include <QString>
#include <QFrame>
#include <QIcon>
#include <QColor>
#include <QList>

class QWidget;
class QGridLayout;
class QMenu;
class QProgressBar;
class QToolButton;
class QLabel;
class QAction;
class QTimer;

class QgsMessageBarItem;

class GUI_EXPORT QgsMessageBar: public QFrame
{
    Q_OBJECT

  public:
    enum MessageLevel
    {
      INFO = 0,
      WARNING = 1,
      CRITICAL = 2,
      SUCCESS = 3
    };

    QgsMessageBar( QWidget *parent = nullptr );
    ~QgsMessageBar();

    void pushItem( QgsMessageBarItem *item );

    QgsMessageBarItem *pushWidget( QWidget *widget, MessageLevel level = INFO, int duration = 0 );

    bool popWidget( QgsMessageBarItem *item );

    static QgsMessageBarItem* createMessage( const QString &text, QWidget *parent = nullptr );
    static QgsMessageBarItem* createMessage( const QString &title, const QString &text, QWidget *parent = nullptr );
    static QgsMessageBarItem* createMessage( QWidget *widget, QWidget *parent = nullptr );

    void pushMessage( const QString &text, MessageLevel level = INFO, int duration = 5 ) { return pushMessage( QString::null, text, level, duration ); }
    void pushMessage( const QString &title, const QString &text, MessageLevel level = INFO, int duration = 5 );

    QgsMessageBarItem *currentItem() { return mCurrentItem; }

  signals:
    void widgetAdded( QgsMessageBarItem *item );

    void widgetRemoved( QgsMessageBarItem *item );

  public slots:
    bool popWidget();

    bool clearWidgets();

    void pushSuccess( const QString& title, const QString& message );

    void pushInfo( const QString& title, const QString& message );

    void pushWarning( const QString& title, const QString& message );

    void pushCritical( const QString& title, const QString& message );

  protected:
    void mousePressEvent( QMouseEvent * e ) override;

  private:
    void popItem( QgsMessageBarItem *item );
    void showItem( QgsMessageBarItem *item );
    QgsMessageBarItem *mCurrentItem;
    QList<QgsMessageBarItem *> mItems;
    QMenu *mCloseMenu;
    QToolButton *mCloseBtn;
    QGridLayout *mLayout;
    QLabel *mItemCount;
    QAction *mActionCloseAll;
    QTimer *mCountdownTimer;
    QProgressBar *mCountProgress;
    QString mCountStyleSheet;

  private slots:
    void updateItemCount();

    void updateCountdown();
    void resetCountdown();
};

#endif