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 "qgis.h"
#include "qgis_gui.h"
#include "qgsguiutils.h"
 
#include <QColor>
#include <QFrame>
#include <QIcon>
#include <QList>
#include <QString>
 
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:
    QgsMessageBar( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void pushItem( QgsMessageBarItem *item SIP_TRANSFER );

    QgsMessageBarItem *pushWidget( QWidget *widget SIP_TRANSFER, Qgis::MessageLevel level = Qgis::MessageLevel::Info, int duration = 0 );

    bool popWidget( QgsMessageBarItem *item );

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

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

    static QgsMessageBarItem *createMessage( QWidget *widget, QWidget *parent = nullptr ) SIP_FACTORY;

    void pushMessage( const QString &text, Qgis::MessageLevel level = Qgis::MessageLevel::Info, int duration = -1 );

    void pushMessage( const QString &title, const QString &text, Qgis::MessageLevel level = Qgis::MessageLevel::Info, int duration = -1 );

    void pushMessage( const QString &title, const QString &text, const QString &showMore, Qgis::MessageLevel level = Qgis::MessageLevel::Info, int duration = -1 );

    QgsMessageBarItem *currentItem();

    QList<QgsMessageBarItem *> items();

    static int defaultMessageTimeout( Qgis::MessageLevel level = Qgis::MessageLevel::NoLevel );
 
  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 = nullptr;
    QList<QgsMessageBarItem *> mItems;
    QMenu *mCloseMenu = nullptr;
    QToolButton *mCloseBtn = nullptr;
    QGridLayout *mLayout = nullptr;
    QLabel *mItemCount = nullptr;
    QAction *mActionCloseAll = nullptr;
    QTimer *mCountdownTimer = nullptr;
    QProgressBar *mCountProgress = nullptr;
    QString mCountStyleSheet;
    Qgis::MessageLevel mPrevLevel = Qgis::MessageLevel::NoLevel;
 
    static constexpr int MAX_ITEMS = 100;
 
    void removeLowestPriorityOldestItem();
 
  private slots:
    void updateItemCount();

    void updateCountdown();
    void resetCountdown();
 
    friend class TestQgsMessageBar;
};
 
#endif