src/urlnavigatorbutton.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz (peter.penz@gmx.at)                  *
   3  *   Copyright (C) 2006 by Aaron J. Seigo (<aseigo@kde.org>)               *
   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 "urlnavigatorbutton.h"
  22
  23 #include <assert.h>
  24
  25 #include "urlnavigator.h"
  26
  27 #include <kio/job.h>
  28 #include <kio/jobclasses.h>
  29 #include <kglobalsettings.h>
  30 #include <kmenu.h>
  31
  32 #include <QPainter>
  33 #include <QPaintEvent>
  34 #include <QTimer>
  35
  36 UrlNavigatorButton::UrlNavigatorButton(int index, UrlNavigator* parent) :
  37     UrlButton(parent),
  38     m_index(-1),
  39     m_popupDelay(0),
  40     m_listJob(0)
  41 {
  42     setAcceptDrops(true);
  43     setMinimumWidth(arrowWidth());
  44     setIndex(index);
  45     connect(this, SIGNAL(clicked()), this, SLOT(updateNavigatorUrl()));
  46
  47     m_popupDelay = new QTimer(this);
  48     m_popupDelay->setSingleShot(true);
  49     connect(m_popupDelay, SIGNAL(timeout()), this, SLOT(startListJob()));
  50     connect(this, SIGNAL(pressed()), this, SLOT(startPopupDelay()));
  51 }
  52
  53 UrlNavigatorButton::~UrlNavigatorButton()
  54 {
  55 }
  56
  57 void UrlNavigatorButton::setIndex(int index)
  58 {
  59     m_index = index;
  60
  61     if (m_index < 0) {
  62         return;
  63     }
  64
  65     QString path(urlNavigator()->url().pathOrUrl());
  66     setText(path.section('/', index, index));
  67
  68     // Check whether the button indicates the full path of the Url. If
  69     // this is the case, the button is marked as 'active'.
  70     ++index;
  71     QFont adjustedFont(font());
  72     if (path.section('/', index, index).isEmpty()) {
  73         setDisplayHintEnabled(ActivatedHint, true);
  74         adjustedFont.setBold(true);
  75     }
  76     else {
  77         setDisplayHintEnabled(ActivatedHint, false);
  78         adjustedFont.setBold(false);
  79     }
  80
  81     setFont(adjustedFont);
  82     update();
  83 }
  84
  85 QSize UrlNavigatorButton::sizeHint() const
  86 {
  87     const int width = fontMetrics().width(text()) + (arrowWidth() * 4);
  88     return QSize(width, UrlButton::sizeHint().height());
  89 }
  90
  91 void UrlNavigatorButton::paintEvent(QPaintEvent* event)
  92 {
  93     QPainter painter(this);
  94     painter.setClipRect(event->rect());
  95     const int buttonWidth  = width();
  96     const int buttonHeight = height();
  97
  98     QColor backgroundColor;
  99     QColor foregroundColor;
 100     const bool isHighlighted = isDisplayHintEnabled(EnteredHint) ||
 101                                isDisplayHintEnabled(DraggedHint) ||
 102                                isDisplayHintEnabled(PopupActiveHint);
 103     if (isHighlighted) {
 104         backgroundColor = KGlobalSettings::highlightColor();
 105         foregroundColor = KGlobalSettings::highlightedTextColor();
 106     }
 107     else {
 108         backgroundColor = palette().brush(QPalette::Background).color();
 109         foregroundColor = KGlobalSettings::buttonTextColor();
 110     }
 111
 112     // dimm the colors if the parent view does not have the focus
 113     const bool isActive = urlNavigator()->isActive();
 114     if (!isActive) {
 115         QColor dimmColor(palette().brush(QPalette::Background).color());
 116         foregroundColor = mixColors(foregroundColor, dimmColor);
 117         if (isHighlighted) {
 118             backgroundColor = mixColors(backgroundColor, dimmColor);
 119         }
 120     }
 121
 122     // draw button background
 123     painter.setPen(Qt::NoPen);
 124     painter.setBrush(backgroundColor);
 125     painter.drawRect(0, 0, buttonWidth, buttonHeight);
 126
 127     int textWidth = buttonWidth;
 128     if (isDisplayHintEnabled(ActivatedHint) && isActive || isHighlighted) {
 129         painter.setPen(foregroundColor);
 130     }
 131     else {
 132         // dimm the foreground color by mixing it with the background
 133         foregroundColor = mixColors(foregroundColor, backgroundColor);
 134         painter.setPen(foregroundColor);
 135     }
 136
 137     if (!isDisplayHintEnabled(ActivatedHint)) {
 138         // draw arrow
 139         const int border = 2;  // horizontal border
 140         const int middleY = height() / 2;
 141         const int width = arrowWidth();
 142         const int startX = (buttonWidth - width) - (2 * border);
 143         const int startTopY = middleY - (width - 1);
 144         const int startBottomY = middleY + (width - 1);
 145         for (int i = 0; i < width; ++i) {
 146             painter.drawLine(startX, startTopY + i, startX + i, startTopY + i);
 147             painter.drawLine(startX, startBottomY - i, startX + i, startBottomY - i);
 148         }
 149
 150         textWidth = startX - border;
 151     }
 152
 153     const bool clipped = isTextClipped();
 154     const int align = clipped ? Qt::AlignVCenter : Qt::AlignCenter;
 155     painter.drawText(QRect(0, 0, textWidth, buttonHeight), align, text());
 156
 157     if (clipped) {
 158         // Blend the right area of the text with the background, as the
 159         // text is clipped.
 160         // TODO: use alpha blending in Qt4 instead of drawing the text that often
 161         const int blendSteps = 16;
 162
 163         QColor blendColor(backgroundColor);
 164         const int redInc   = (foregroundColor.red()   - backgroundColor.red())   / blendSteps;
 165         const int greenInc = (foregroundColor.green() - backgroundColor.green()) / blendSteps;
 166         const int blueInc  = (foregroundColor.blue()  - backgroundColor.blue())  / blendSteps;
 167         for (int i = 0; i < blendSteps; ++i) {
 168             painter.setClipRect(QRect(textWidth - i, 0, 1, buttonHeight));
 169             painter.setPen(blendColor);
 170             painter.drawText(QRect(0, 0, textWidth, buttonHeight), align, text());
 171
 172             blendColor.setRgb(blendColor.red()   + redInc,
 173                               blendColor.green() + greenInc,
 174                               blendColor.blue()  + blueInc);
 175         }
 176     }
 177 }
 178
 179 void UrlNavigatorButton::enterEvent(QEvent* event)
 180 {
 181     UrlButton::enterEvent(event);
 182
 183     // if the text is clipped due to a small window width, the text should
 184     // be shown as tooltip
 185     if (isTextClipped()) {
 186         setToolTip(text());
 187     }
 188 }
 189
 190 void UrlNavigatorButton::leaveEvent(QEvent* event)
 191 {
 192     UrlButton::leaveEvent(event);
 193     setToolTip(QString());
 194 }
 195
 196 void UrlNavigatorButton::dropEvent(QDropEvent* event)
 197 {
 198     if (m_index < 0) {
 199         return;
 200     }
 201
 202     const KUrl::List urls = KUrl::List::fromMimeData(event->mimeData());
 203     if (!urls.isEmpty()) {
 204         event->acceptProposedAction();
 205
 206         setDisplayHintEnabled(DraggedHint, true);
 207
 208         QString path(urlNavigator()->url().prettyUrl());
 209         path = path.section('/', 0, m_index + 2);
 210
 211         urlNavigator()->dropUrls(urls, KUrl(path));
 212
 213         setDisplayHintEnabled(DraggedHint, false);
 214         update();
 215     }
 216 }
 217
 218 void UrlNavigatorButton::dragEnterEvent(QDragEnterEvent* event)
 219 {
 220     if (event->mimeData()->hasUrls()) {
 221         setDisplayHintEnabled(DraggedHint, true);
 222         event->acceptProposedAction();
 223
 224         update();
 225     }
 226 }
 227
 228 void UrlNavigatorButton::dragLeaveEvent(QDragLeaveEvent* event)
 229 {
 230     UrlButton::dragLeaveEvent(event);
 231
 232     setDisplayHintEnabled(DraggedHint, false);
 233     update();
 234 }
 235
 236
 237 void UrlNavigatorButton::updateNavigatorUrl()
 238 {
 239     stopPopupDelay();
 240
 241     if (m_index < 0) {
 242         return;
 243     }
 244
 245     urlNavigator()->setUrl(urlNavigator()->url(m_index));
 246 }
 247
 248 void UrlNavigatorButton::startPopupDelay()
 249 {
 250     if (m_popupDelay->isActive() || (m_listJob != 0) || (m_index < 0)) {
 251         return;
 252     }
 253
 254     m_popupDelay->start(300);
 255 }
 256
 257 void UrlNavigatorButton::stopPopupDelay()
 258 {
 259     m_popupDelay->stop();
 260     if (m_listJob != 0) {
 261         m_listJob->kill();
 262         m_listJob = 0;
 263     }
 264 }
 265
 266 void UrlNavigatorButton::startListJob()
 267 {
 268     if (m_listJob != 0) {
 269         return;
 270     }
 271
 272     const KUrl& url = urlNavigator()->url(m_index);
 273     m_listJob = KIO::listDir(url, false, false);
 274     m_subdirs.clear(); // just to be ++safe
 275
 276     connect(m_listJob, SIGNAL(entries(KIO::Job*, const KIO::UDSEntryList &)),
 277             this, SLOT(entriesList(KIO::Job*, const KIO::UDSEntryList&)));
 278     connect(m_listJob, SIGNAL(result(KJob*)), this, SLOT(listJobFinished(KJob*)));
 279 }
 280
 281 void UrlNavigatorButton::entriesList(KIO::Job* job, const KIO::UDSEntryList& entries)
 282 {
 283     if (job != m_listJob) {
 284         return;
 285     }
 286
 287     KIO::UDSEntryList::const_iterator it = entries.constBegin();
 288     KIO::UDSEntryList::const_iterator itEnd = entries.constEnd();
 289     while (it != itEnd) {
 290         QString name;
 291         //bool isDir = false;
 292         KIO::UDSEntry entry = *it;
 293
 294         /* KDE3 reference:
 295             KIO::UDSEntry::const_iterator atomIt = entry.constBegin();
 296             KIO::UDSEntry::const_iterator atomEndIt = entry.constEnd();
 297
 298             while (atomIt != atomEndIt) {
 299             switch ((*atomIt).m_uds) {
 300                 case KIO::UDS_NAME:
 301                     name = (*atomIt).m_str;
 302                     break;
 303                 case KIO::UDS_FILE_TYPE:
 304                     isDir = S_ISDIR((*atomIt).m_long);
 305                     break;
 306                 default:
 307                     break;
 308             }
 309             ++atomIt;
 310          }
 311          if (isDir) {
 312              m_subdirs.append(name);
 313          }
 314         */
 315
 316         if (entry.isDir()) {
 317             m_subdirs.append(entry.stringValue(KIO::UDS_NAME));
 318         }
 319
 320         ++it;
 321     }
 322
 323     m_subdirs.sort();
 324 }
 325
 326 void UrlNavigatorButton::listJobFinished(KJob* job)
 327 {
 328     if (job != m_listJob) {
 329         return;
 330     }
 331
 332     if (job->error() || m_subdirs.isEmpty()) {
 333         // clear listing
 334         return;
 335     }
 336
 337     setDisplayHintEnabled(PopupActiveHint, true);
 338     update(); // ensure the button is drawn highlighted
 339
 340     KMenu* dirsMenu = new KMenu(this);
 341     QStringList::const_iterator it = m_subdirs.constBegin();
 342     QStringList::const_iterator itEnd = m_subdirs.constEnd();
 343     int i = 0;
 344     while (it != itEnd) {
 345         QAction* action = new QAction(*it, this);
 346         action->setData(i);
 347         dirsMenu->addAction(action);
 348         ++it;
 349         ++i;
 350     }
 351
 352     const QAction* action = dirsMenu->exec(urlNavigator()->mapToGlobal(geometry().bottomLeft()));
 353     if (action != 0) {
 354         const int result = action->data().toInt();
 355         KUrl url = urlNavigator()->url(m_index);
 356         url.addPath(m_subdirs[result]);
 357         urlNavigator()->setUrl(url);
 358     }
 359
 360     m_listJob = 0;
 361     m_subdirs.clear();
 362     delete dirsMenu;
 363     dirsMenu = 0;
 364
 365     setDisplayHintEnabled(PopupActiveHint, false);
 366 }
 367
 368 int UrlNavigatorButton::arrowWidth() const
 369 {
 370     int width = (height() / 2) - 7;
 371     if (width < 4) {
 372         width = 4;
 373     }
 374     return width;
 375 }
 376
 377 bool UrlNavigatorButton::isTextClipped() const
 378 {
 379     int availableWidth = width();
 380     if (!isDisplayHintEnabled(ActivatedHint)) {
 381         availableWidth -= arrowWidth() + 1;
 382     }
 383
 384     QFontMetrics fontMetrics(font());
 385     return fontMetrics.width(text()) >= availableWidth;
 386 }
 387
 388 #include "urlnavigatorbutton.moc"