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
  23 #include "dolphin_generalsettings.h"
  24
  25 #include <KIconLoader>
  26 #include <KIcon>
  27 #include <KLocale>
  28 #include <KMenu>
  29 #include <KVBox>
  30
  31 #include "settings/dolphinsettings.h"
  32 #include "statusbarspaceinfo.h"
  33
  34 #include <QApplication>
  35 #include <QClipboard>
  36 #include <QHBoxLayout>
  37 #include <QLabel>
  38 #include <QProgressBar>
  39 #include <QToolButton>
  40 #include <QTime>
  41 #include <QTimer>
  42
  43 #include <views/dolphinview.h>
  44 #include <views/zoomlevelinfo.h>
  45
  46 DolphinStatusBar::DolphinStatusBar(QWidget* parent, DolphinView* view) :
  47     QWidget(parent),
  48     m_view(view),
  49     m_messageLabel(0),
  50     m_spaceInfo(0),
  51     m_zoomWidget(0),
  52     m_zoomOut(0),
  53     m_zoomSlider(0),
  54     m_zoomIn(0),
  55     m_progressBar(0),
  56     m_stopButton(0),
  57     m_progress(100),
  58     m_showProgressBarTimer(0),
  59     m_messageTimeStamp()
  60 {
  61     connect(m_view, SIGNAL(urlChanged(const KUrl&)),
  62             this, SLOT(updateSpaceInfoContent(const KUrl&)));
  63
  64     // Initialize message label
  65     m_messageLabel = new KonqStatusBarMessageLabel(this);
  66
  67     // Initialize zoom slider
  68     m_zoomWidget = new QWidget(this);
  69
  70     m_zoomOut = new QToolButton(m_zoomWidget);
  71     m_zoomOut->setIcon(KIcon("zoom-out"));
  72     m_zoomOut->setAutoRaise(true);
  73
  74     m_zoomSlider = new QSlider(Qt::Horizontal, m_zoomWidget);
  75     m_zoomSlider->setPageStep(1);
  76
  77     const int min = ZoomLevelInfo::minimumLevel();
  78     const int max = ZoomLevelInfo::maximumLevel();
  79     m_zoomSlider->setRange(min, max);
  80     m_zoomSlider->setValue(view->zoomLevel());
  81     updateZoomSliderToolTip(view->zoomLevel());
  82
  83     m_zoomIn = new QToolButton(m_zoomWidget);
  84     m_zoomIn->setIcon(KIcon("zoom-in"));
  85     m_zoomIn->setAutoRaise(true);
  86
  87     // Initialize zoom widget layout
  88     QHBoxLayout* zoomWidgetLayout = new QHBoxLayout(m_zoomWidget);
  89     zoomWidgetLayout->setSpacing(0);
  90     zoomWidgetLayout->setMargin(0);
  91     zoomWidgetLayout->addWidget(m_zoomOut);
  92     zoomWidgetLayout->addWidget(m_zoomSlider);
  93     zoomWidgetLayout->addWidget(m_zoomIn);
  94
  95     connect(m_zoomSlider, SIGNAL(valueChanged(int)), this, SLOT(setZoomLevel(int)));
  96     connect(m_zoomSlider, SIGNAL(sliderMoved(int)), this, SLOT(showZoomSliderToolTip(int)));
  97     connect(m_view, SIGNAL(zoomLevelChanged(int)), m_zoomSlider, SLOT(setValue(int)));
  98     connect(m_zoomOut, SIGNAL(clicked()), this, SLOT(zoomOut()));
  99     connect(m_zoomIn, SIGNAL(clicked()), this, SLOT(zoomIn()));
 100
 101     // Initialize space information
 102     m_spaceInfo = new StatusBarSpaceInfo(this);
 103     m_spaceInfo->setUrl(m_view->url());
 104
 105     // Initialize progress information
 106     m_stopButton = new QToolButton(this);
 107     m_stopButton->setIcon(KIcon("process-stop"));
 108     // TODO: Add tooltip for KDE SC 4.7.0, if new strings are allowed again
 109     m_stopButton->setAutoRaise(true);
 110     m_stopButton->hide();
 111     connect(m_stopButton, SIGNAL(clicked()), this, SIGNAL(stopPressed()));
 112
 113     m_progressText = new QLabel(this);
 114     m_progressText->hide();
 115
 116     m_progressBar = new QProgressBar(this);
 117     m_progressBar->hide();
 118
 119     m_showProgressBarTimer = new QTimer(this);
 120     m_showProgressBarTimer->setInterval(1000);
 121     m_showProgressBarTimer->setSingleShot(true);
 122     connect(m_showProgressBarTimer, SIGNAL(timeout()), this, SLOT(updateProgressInfo()));
 123
 124     // Initialize top layout and size policies
 125     const int fontHeight = QFontMetrics(m_messageLabel->font()).height();
 126     const int zoomWidgetHeight = m_zoomWidget->minimumSizeHint().height();
 127     const int contentHeight = qMax(fontHeight, zoomWidgetHeight);
 128
 129     m_messageLabel->setMinimumTextHeight(contentHeight);
 130
 131     m_spaceInfo->setMaximumSize(200, contentHeight - 5);
 132     m_spaceInfo->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
 133
 134     m_progressBar->setMaximumSize(200, contentHeight);
 135     m_zoomWidget->setMaximumSize(150, contentHeight);
 136     m_zoomSlider->setMinimumWidth(30);
 137
 138     QHBoxLayout* topLayout = new QHBoxLayout(this);
 139     topLayout->setMargin(0);
 140     topLayout->setSpacing(4);
 141     topLayout->addWidget(m_messageLabel);
 142     topLayout->addWidget(m_zoomWidget);
 143     topLayout->addWidget(m_spaceInfo);
 144     topLayout->addWidget(m_stopButton);
 145     topLayout->addWidget(m_progressText);
 146     topLayout->addWidget(m_progressBar);
 147
 148     setExtensionsVisible(true);
 149 }
 150
 151 DolphinStatusBar::~DolphinStatusBar()
 152 {
 153 }
 154
 155 void DolphinStatusBar::setMessage(const QString& msg,
 156                                   Type type)
 157 {
 158     int timeout = 1000; // Timeout in milliseconds until default
 159                         // messages may overwrite other messages.
 160
 161     QString message = msg;
 162     if (message.isEmpty()) {
 163         // Show the default text as fallback. An empty text indicates
 164         // a clearing of the information message.
 165         if (m_messageLabel->defaultText().isEmpty()) {
 166             return;
 167         }
 168         message = m_messageLabel->defaultText();
 169         type = Default;
 170         timeout = 0;
 171     }
 172
 173     KonqStatusBarMessageLabel::Type konqType = static_cast<KonqStatusBarMessageLabel::Type>(type);
 174     if ((message == m_messageLabel->text()) && (konqType == m_messageLabel->type())) {
 175         // the message is already shown
 176         return;
 177     }
 178
 179     const QTime currentTime = QTime::currentTime();
 180     const bool skipMessage = (type == Default) &&
 181                              m_messageTimeStamp.isValid() &&
 182                              (m_messageTimeStamp.msecsTo(currentTime) < timeout);
 183     if (skipMessage) {
 184         // A non-default message is shown just for a very short time. Don't hide
 185         // the message by a default message, so that the user gets the chance to
 186         // read the information.
 187         return;
 188     }
 189
 190     m_messageLabel->setMessage(message, konqType);
 191     if (type != Default) {
 192         m_messageTimeStamp = currentTime;
 193     }
 194 }
 195
 196 DolphinStatusBar::Type DolphinStatusBar::type() const
 197 {
 198     return static_cast<Type>(m_messageLabel->type());
 199 }
 200
 201 QString DolphinStatusBar::message() const
 202 {
 203     return m_messageLabel->text();
 204 }
 205
 206 void DolphinStatusBar::setProgressText(const QString& text)
 207 {
 208     m_progressText->setText(text);
 209 }
 210
 211 int DolphinStatusBar::progress() const
 212 {
 213     return m_progress;
 214 }
 215
 216 QString DolphinStatusBar::progressText() const
 217 {
 218     return m_progressText->text();
 219 }
 220
 221 void DolphinStatusBar::setProgress(int percent)
 222 {
 223     // Show a busy indicator if a value < 0 is provided:
 224     m_progressBar->setMaximum((percent < 0) ? 0 : 100);
 225
 226     if (percent < 0) {
 227         percent = 0;
 228     } else if (percent > 100) {
 229         percent = 100;
 230     }
 231
 232     const bool progressRestarted = (percent < 100) && (percent < m_progress);
 233     m_progress = percent;
 234     if (m_messageLabel->type() == KonqStatusBarMessageLabel::Error) {
 235         // Don't update any widget or status bar text if an
 236         // error message is shown
 237         return;
 238     }
 239
 240     if (progressRestarted && !m_progressBar->isVisible()) {
 241         // Show the progress bar delayed: In the case if 100 % are reached within
 242         // a short time, no progress bar will be shown at all.
 243         m_showProgressBarTimer->start();
 244     }
 245
 246     m_progressBar->setValue(m_progress);
 247     if (percent == 100) {
 248         // The end of the progress has been reached. Assure that the progress bar
 249         // gets hidden and the extensions widgets get visible again.
 250         m_showProgressBarTimer->stop();
 251         updateProgressInfo();
 252     }
 253
 254     const QString defaultText = m_messageLabel->defaultText();
 255     const QString msg(m_messageLabel->text());
 256     if ((percent == 0) && !msg.isEmpty()) {
 257         setMessage(QString(), Default);
 258     } else if ((percent == 100) && (msg != defaultText)) {
 259         setMessage(defaultText, Default);
 260     }
 261 }
 262
 263 void DolphinStatusBar::clear()
 264 {
 265     setMessage(m_messageLabel->defaultText(), Default);
 266 }
 267
 268 void DolphinStatusBar::setDefaultText(const QString& text)
 269 {
 270     m_messageLabel->setDefaultText(text);
 271 }
 272
 273 QString DolphinStatusBar::defaultText() const
 274 {
 275     return m_messageLabel->defaultText();
 276 }
 277
 278 void DolphinStatusBar::refresh()
 279 {
 280     setExtensionsVisible(true);
 281 }
 282
 283 void DolphinStatusBar::contextMenuEvent(QContextMenuEvent* event)
 284 {
 285     Q_UNUSED(event);
 286
 287     KMenu menu(this);
 288
 289     QAction* copyAction = 0;
 290     switch (type()) {
 291     case Default:
 292     case OperationCompleted:
 293     case Information:
 294         copyAction = menu.addAction(i18nc("@action:inmenu", "Copy Information Message"));
 295         break;
 296     case Error:
 297         copyAction = menu.addAction(i18nc("@action:inmenu", "Copy Error Message"));
 298         break;
 299     default: break;
 300     }
 301
 302     GeneralSettings* settings = DolphinSettings::instance().generalSettings();
 303
 304     QAction* showZoomSliderAction = menu.addAction(i18nc("@action:inmenu", "Show Zoom Slider"));
 305     showZoomSliderAction->setCheckable(true);
 306     showZoomSliderAction->setChecked(settings->showZoomSlider());
 307
 308     QAction* showSpaceInfoAction = menu.addAction(i18nc("@action:inmenu", "Show Space Information"));
 309     showSpaceInfoAction->setCheckable(true);
 310     showSpaceInfoAction->setChecked(settings->showSpaceInfo());
 311
 312     const QAction* action = menu.exec(QCursor::pos());
 313     if (action == copyAction) {
 314         QMimeData* mimeData = new QMimeData();
 315         mimeData->setText(message());
 316         QApplication::clipboard()->setMimeData(mimeData);
 317     } else if (action == showZoomSliderAction) {
 318         const bool visible = showZoomSliderAction->isChecked();
 319         settings->setShowZoomSlider(visible);
 320         m_zoomWidget->setVisible(visible);
 321     } else if (action == showSpaceInfoAction) {
 322         const bool visible = showSpaceInfoAction->isChecked();
 323         settings->setShowSpaceInfo(visible);
 324         m_spaceInfo->setVisible(visible);
 325     }
 326 }
 327
 328 void DolphinStatusBar::updateSpaceInfoContent(const KUrl& url)
 329 {
 330     m_spaceInfo->setUrl(url);
 331 }
 332
 333 void DolphinStatusBar::setZoomLevel(int zoomLevel)
 334 {
 335     m_zoomOut->setEnabled(zoomLevel > m_zoomSlider->minimum());
 336     m_zoomIn->setEnabled(zoomLevel < m_zoomSlider->maximum());
 337     m_view->setZoomLevel(zoomLevel);
 338     updateZoomSliderToolTip(zoomLevel);
 339 }
 340
 341 void DolphinStatusBar::zoomOut()
 342 {
 343     const int value = m_zoomSlider->value();
 344     m_zoomSlider->setValue(value - 1);
 345 }
 346
 347 void DolphinStatusBar::zoomIn()
 348 {
 349     const int value = m_zoomSlider->value();
 350     m_zoomSlider->setValue(value + 1);
 351 }
 352
 353 void DolphinStatusBar::showZoomSliderToolTip(int zoomLevel)
 354 {
 355     updateZoomSliderToolTip(zoomLevel);
 356
 357     QPoint global = m_zoomSlider->rect().topLeft();
 358     global.ry() += m_zoomSlider->height() / 2;
 359     QHelpEvent toolTipEvent(QEvent::ToolTip, QPoint(0, 0), m_zoomSlider->mapToGlobal(global));
 360     QApplication::sendEvent(m_zoomSlider, &toolTipEvent);
 361 }
 362
 363 void DolphinStatusBar::updateProgressInfo()
 364 {
 365     const bool isErrorShown = (m_messageLabel->type() == KonqStatusBarMessageLabel::Error);
 366     if (m_progress < 100) {
 367         // Show the progress information and hide the extensions
 368         setExtensionsVisible(false);
 369         if (!isErrorShown) {
 370             m_stopButton->show();
 371             m_progressText->show();
 372             m_progressBar->show();
 373         }
 374     } else {
 375         // Hide the progress information and show the extensions
 376         m_stopButton->hide();
 377         m_progressText->hide();
 378         m_progressBar->hide();
 379         setExtensionsVisible(true);
 380     }
 381 }
 382
 383 void DolphinStatusBar::setExtensionsVisible(bool visible)
 384 {
 385     bool showSpaceInfo = visible;
 386     bool showZoomWidget = visible;
 387     if (visible) {
 388         const GeneralSettings* settings = DolphinSettings::instance().generalSettings();
 389         showSpaceInfo = settings->showSpaceInfo();
 390         showZoomWidget = settings->showZoomSlider();
 391     }
 392     m_spaceInfo->setVisible(showSpaceInfo);
 393     m_zoomWidget->setVisible(showZoomWidget);
 394 }
 395
 396 void DolphinStatusBar::updateZoomSliderToolTip(int zoomLevel)
 397 {
 398     const int size = ZoomLevelInfo::iconSizeForZoomLevel(zoomLevel);
 399     m_zoomSlider->setToolTip(i18ncp("@info:tooltip", "Size: 1 pixel", "Size: %1 pixels", size));
 400 }
 401
 402 #include "dolphinstatusbar.moc"