src/statusbar/dolphinstatusbar.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 "dolphinstatusbar.h"
  22 #include "settings/dolphinsettings.h"
  23 #include "dolphinview.h"
  24 #include "dolphin_generalsettings.h"
  25 #include "statusbarmessagelabel.h"
  26 #include "statusbarspaceinfo.h"
  27 #include "zoomlevelinfo.h"
  28
  29 #include <QApplication>
  30 #include <QHBoxLayout>
  31 #include <QLabel>
  32 #include <QProgressBar>
  33 #include <QToolButton>
  34 #include <QTimer>
  35
  36 #include <kiconloader.h>
  37 #include <kicon.h>
  38 #include <klocale.h>
  39 #include <kvbox.h>
  40
  41 DolphinStatusBar::DolphinStatusBar(QWidget* parent, DolphinView* view) :
  42     KHBox(parent),
  43     m_view(view),
  44     m_messageLabel(0),
  45     m_spaceInfo(0),
  46     m_zoomWidget(0),
  47     m_zoomOut(0),
  48     m_zoomSlider(0),
  49     m_zoomIn(0),
  50     m_progressBar(0),
  51     m_progress(100),
  52     m_messageTimeStamp()
  53 {
  54     setMargin(0);
  55     setSpacing(4);
  56
  57     connect(m_view, SIGNAL(urlChanged(const KUrl&)),
  58             this, SLOT(updateSpaceInfoContent(const KUrl&)));
  59
  60     // initialize message label
  61     m_messageLabel = new StatusBarMessageLabel(this);
  62     m_messageLabel->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
  63
  64     // initialize zoom slider
  65     m_zoomWidget = new QWidget(this);
  66
  67     m_zoomOut = new QToolButton(m_zoomWidget);
  68     m_zoomOut->setIcon(KIcon("zoom-out"));
  69     m_zoomOut->setAutoRaise(true);
  70
  71     m_zoomSlider = new QSlider(Qt::Horizontal, m_zoomWidget);
  72     m_zoomSlider->setPageStep(1);
  73
  74     const int min = ZoomLevelInfo::minimumLevel();
  75     const int max = ZoomLevelInfo::maximumLevel();
  76     m_zoomSlider->setRange(min, max);
  77     m_zoomSlider->setValue(view->zoomLevel());
  78     updateZoomSliderToolTip(view->zoomLevel());
  79
  80     m_zoomIn = new QToolButton(m_zoomWidget);
  81     m_zoomIn->setIcon(KIcon("zoom-in"));
  82     m_zoomIn->setAutoRaise(true);
  83
  84     QHBoxLayout* zoomWidgetLayout = new QHBoxLayout(m_zoomWidget);
  85     zoomWidgetLayout->setSpacing(0);
  86     zoomWidgetLayout->setMargin(0);
  87     zoomWidgetLayout->addWidget(m_zoomOut);
  88     zoomWidgetLayout->addWidget(m_zoomSlider);
  89     zoomWidgetLayout->addWidget(m_zoomIn);
  90
  91     connect(m_zoomSlider, SIGNAL(valueChanged(int)), this, SLOT(setZoomLevel(int)));
  92     connect(m_zoomSlider, SIGNAL(sliderMoved(int)), this, SLOT(showZoomSliderToolTip(int)));
  93     connect(m_view, SIGNAL(zoomLevelChanged(int)), m_zoomSlider, SLOT(setValue(int)));
  94     connect(m_zoomOut, SIGNAL(clicked()), this, SLOT(zoomOut()));
  95     connect(m_zoomIn, SIGNAL(clicked()), this, SLOT(zoomIn()));
  96
  97     // initialize space information
  98     m_spaceInfo = new StatusBarSpaceInfo(this);
  99     m_spaceInfo->setUrl(m_view->url());
 100
 101     // initialize progress information
 102     m_progressText = new QLabel(this);
 103     m_progressText->hide();
 104
 105     m_progressBar = new QProgressBar(this);
 106     m_progressBar->hide();
 107
 108     // initialize sizes
 109     const int fontHeight = QFontMetrics(m_messageLabel->font()).height();
 110     const int zoomWidgetHeight = m_zoomWidget->minimumSizeHint().height();
 111     const int contentHeight = qMax(fontHeight, zoomWidgetHeight);
 112
 113     m_messageLabel->setMinimumTextHeight(contentHeight);
 114     m_spaceInfo->setFixedHeight(contentHeight - 5);
 115     m_progressBar->setFixedSize(200, contentHeight);
 116     m_zoomWidget->setFixedSize(150, contentHeight);
 117
 118     setExtensionsVisible(true);
 119 }
 120
 121 DolphinStatusBar::~DolphinStatusBar()
 122 {
 123 }
 124
 125 void DolphinStatusBar::setMessage(const QString& msg,
 126                                   Type type)
 127 {
 128     int timeout = 1000; // Timeout in milliseconds until default
 129                         // messages may overwrite other messages.
 130
 131     QString message = msg;
 132     if (message.isEmpty()) {
 133         // Show the default text as fallback. An empty text indicates
 134         // a clearing of the information message.
 135         if (m_messageLabel->defaultText().isEmpty()) {
 136             return;
 137         }
 138         message = m_messageLabel->defaultText();
 139         type = Default;
 140         timeout = 0;
 141     }
 142
 143     if ((message == m_messageLabel->text()) && (type == m_messageLabel->type())) {
 144         // the message is already shown
 145         return;
 146     }
 147
 148     const QTime currentTime = QTime::currentTime();
 149     const bool skipMessage = (type == Default) &&
 150                              m_messageTimeStamp.isValid() &&
 151                              (m_messageTimeStamp.msecsTo(currentTime) < timeout);
 152     if (skipMessage) {
 153         // A non-default message is shown just for a very short time. Don't hide
 154         // the message by a default message, so that the user gets the chance to
 155         // read the information.
 156         return;
 157     }
 158
 159     m_messageLabel->setMessage(message, type);
 160     if (type != Default) {
 161         m_messageTimeStamp = currentTime;
 162     }
 163
 164     const int widthGap = m_messageLabel->widthGap();
 165     if (widthGap > 0) {
 166         m_progressBar->hide();
 167         m_progressText->hide();
 168     }
 169     assureVisibleText();
 170 }
 171
 172 DolphinStatusBar::Type DolphinStatusBar::type() const
 173 {
 174     return m_messageLabel->type();
 175 }
 176
 177 QString DolphinStatusBar::message() const
 178 {
 179     return m_messageLabel->text();
 180 }
 181
 182 void DolphinStatusBar::setProgressText(const QString& text)
 183 {
 184     m_progressText->setText(text);
 185 }
 186
 187 QString DolphinStatusBar::progressText() const
 188 {
 189     return m_progressText->text();
 190 }
 191
 192 void DolphinStatusBar::setProgress(int percent)
 193 {
 194     // show a busy indicator if a value < 0 is provided:
 195     m_progressBar->setMaximum((percent < 0) ? 0 : 100);
 196
 197     if (percent < 0) {
 198         percent = 0;
 199     } else if (percent > 100) {
 200         percent = 100;
 201     }
 202
 203     m_progress = percent;
 204     if (m_messageLabel->type() == Error) {
 205         // don't update any widget or status bar text if an
 206         // error message is shown
 207         return;
 208     }
 209
 210     m_progressBar->setValue(m_progress);
 211     if (!m_progressBar->isVisible() || (percent == 100)) {
 212         updateProgressInfo();
 213     }
 214
 215     const QString& defaultText = m_messageLabel->defaultText();
 216     const QString msg(m_messageLabel->text());
 217     if ((percent == 0) && !msg.isEmpty()) {
 218         setMessage(QString(), Default);
 219     } else if ((percent == 100) && (msg != defaultText)) {
 220         setMessage(defaultText, Default);
 221     }
 222 }
 223
 224 void DolphinStatusBar::clear()
 225 {
 226     setMessage(m_messageLabel->defaultText(), Default);
 227 }
 228
 229 void DolphinStatusBar::setDefaultText(const QString& text)
 230 {
 231     m_messageLabel->setDefaultText(text);
 232 }
 233
 234 const QString& DolphinStatusBar::defaultText() const
 235 {
 236     return m_messageLabel->defaultText();
 237 }
 238
 239 void DolphinStatusBar::refresh()
 240 {
 241     setExtensionsVisible(true);
 242     assureVisibleText();
 243 }
 244
 245 void DolphinStatusBar::resizeEvent(QResizeEvent* event)
 246 {
 247     // It is important to hide the widgets before invoking
 248     // QWidget::resizeEvent(), otherwise it is possible that
 249     // the dock widgets are shrinked when having a small
 250     // statusbar width (bug #202147).
 251     m_zoomWidget->hide();
 252     m_spaceInfo->hide();
 253
 254     QWidget::resizeEvent(event);
 255     QMetaObject::invokeMethod(this, "assureVisibleText", Qt::QueuedConnection);
 256 }
 257
 258 void DolphinStatusBar::updateSpaceInfoContent(const KUrl& url)
 259 {
 260     m_spaceInfo->setUrl(url);
 261     assureVisibleText();
 262 }
 263
 264 void DolphinStatusBar::setZoomLevel(int zoomLevel)
 265 {
 266     m_zoomOut->setEnabled(zoomLevel > m_zoomSlider->minimum());
 267     m_zoomIn->setEnabled(zoomLevel < m_zoomSlider->maximum());
 268     m_view->setZoomLevel(zoomLevel);
 269     updateZoomSliderToolTip(zoomLevel);
 270 }
 271
 272 void DolphinStatusBar::assureVisibleText()
 273 {
 274     const int widthGap = m_messageLabel->widthGap();
 275     if (m_spaceInfo->isVisible() || m_zoomWidget->isVisible()) {
 276         // At least the space information or the zoom slider is shown.
 277         // Hide them if the status bar text does not fit into the available width.
 278         setExtensionsVisible(widthGap <= 0);
 279     } else if (!m_progressBar->isVisible()) {
 280         const GeneralSettings* settings = DolphinSettings::instance().generalSettings();
 281         const int spaceInfoWidth  = settings->showSpaceInfo()  ? m_spaceInfo->minimumWidth()  : 0;
 282         const int zoomWidgetWidth = settings->showZoomSlider() ? m_zoomWidget->minimumWidth() : 0;
 283         const int widgetsWidth = spaceInfoWidth + zoomWidgetWidth;
 284         setExtensionsVisible(widthGap + widgetsWidth <= 0);
 285     }
 286 }
 287
 288 void DolphinStatusBar::zoomOut()
 289 {
 290     const int value = m_zoomSlider->value();
 291     m_zoomSlider->setValue(value - 1);
 292 }
 293
 294 void DolphinStatusBar::zoomIn()
 295 {
 296     const int value = m_zoomSlider->value();
 297     m_zoomSlider->setValue(value + 1);
 298 }
 299
 300 void DolphinStatusBar::showZoomSliderToolTip(int zoomLevel)
 301 {
 302     updateZoomSliderToolTip(zoomLevel);
 303
 304     QPoint global = m_zoomSlider->rect().topLeft();
 305     global.ry() += m_zoomSlider->height() / 2;
 306     QHelpEvent toolTipEvent(QEvent::ToolTip, QPoint(0, 0), m_zoomSlider->mapToGlobal(global));
 307     QApplication::sendEvent(m_zoomSlider, &toolTipEvent);
 308 }
 309
 310 void DolphinStatusBar::updateProgressInfo()
 311 {
 312     const bool isErrorShown = (m_messageLabel->type() == Error);
 313     if (m_progress < 100) {
 314         // show the progress information and hide the extensions
 315         setExtensionsVisible(false);
 316         if (!isErrorShown) {
 317             m_progressText->show();
 318             m_progressBar->show();
 319         }
 320     } else {
 321         // hide the progress information and show the extensions
 322         m_progressText->hide();
 323         m_progressBar->hide();
 324         assureVisibleText();
 325     }
 326 }
 327
 328 void DolphinStatusBar::setExtensionsVisible(bool visible)
 329 {
 330     bool spaceInfoVisible = visible;
 331     bool zoomSliderVisible = visible;
 332     if (visible) {
 333         const GeneralSettings* settings = DolphinSettings::instance().generalSettings();
 334         spaceInfoVisible = settings->showSpaceInfo();
 335         zoomSliderVisible = settings->showZoomSlider();
 336     }
 337
 338     m_spaceInfo->setVisible(spaceInfoVisible);
 339     m_zoomWidget->setVisible(zoomSliderVisible);
 340 }
 341
 342 void DolphinStatusBar::updateZoomSliderToolTip(int zoomLevel)
 343 {
 344     const int size = ZoomLevelInfo::iconSizeForZoomLevel(zoomLevel);
 345     m_zoomSlider->setToolTip(i18ncp("@info:tooltip", "Size: 1 pixel", "Size: %1 pixels", size));
 346 }
 347
 348 #include "dolphinstatusbar.moc"