src/gui/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 GUI_EXPORT QgsMessageBar: public QFrame
{
    Q_OBJECT

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

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

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

    bool popWidget( QWidget *widget );

    static QWidget* createMessage( const QString &text, QWidget *parent = 0 ) { return createMessage( QString::null, text, QIcon(), parent ); }
    static QWidget* createMessage( const QString &text, const QIcon &icon, QWidget *parent = 0 ) { return createMessage( QString::null, text, icon, parent ); }
    static QWidget* createMessage( const QString &title, const QString &text, QWidget *parent = 0 ) { return createMessage( title, text, QIcon(), parent ); }
    static QWidget* createMessage( const QString &title, const QString &text, const QIcon &icon, QWidget *parent = 0 );

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

  signals:
    void widgetAdded( QWidget *widget );

    void widgetRemoved( QWidget *widget );

  public slots:
    bool popWidget();

    bool clearWidgets();

  protected:
    void mousePressEvent( QMouseEvent * e );

  private:
    class QgsMessageBarItem
    {
      public:
        QgsMessageBarItem( QWidget *widget, const QString &styleSheet, int duration = 0 ):
            mWidget( widget ), mStyleSheet( styleSheet ), mDuration( duration ) {}
        ~QgsMessageBarItem() {}

        QWidget* widget() const { return mWidget; }
        QString styleSheet() const { return mStyleSheet; }
        int duration() const { return mDuration; }

      private:
        QWidget *mWidget;
        QString mStyleSheet;
        int mDuration; // 0 value indicates no timeout duration
    };

    void pushWidget( QWidget *widget, const QString &styleSheet, int duration = 0 );

    void popItem( QgsMessageBarItem *item );
    void pushItem( QgsMessageBarItem *item );

    QgsMessageBarItem *mCurrentItem;
    QList<QgsMessageBarItem *> mList;
    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