qgsmessagebar.cpp

Go to the documentation of this file.

/***************************************************************************
                          qgsmessagebar.cpp  -  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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsmessagebar.h"
 
#include "qgsapplication.h"
#include "qgsmessagebaritem.h"
#include "qgsmessagelog.h"
#include "qgsmessageviewer.h"
#include "qgssettings.h"
 
#include <QGridLayout>
#include <QLabel>
#include <QMenu>
#include <QMouseEvent>
#include <QPalette>
#include <QProgressBar>
#include <QStackedWidget>
#include <QString>
#include <QTimer>
#include <QToolButton>
#include <QWidget>
 
#include "moc_qgsmessagebar.cpp"
 
using namespace Qt::StringLiterals;
 
QgsMessageBar::QgsMessageBar( QWidget *parent )
  : QFrame( parent )
 
{
  QPalette pal = palette();
  pal.setBrush( backgroundRole(), pal.window() );
  setPalette( pal );
  setAutoFillBackground( true );
  setFrameShape( QFrame::StyledPanel );
  setFrameShadow( QFrame::Plain );
 
  mLayout = new QGridLayout( this );
  const int xMargin = std::max( 9.0, Qgis::UI_SCALE_FACTOR * fontMetrics().height() * 0.45 );
  const int yMargin = std::max( 1.0, Qgis::UI_SCALE_FACTOR * fontMetrics().height() * 0.05 );
  mLayout->setContentsMargins( xMargin, yMargin, xMargin, yMargin );
  setLayout( mLayout );
 
  mCountProgress = new QProgressBar( this );
  mCountStyleSheet = QString( "QProgressBar { border: 1px solid rgba(0, 0, 0, 75%);"
                              " border-radius: 2px; background: rgba(0, 0, 0, 0);"
                              " image: url(:/images/themes/default/%1) }"
                              "QProgressBar::chunk { background-color: rgba(0, 0, 0, 30%); width: 5px; }" );
 
  mCountProgress->setStyleSheet( mCountStyleSheet.arg( "mIconTimerPause.svg"_L1 ) );
  mCountProgress->setObjectName( u"mCountdown"_s );
  const int barWidth = std::max( 25.0, Qgis::UI_SCALE_FACTOR * fontMetrics().height() * 1.25 );
  const int barHeight = std::max( 14.0, Qgis::UI_SCALE_FACTOR * fontMetrics().height() * 0.7 );
  mCountProgress->setFixedSize( barWidth, barHeight );
  mCountProgress->setSizePolicy( QSizePolicy::Fixed, QSizePolicy::Fixed );
  mCountProgress->setTextVisible( false );
  mCountProgress->setRange( 0, 5 );
  mCountProgress->setHidden( true );
  mLayout->addWidget( mCountProgress, 0, 0, 1, 1 );
 
  mItemCount = new QLabel( this );
  mItemCount->setObjectName( u"mItemCount"_s );
  mItemCount->setToolTip( tr( "Remaining messages" ) );
  mItemCount->setSizePolicy( QSizePolicy::Maximum, QSizePolicy::Preferred );
  mLayout->addWidget( mItemCount, 0, 2, 1, 1 );
 
  mCloseMenu = new QMenu( this );
  mCloseMenu->setObjectName( u"mCloseMenu"_s );
  mActionCloseAll = new QAction( tr( "Close All" ), this );
  mCloseMenu->addAction( mActionCloseAll );
  connect( mActionCloseAll, &QAction::triggered, this, &QgsMessageBar::clearWidgets );
 
  mCloseBtn = new QToolButton( this );
  mCloseMenu->setObjectName( u"mCloseMenu"_s );
  mCloseBtn->setToolTip( tr( "Close" ) );
  mCloseBtn->setMinimumWidth( QgsGuiUtils::scaleIconSize( 44 ) );
  mCloseBtn->setStyleSheet(
    "QToolButton { border:none; background-color: rgba(0, 0, 0, 0); }"
    "QToolButton::menu-button { border:none; background-color: rgba(0, 0, 0, 0); }"
  );
  mCloseBtn->setCursor( Qt::PointingHandCursor );
  mCloseBtn->setIcon( QgsApplication::getThemeIcon( u"/mIconClose.svg"_s ) );
 
  const int iconSize = std::max( 18.0, Qgis::UI_SCALE_FACTOR * fontMetrics().height() * 0.9 );
  mCloseBtn->setIconSize( QSize( iconSize, iconSize ) );
  mCloseBtn->setSizePolicy( QSizePolicy::Maximum, QSizePolicy::Maximum );
  mCloseBtn->setMenu( mCloseMenu );
  mCloseBtn->setPopupMode( QToolButton::MenuButtonPopup );
  connect( mCloseBtn, &QAbstractButton::clicked, this, static_cast<bool ( QgsMessageBar::* )()>( &QgsMessageBar::popWidget ) );
  mLayout->addWidget( mCloseBtn, 0, 3, 1, 1 );
 
  mCountdownTimer = new QTimer( this );
  mCountdownTimer->setInterval( 1000 );
  connect( mCountdownTimer, &QTimer::timeout, this, &QgsMessageBar::updateCountdown );
 
  connect( this, &QgsMessageBar::widgetAdded, this, &QgsMessageBar::updateItemCount );
  connect( this, &QgsMessageBar::widgetRemoved, this, &QgsMessageBar::updateItemCount );
 
  // start hidden
  setVisible( false );
}
 
void QgsMessageBar::mousePressEvent( QMouseEvent *e )
{
  if ( mCountProgress == childAt( e->pos() ) && e->button() == Qt::LeftButton )
  {
    if ( mCountdownTimer->isActive() )
    {
      mCountdownTimer->stop();
      mCountProgress->setStyleSheet( mCountStyleSheet.arg( "mIconTimerContinue.svg"_L1 ) );
    }
    else
    {
      mCountdownTimer->start();
      mCountProgress->setStyleSheet( mCountStyleSheet.arg( "mIconTimerPause.svg"_L1 ) );
    }
  }
}
 
void QgsMessageBar::popItem( QgsMessageBarItem *item )
{
  Q_ASSERT( item );
 
  if ( !mItems.contains( item ) )
    return;
 
  if ( item == mItems.at( 0 ) )
  {
    mItems.removeOne( item );
    mLayout->removeWidget( item );
    item->hide();
    disconnect( item, &QgsMessageBarItem::styleChanged, this, &QWidget::setStyleSheet );
    item->deleteLater();
 
    if ( !mItems.isEmpty() )
    {
      showItem( mItems.at( 0 ) );
    }
    else
    {
      hide();
    }
  }
  else
  {
    mItems.removeOne( item );
    item->deleteLater();
  }
 
  emit widgetRemoved( item );
}
 
bool QgsMessageBar::popWidget( QgsMessageBarItem *item )
{
  if ( !item || !mItems.contains( item ) )
    return false;
 
  popItem( item );
  return true;
}
 
bool QgsMessageBar::popWidget()
{
  if ( mItems.empty() )
    return false;
 
  resetCountdown();
 
  popItem( mItems.at( 0 ) );
 
  return true;
}
 
bool QgsMessageBar::clearWidgets()
{
  if ( mItems.empty() )
    return true;
 
  while ( !mItems.isEmpty() )
  {
    popWidget();
  }
 
  return true;
}
 
void QgsMessageBar::pushSuccess( const QString &title, const QString &message )
{
  pushMessage( title, message, Qgis::MessageLevel::Success );
}
 
void QgsMessageBar::pushInfo( const QString &title, const QString &message )
{
  pushMessage( title, message, Qgis::MessageLevel::Info );
}
 
void QgsMessageBar::pushWarning( const QString &title, const QString &message )
{
  pushMessage( title, message, Qgis::MessageLevel::Warning );
}
 
void QgsMessageBar::pushCritical( const QString &title, const QString &message )
{
  pushMessage( title, message, Qgis::MessageLevel::Critical );
}
 
int QgsMessageBar::defaultMessageTimeout( Qgis::MessageLevel level )
{
  // critical/warning messages don't auto dismiss by default
  switch ( level )
  {
    case Qgis::MessageLevel::Success:
    case Qgis::MessageLevel::Info:
    case Qgis::MessageLevel::NoLevel:
    {
      const QgsSettings settings;
      return settings.value( u"qgis/messageTimeout"_s, 5 ).toInt();
    }
 
    case Qgis::MessageLevel::Warning:
    case Qgis::MessageLevel::Critical:
      return 0;
  }
  return 0;
}
 
void QgsMessageBar::showItem( QgsMessageBarItem *item )
{
  Q_ASSERT( item );
 
  if ( !mItems.empty() )
    disconnect( mItems.at( 0 ), &QgsMessageBarItem::styleChanged, this, &QWidget::setStyleSheet );
 
  if ( mItems.count() >= MAX_ITEMS )
    removeLowestPriorityOldestItem();
 
  if ( !mItems.empty() )
  {
    mLayout->removeWidget( mItems.at( 0 ) );
    mItems.at( 0 )->hide();
  }
 
  if ( mItems.contains( item ) )
    mItems.removeOne( item );
  mItems.prepend( item );
 
  mLayout->addWidget( item, 0, 1, 1, 1 );
  item->show();
 
  if ( item->duration() > 0 )
  {
    mCountProgress->setRange( 0, item->duration() );
    mCountProgress->setValue( item->duration() );
    mCountProgress->setVisible( true );
    mCountdownTimer->start();
  }
 
  connect( item, &QgsMessageBarItem::styleChanged, this, &QWidget::setStyleSheet );
 
  if ( item->level() != mPrevLevel )
  {
    setStyleSheet( item->getStyleSheet() );
    mPrevLevel = item->level();
  }
 
  show();
 
  emit widgetAdded( item );
}
 
void QgsMessageBar::removeLowestPriorityOldestItem()
{
  for ( const Qgis::MessageLevel level : { Qgis::MessageLevel::Success, Qgis::MessageLevel::Info, Qgis::MessageLevel::Warning, Qgis::MessageLevel::Critical } )
  {
    for ( int i = mItems.size() - 1; i >= 0; --i )
    {
      QgsMessageBarItem *item = mItems.at( i );
      if ( item->level() == level )
      {
        popItem( item );
        return;
      }
    }
  }
}
 
void QgsMessageBar::pushItem( QgsMessageBarItem *item )
{
  resetCountdown();
 
  item->mMessageBar = this;
 
  // avoid duplicated widget
  popWidget( item );
  showItem( item );
 
  // Log all (non-empty) messages that are sent to the message bar into the message log so the
  // user can get them back easier.
  QString formattedTitle;
  if ( !item->title().isEmpty() && !item->text().isEmpty() )
    formattedTitle = u"%1 : %2"_s.arg( item->title(), item->text() );
  else if ( !item->title().isEmpty() )
    formattedTitle = item->title();
  else if ( !item->text().isEmpty() )
    formattedTitle = item->text();
 
  if ( !formattedTitle.isEmpty() )
    QgsMessageLog::logMessage( formattedTitle, tr( "Messages" ), item->level() );
}
 
QgsMessageBarItem *QgsMessageBar::pushWidget( QWidget *widget, Qgis::MessageLevel level, int duration )
{
  QgsMessageBarItem *item = nullptr;
  item = dynamic_cast<QgsMessageBarItem *>( widget );
  if ( item )
  {
    item->setLevel( level )->setDuration( duration );
  }
  else
  {
    item = new QgsMessageBarItem( widget, level, duration );
  }
  pushItem( item );
  return item;
}
 
void QgsMessageBar::pushMessage( const QString &title, const QString &text, Qgis::MessageLevel level, int duration )
{
  // block duplicate items, avoids flooding (and freezing) of the main window
  for ( auto it = mItems.constBegin(); it != mItems.constEnd(); ++it )
  {
    if ( level == ( *it )->level() && title == ( *it )->title() && text == ( *it )->text() )
      return;
  }
 
  QgsMessageBarItem *item = new QgsMessageBarItem( title, text, level, duration );
  pushItem( item );
}
 
void QgsMessageBar::pushMessage( const QString &title, const QString &text, const QString &showMore, Qgis::MessageLevel level, int duration )
{
  QgsMessageViewer *mv = new QgsMessageViewer();
  mv->setWindowTitle( title );
  mv->setMessageAsPlainText( text + "\n\n" + showMore );
 
  QToolButton *showMoreButton = new QToolButton();
  QAction *act = new QAction( showMoreButton );
  act->setText( tr( "Show more" ) );
  showMoreButton->setStyleSheet( u"background-color: rgba(255, 255, 255, 0); color: black; text-decoration: underline;"_s );
  showMoreButton->setCursor( Qt::PointingHandCursor );
  showMoreButton->setSizePolicy( QSizePolicy::Maximum, QSizePolicy::Preferred );
  showMoreButton->addAction( act );
  showMoreButton->setDefaultAction( act );
  connect( showMoreButton, &QToolButton::triggered, mv, &QDialog::exec );
  connect( showMoreButton, &QToolButton::triggered, showMoreButton, &QObject::deleteLater );
 
  if ( duration < 0 )
  {
    duration = defaultMessageTimeout( level );
  }
 
  QgsMessageBarItem *item = new QgsMessageBarItem(
    title,
    text,
    showMoreButton,
    level,
    duration
  );
  pushItem( item );
}
 
QgsMessageBarItem *QgsMessageBar::currentItem()
{
  return mItems.value( 0 );
}
 
QList<QgsMessageBarItem *> QgsMessageBar::items()
{
  return mItems;
}
 
QgsMessageBarItem *QgsMessageBar::createMessage( const QString &text, QWidget *parent )
{
  QgsMessageBarItem *item = new QgsMessageBarItem( text, Qgis::MessageLevel::Info, 0, parent );
  return item;
}
 
QgsMessageBarItem *QgsMessageBar::createMessage( const QString &title, const QString &text, QWidget *parent )
{
  return new QgsMessageBarItem( title, text, Qgis::MessageLevel::Info, 0, parent );
}
 
QgsMessageBarItem *QgsMessageBar::createMessage( QWidget *widget, QWidget *parent )
{
  return new QgsMessageBarItem( widget, Qgis::MessageLevel::Info, 0, parent );
}
 
void QgsMessageBar::pushMessage( const QString &text, Qgis::MessageLevel level, int duration )
{
  pushMessage( QString(), text, level, duration );
}
 
void QgsMessageBar::updateCountdown()
{
  if ( !mCountdownTimer->isActive() )
  {
    resetCountdown();
    return;
  }
  if ( mCountProgress->value() < 2 )
  {
    popWidget();
  }
  else
  {
    mCountProgress->setValue( mCountProgress->value() - 1 );
  }
}
 
void QgsMessageBar::resetCountdown()
{
  if ( mCountdownTimer->isActive() )
    mCountdownTimer->stop();
 
  mCountProgress->setStyleSheet( mCountStyleSheet.arg( "mIconTimerPause.svg"_L1 ) );
  mCountProgress->setVisible( false );
}
 
void QgsMessageBar::updateItemCount()
{
  const bool moreMessages = mItems.count() > 1;
  mItemCount->setText( moreMessages ? tr( "%n more", "unread messages", mItems.count() - 1 ) : QString() );
 
  // do not show the down arrow for opening menu with "close all" if there is just one message
  mCloseBtn->setMenu( moreMessages ? mCloseMenu : nullptr );
  mCloseBtn->setPopupMode( moreMessages ? QToolButton::MenuButtonPopup : QToolButton::DelayedPopup );
}