gwenview/lib/fullscreenbar.cpp

   1 // vim: set tabstop=4 shiftwidth=4 noexpandtab:
   2 /*
   3 Gwenview: an image viewer
   4 Copyright 2007 Aurélien Gâteau <aurelien.gateau@free.fr>
   5
   6 This program is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU General Public License
   8 as published by the Free Software Foundation; either version 2
   9 of the License, or (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19
  20 */
  21 // Self
  22 #include "fullscreenbar.moc"
  23
  24 // Qt
  25 #include <QAction>
  26 #include <QApplication>
  27 #include <QDesktopWidget>
  28 #include <QBitmap>
  29 #include <QEvent>
  30 #include <QTimeLine>
  31 #include <QTimer>
  32 #include <QToolButton>
  33
  34 // KDE
  35 #include <kdebug.h>
  36 #include <klocale.h>
  37
  38 // Local
  39
  40 namespace Gwenview {
  41
  42
  43 static const int SLIDE_DURATION = 150;
  44 static const int AUTO_HIDE_CURSOR_TIMEOUT = 1000;
  45
  46 // How long before the bar slide out after switching to fullscreen
  47 static const int INITIAL_HIDE_TIMEOUT = 2000;
  48
  49
  50 struct FullScreenBarPrivate {
  51         FullScreenBar* that;
  52         QTimeLine* mTimeLine;
  53         QTimer* mAutoHideCursorTimer;
  54         bool mAutoHidingEnabled;
  55
  56         void startTimeLine() {
  57                 if (mTimeLine->state() != QTimeLine::Running) {
  58                         mTimeLine->start();
  59                 }
  60         }
  61
  62         void hideCursor() {
  63                 QBitmap empty(32, 32);
  64                 empty.clear();
  65                 QCursor blankCursor(empty, empty);
  66                 QApplication::setOverrideCursor(blankCursor);
  67         }
  68
  69         /**
  70          * Returns the rectangle in which the mouse must enter to trigger bar
  71          * sliding. The rectangle is in global coords.
  72          */
  73         QRect slideInTriggerRect() const {
  74                 QRect rect = QApplication::desktop()->screenGeometry();
  75                 // Take parent widget position into account because it may not be at
  76                 // the top of the screen, for example when the save bar warning is
  77                 // shown.
  78                 const QPoint topLeft = that->parentWidget()->mapToGlobal(QPoint(0, 0));
  79                 rect.setHeight(topLeft.y() + that->height());
  80                 return rect;
  81         }
  82
  83         bool shouldHide() const {
  84                 Q_ASSERT(that->parentWidget());
  85
  86                 if (!mAutoHidingEnabled) {
  87                         return false;
  88                 }
  89                 if (slideInTriggerRect().contains(QCursor::pos())) {
  90                         return false;
  91                 }
  92                 if (qApp->activePopupWidget()) {
  93                         return false;
  94                 }
  95                 return true;
  96         }
  97 };
  98
  99
 100 FullScreenBar::FullScreenBar(QWidget* parent)
 101 : QFrame(parent)
 102 , d(new FullScreenBarPrivate) {
 103         d->that = this;
 104         d->mAutoHidingEnabled = true;
 105         setObjectName("fullScreenBar");
 106
 107         d->mTimeLine = new QTimeLine(SLIDE_DURATION, this);
 108         connect(d->mTimeLine, SIGNAL(valueChanged(qreal)), SLOT(moveBar(qreal)) );
 109
 110         d->mAutoHideCursorTimer = new QTimer(this);
 111         d->mAutoHideCursorTimer->setInterval(AUTO_HIDE_CURSOR_TIMEOUT);
 112         d->mAutoHideCursorTimer->setSingleShot(true);
 113         connect(d->mAutoHideCursorTimer, SIGNAL(timeout()), SLOT(slotAutoHideCursorTimeout()) );
 114
 115         hide();
 116 }
 117
 118
 119 FullScreenBar::~FullScreenBar() {
 120         delete d;
 121 }
 122
 123 QSize FullScreenBar::sizeHint() const {
 124         int width = QApplication::desktop()->screenGeometry(this).width();
 125         return QSize(width, QFrame::sizeHint().height());
 126 }
 127
 128 void FullScreenBar::moveBar(qreal value) {
 129         move(0, -height() + int(value * height()) );
 130
 131         // For some reason, if Gwenview is started with command line options to
 132         // start a slideshow, the bar might end up below the view. Calling raise()
 133         // here fixes it.
 134         raise();
 135 }
 136
 137
 138 void FullScreenBar::setActivated(bool activated) {
 139         if (activated) {
 140                 // Delay installation of event filter because switching to fullscreen
 141                 // cause a few window adjustments, which seems to generate unwanted
 142                 // mouse events, which cause the bar to slide in.
 143                 QTimer::singleShot(500, this, SLOT(delayedInstallEventFilter()));
 144
 145                 // Make sure the widget is visible on start
 146                 move(0, 0);
 147                 raise();
 148                 show();
 149         } else {
 150                 qApp->removeEventFilter(this);
 151                 hide();
 152                 d->mAutoHideCursorTimer->stop();
 153                 QApplication::restoreOverrideCursor();
 154         }
 155 }
 156
 157
 158 void FullScreenBar::delayedInstallEventFilter() {
 159         qApp->installEventFilter(this);
 160         if (d->shouldHide()) {
 161                 QTimer::singleShot(INITIAL_HIDE_TIMEOUT, this, SLOT(slideOut()));
 162                 d->hideCursor();
 163         }
 164 }
 165
 166
 167 void FullScreenBar::slotAutoHideCursorTimeout() {
 168         if (d->shouldHide()) {
 169                 d->hideCursor();
 170         } else {
 171                 d->mAutoHideCursorTimer->start();
 172         }
 173 }
 174
 175
 176 void FullScreenBar::slideOut() {
 177         d->mTimeLine->setDirection(QTimeLine::Backward);
 178         d->startTimeLine();
 179 }
 180
 181
 182 void FullScreenBar::slideIn() {
 183         d->mTimeLine->setDirection(QTimeLine::Forward);
 184         d->startTimeLine();
 185 }
 186
 187
 188 bool FullScreenBar::eventFilter(QObject* object, QEvent* event) {
 189         if (event->type() == QEvent::MouseMove) {
 190                 QApplication::restoreOverrideCursor();
 191                 d->mAutoHideCursorTimer->start();
 192                 if (y() == 0) {
 193                         if (d->shouldHide()) {
 194                                 slideOut();
 195                         }
 196                 } else {
 197                         if (d->slideInTriggerRect().contains(QCursor::pos())) {
 198                                 slideIn();
 199                         }
 200                 }
 201                 return false;
 202         }
 203
 204         // Filtering message on tooltip text for CJK to remove accelerators.
 205         // Quoting ktoolbar.cpp:
 206         // """
 207         // CJK languages use more verbose accelerator marker: they add a Latin
 208         // letter in parenthesis, and put accelerator on that. Hence, the default
 209         // removal of ampersand only may not be enough there, instead the whole
 210         // parenthesis construct should be removed. Provide these filtering i18n
 211         // messages so that translators can use Transcript for custom removal.
 212         // """
 213         if (event->type() == QEvent::Show || event->type() == QEvent::Paint) {
 214                 QToolButton* button = qobject_cast<QToolButton*>(object);
 215                 if (button && !button->actions().isEmpty()) {
 216                         QAction* action = button->actions().first();
 217                         button->setToolTip(i18nc("@info:tooltip of custom toolbar button", "%1", action->toolTip()));
 218                 }
 219         }
 220
 221         return false;
 222 }
 223
 224
 225 void FullScreenBar::setAutoHidingEnabled(bool value) {
 226         d->mAutoHidingEnabled = value;
 227 }
 228
 229
 230 } // namespace