src/statusbarmessagelabel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz                                      *
   3  *   peter.penz@gmx.at                                                     *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  19  ***************************************************************************/
  20
  21 #include "statusbarmessagelabel.h"
  22
  23 #include <kglobalsettings.h>
  24 #include <kgraphicsutils.h>
  25 #include <kiconloader.h>
  26 #include <kicon.h>
  27 #include <klocale.h>
  28
  29 #include <QtGui/QFontMetrics>
  30 #include <QtGui/QPainter>
  31 #include <QtGui/QKeyEvent>
  32 #include <QtGui/QPushButton>
  33 #include <QtGui/QPixmap>
  34 #include <QtCore/QTimer>
  35
  36 StatusBarMessageLabel::StatusBarMessageLabel(QWidget* parent) :
  37     QWidget(parent),
  38     m_type(DolphinStatusBar::Default),
  39     m_state(Default),
  40     m_illumination(0),
  41     m_minTextHeight(-1),
  42     m_timer(0),
  43     m_closeButton(0)
  44 {
  45     setMinimumHeight(K3Icon::SizeSmall);
  46
  47     m_timer = new QTimer(this);
  48     connect(m_timer, SIGNAL(timeout()),
  49             this, SLOT(timerDone()));
  50
  51     m_closeButton = new QPushButton(i18n("Close"), this);
  52     m_closeButton->hide();
  53     connect(m_closeButton, SIGNAL(clicked()),
  54             this, SLOT(closeErrorMessage()));
  55 }
  56
  57 StatusBarMessageLabel::~StatusBarMessageLabel()
  58 {}
  59
  60 void StatusBarMessageLabel::setMessage(const QString& text,
  61                                        DolphinStatusBar::Type type)
  62 {
  63     if ((text == m_text) && (type == m_type)) {
  64         return;
  65     }
  66
  67     if (m_type == DolphinStatusBar::Error) {
  68         if (type == DolphinStatusBar::Error) {
  69             m_pendingMessages.insert(0, m_text);
  70         } else if ((m_state != Default) || !m_pendingMessages.isEmpty()) {
  71             // a non-error message should not be shown, as there
  72             // are other pending error messages in the queue
  73             return;
  74         }
  75     }
  76
  77     m_text = text;
  78     m_type = type;
  79
  80     m_timer->stop();
  81     m_illumination = 0;
  82     m_state = Default;
  83
  84     const char* iconName = 0;
  85     QPixmap pixmap;
  86     switch (type) {
  87     case DolphinStatusBar::OperationCompleted:
  88         iconName = "ok";
  89         m_closeButton->hide();
  90         break;
  91
  92     case DolphinStatusBar::Information:
  93         iconName = "dialog-information";
  94         m_closeButton->hide();
  95         break;
  96
  97     case DolphinStatusBar::Error:
  98         iconName = "dialog-error";
  99         m_timer->start(100);
 100         m_state = Illuminate;
 101
 102         updateCloseButtonPosition();
 103         m_closeButton->show();
 104         break;
 105
 106     case DolphinStatusBar::Default:
 107     default:
 108         m_closeButton->hide();
 109         break;
 110     }
 111
 112     m_pixmap = (iconName == 0) ? QPixmap() : SmallIcon(iconName);
 113     QTimer::singleShot(GeometryTimeout, this, SLOT(assureVisibleText()));
 114     update();
 115 }
 116
 117 void StatusBarMessageLabel::setMinimumTextHeight(int min)
 118 {
 119     if (min != m_minTextHeight) {
 120         m_minTextHeight = min;
 121         setMinimumHeight(min);
 122         m_closeButton->setFixedHeight(min - borderGap() * 2);
 123     }
 124 }
 125
 126 int StatusBarMessageLabel::widthGap() const
 127 {
 128     QFontMetrics fontMetrics(font());
 129     const int defaultGap = 10;
 130     return fontMetrics.width(m_text) - availableTextWidth() + defaultGap;
 131 }
 132
 133 void StatusBarMessageLabel::paintEvent(QPaintEvent* /* event */)
 134 {
 135     QPainter painter(this);
 136
 137     // draw background
 138     QColor backgroundColor(palette().brush(QPalette::Background).color());
 139     QColor foregroundColor(KGlobalSettings::textColor());
 140     if (m_illumination > 0) {
 141         QColor mixColor(255, 255, 128, m_illumination);
 142         backgroundColor = KGraphicsUtils::blendColor(backgroundColor, mixColor);
 143
 144         mixColor.setRgb(0, 0, 0, m_illumination);
 145         foregroundColor = KGraphicsUtils::blendColor(foregroundColor, mixColor);
 146     }
 147     painter.setBrush(backgroundColor);
 148     painter.setPen(backgroundColor);
 149     painter.drawRect(QRect(0, 0, width(), height()));
 150
 151     // draw pixmap
 152     int x = borderGap();
 153     int y = (m_minTextHeight - m_pixmap.height()) / 2;
 154
 155     if (!m_pixmap.isNull()) {
 156         painter.drawPixmap(x, y, m_pixmap);
 157         x += m_pixmap.width() + borderGap();
 158     }
 159
 160     // draw text
 161     painter.setPen(foregroundColor);
 162     int flags = Qt::AlignVCenter;
 163     if (height() > m_minTextHeight) {
 164         flags = flags | Qt::TextWordWrap;
 165     }
 166     painter.drawText(QRect(x, 0, availableTextWidth(), height()), flags, m_text);
 167     painter.end();
 168 }
 169
 170 void StatusBarMessageLabel::resizeEvent(QResizeEvent* event)
 171 {
 172     QWidget::resizeEvent(event);
 173     updateCloseButtonPosition();
 174     QTimer::singleShot(GeometryTimeout, this, SLOT(assureVisibleText()));
 175 }
 176
 177 void StatusBarMessageLabel::timerDone()
 178 {
 179     switch (m_state) {
 180     case Illuminate: {
 181         // increase the illumination
 182         if (m_illumination < 255) {
 183             m_illumination += 32;
 184             if (m_illumination > 255) {
 185                 m_illumination = 255;
 186             }
 187             update();
 188         } else {
 189             m_state = Illuminated;
 190             m_timer->start(5000);
 191         }
 192         break;
 193     }
 194
 195     case Illuminated: {
 196         // start desaturation
 197         m_state = Desaturate;
 198         m_timer->start(100);
 199         break;
 200     }
 201
 202     case Desaturate: {
 203         // desaturate
 204         if (m_illumination > 0) {
 205             m_illumination -= 5;
 206             update();
 207         } else {
 208             m_state = Default;
 209             m_timer->stop();
 210         }
 211         break;
 212     }
 213
 214     default:
 215         break;
 216     }
 217 }
 218
 219 void StatusBarMessageLabel::assureVisibleText()
 220 {
 221     if (m_text.isEmpty()) {
 222         return;
 223     }
 224
 225     // calculate the required height of the widget thats
 226     // needed for having a fully visible text
 227     QFontMetrics fontMetrics(font());
 228     const QRect bounds(fontMetrics.boundingRect(0, 0, availableTextWidth(), height(),
 229                        Qt::AlignVCenter | Qt::TextWordWrap,
 230                        m_text));
 231     int requiredHeight = bounds.height();
 232     if (requiredHeight < m_minTextHeight) {
 233         requiredHeight = m_minTextHeight;
 234     }
 235
 236     // Increase/decrease the current height of the widget to the
 237     // required height. The increasing/decreasing is done in several
 238     // steps to have an animation if the height is modified
 239     // (see StatusBarMessageLabel::resizeEvent())
 240     const int gap = m_minTextHeight / 2;
 241     int minHeight = minimumHeight();
 242     if (minHeight < requiredHeight) {
 243         minHeight += gap;
 244         if (minHeight > requiredHeight) {
 245             minHeight = requiredHeight;
 246         }
 247         setMinimumHeight(minHeight);
 248         updateGeometry();
 249     } else if (minHeight > requiredHeight) {
 250         minHeight -= gap;
 251         if (minHeight < requiredHeight) {
 252             minHeight = requiredHeight;
 253         }
 254         setMinimumHeight(minHeight);
 255         updateGeometry();
 256     }
 257
 258     updateCloseButtonPosition();
 259 }
 260
 261 int StatusBarMessageLabel::availableTextWidth() const
 262 {
 263     const int buttonWidth = (m_type == DolphinStatusBar::Error) ?
 264                             m_closeButton->width() + borderGap() : 0;
 265     return width() - m_pixmap.width() - (borderGap() * 4) - buttonWidth;
 266 }
 267
 268 void StatusBarMessageLabel::updateCloseButtonPosition()
 269 {
 270     const int x = width() - m_closeButton->width() - borderGap();
 271     const int y = height() - m_closeButton->height() - borderGap();
 272     m_closeButton->move(x, y);
 273 }
 274
 275 void StatusBarMessageLabel::closeErrorMessage()
 276 {
 277     if (!showPendingMessage()) {
 278         reset();
 279         setMessage(m_defaultText, DolphinStatusBar::Default);
 280     }
 281 }
 282
 283 bool StatusBarMessageLabel::showPendingMessage()
 284 {
 285     if (!m_pendingMessages.isEmpty()) {
 286         reset();
 287         setMessage(m_pendingMessages.takeFirst(), DolphinStatusBar::Error);
 288         return true;
 289     }
 290     return false;
 291 }
 292
 293 void StatusBarMessageLabel::reset()
 294 {
 295     m_text.clear();
 296     m_type = DolphinStatusBar::Default;
 297 }
 298
 299 #include "statusbarmessagelabel.moc"