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 = (fontHeight < zoomWidgetHeight) ? zoomWidgetHeight : fontHeight;
 112
 113     m_messageLabel->setMinimumTextHeight(contentHeight);
 114     m_spaceInfo->setFixedHeight(contentHeight);
 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     if (msg.isEmpty()) {
 129         // show the default text as fallback
 130         clear();
 131         return;
 132     }
 133
 134     if ((msg == m_messageLabel->text()) && (type == m_messageLabel->type())) {
 135         // the message is already shown
 136         return;
 137     }
 138
 139     const QTime currentTime = QTime::currentTime();
 140     const bool skipMessage = (type == Default) &&
 141                              m_messageTimeStamp.isValid() &&
 142                              (m_messageTimeStamp.msecsTo(currentTime) < 1000);
 143     if (skipMessage) {
 144         // A non-default message is shown just for a very short time. Don't hide
 145         // the message by a default message, so that the user gets the chance to
 146         // read the information.
 147         return;
 148     }
 149
 150     m_messageLabel->setMessage(msg, type);
 151     if (type != Default) {
 152         m_messageTimeStamp = currentTime;
 153     }
 154
 155     const int widthGap = m_messageLabel->widthGap();
 156     if (widthGap > 0) {
 157         m_progressBar->hide();
 158         m_progressText->hide();
 159     }
 160     assureVisibleText();
 161 }
 162
 163 DolphinStatusBar::Type DolphinStatusBar::type() const
 164 {
 165     return m_messageLabel->type();
 166 }
 167
 168 QString DolphinStatusBar::message() const
 169 {
 170     return m_messageLabel->text();
 171 }
 172
 173 void DolphinStatusBar::setProgressText(const QString& text)
 174 {
 175     m_progressText->setText(text);
 176 }
 177
 178 QString DolphinStatusBar::progressText() const
 179 {
 180     return m_progressText->text();
 181 }
 182
 183 void DolphinStatusBar::setProgress(int percent)
 184 {
 185     if (percent < 0) {
 186         percent = 0;
 187     } else if (percent > 100) {
 188         percent = 100;
 189     }
 190
 191     m_progress = percent;
 192     if (m_messageLabel->type() == Error) {
 193         // don't update any widget or status bar text if an
 194         // error message is shown
 195         return;
 196     }
 197
 198     m_progressBar->setValue(m_progress);
 199     if (!m_progressBar->isVisible() || (percent == 100)) {
 200         QTimer::singleShot(300, this, SLOT(updateProgressInfo()));
 201     }
 202
 203     const QString& defaultText = m_messageLabel->defaultText();
 204     const QString msg(m_messageLabel->text());
 205     if ((percent == 0) && !msg.isEmpty()) {
 206         setMessage(QString(), Default);
 207     } else if ((percent == 100) && (msg != defaultText)) {
 208         setMessage(defaultText, Default);
 209     }
 210 }
 211
 212 void DolphinStatusBar::clear()
 213 {
 214     setMessage(m_messageLabel->defaultText(), Default);
 215 }
 216
 217 void DolphinStatusBar::setDefaultText(const QString& text)
 218 {
 219     m_messageLabel->setDefaultText(text);
 220 }
 221
 222 const QString& DolphinStatusBar::defaultText() const
 223 {
 224     return m_messageLabel->defaultText();
 225 }
 226
 227 void DolphinStatusBar::refresh()
 228 {
 229     setExtensionsVisible(true);
 230     assureVisibleText();
 231 }
 232
 233 void DolphinStatusBar::resizeEvent(QResizeEvent* event)
 234 {
 235     // It is important to hide the widgets before invoking
 236     // QWidget::resizeEvent(), otherwise it is possible that
 237     // the dock widgets are shrinked when having a small
 238     // statusbar width (bug #202147).
 239     m_zoomWidget->hide();
 240     m_spaceInfo->hide();
 241
 242     QWidget::resizeEvent(event);
 243     QMetaObject::invokeMethod(this, "assureVisibleText", Qt::QueuedConnection);
 244 }
 245
 246 void DolphinStatusBar::updateProgressInfo()
 247 {
 248     const bool isErrorShown = (m_messageLabel->type() == Error);
 249     if (m_progress < 100) {
 250         // show the progress information and hide the extensions
 251         setExtensionsVisible(false);
 252         if (!isErrorShown) {
 253             m_progressText->show();
 254             m_progressBar->show();
 255         }
 256     } else {
 257         // hide the progress information and show the extensions
 258         m_progressText->hide();
 259         m_progressBar->hide();
 260         assureVisibleText();
 261     }
 262 }
 263
 264 void DolphinStatusBar::updateSpaceInfoContent(const KUrl& url)
 265 {
 266     m_spaceInfo->setUrl(url);
 267     assureVisibleText();
 268 }
 269
 270 void DolphinStatusBar::setZoomLevel(int zoomLevel)
 271 {
 272     m_zoomOut->setEnabled(zoomLevel > m_zoomSlider->minimum());
 273     m_zoomIn->setEnabled(zoomLevel < m_zoomSlider->maximum());
 274     m_view->setZoomLevel(zoomLevel);
 275     updateZoomSliderToolTip(zoomLevel);
 276 }
 277
 278 void DolphinStatusBar::assureVisibleText()
 279 {
 280     const int widthGap = m_messageLabel->widthGap();
 281     if (m_spaceInfo->isVisible() || m_zoomWidget->isVisible()) {
 282         // At least the space information or the zoom slider is shown.
 283         // Hide them if the status bar text does not fit into the available width.
 284         if (widthGap > 0) {
 285             setExtensionsVisible(false);
 286         }
 287     } else if (!m_progressBar->isVisible()) {
 288         const GeneralSettings* settings = DolphinSettings::instance().generalSettings();
 289         const int spaceInfoWidth  = settings->showSpaceInfo()  ? m_spaceInfo->minimumWidth()  : 0;
 290         const int zoomWidgetWidth = settings->showZoomSlider() ? m_zoomWidget->minimumWidth() : 0;
 291         const int widgetsWidth = spaceInfoWidth + zoomWidgetWidth;
 292
 293         if (widthGap + widgetsWidth <= 0) {
 294             setExtensionsVisible(true);
 295         }
 296     }
 297 }
 298
 299 void DolphinStatusBar::zoomOut()
 300 {
 301     const int value = m_zoomSlider->value();
 302     m_zoomSlider->setValue(value - 1);
 303 }
 304
 305 void DolphinStatusBar::zoomIn()
 306 {
 307     const int value = m_zoomSlider->value();
 308     m_zoomSlider->setValue(value + 1);
 309 }
 310
 311 void DolphinStatusBar::showZoomSliderToolTip(int zoomLevel)
 312 {
 313     updateZoomSliderToolTip(zoomLevel);
 314
 315     QPoint global = m_zoomSlider->rect().topLeft();
 316     global.ry() += m_zoomSlider->height() / 2;
 317     QHelpEvent toolTipEvent(QEvent::ToolTip, QPoint(0, 0), m_zoomSlider->mapToGlobal(global));
 318     QApplication::sendEvent(m_zoomSlider, &toolTipEvent);
 319 }
 320
 321 void DolphinStatusBar::setExtensionsVisible(bool visible)
 322 {
 323     bool spaceInfoVisible = visible;
 324     bool zoomSliderVisible = visible;
 325     if (visible) {
 326         const GeneralSettings* settings = DolphinSettings::instance().generalSettings();
 327         spaceInfoVisible = settings->showSpaceInfo();
 328         zoomSliderVisible = settings->showZoomSlider();
 329     }
 330
 331     m_spaceInfo->setVisible(spaceInfoVisible);
 332     m_zoomWidget->setVisible(zoomSliderVisible);
 333 }
 334
 335 void DolphinStatusBar::updateZoomSliderToolTip(int zoomLevel)
 336 {
 337     const int size = ZoomLevelInfo::iconSizeForZoomLevel(zoomLevel);
 338     m_zoomSlider->setToolTip(i18ncp("@info:tooltip", "Size: 1 pixel", "Size: %1 pixels", size));
 339 }
 340
 341 #include "dolphinstatusbar.moc"