src/panels/information/informationpanelcontent.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #include "informationpanelcontent.h"
  21
  22 #include <KDialog>
  23 #include <KFileItem>
  24 #include <kfilemetadatawidget.h>
  25 #include <KFilePlacesModel>
  26 #include <KGlobalSettings>
  27 #include <KIO/PreviewJob>
  28 #include <KIconEffect>
  29 #include <KIconLoader>
  30 #include <KLocale>
  31 #include <KMenu>
  32 #include <kseparator.h>
  33 #include <KStringHandler>
  34
  35 #include <Phonon/BackendCapabilities>
  36 #include <Phonon/MediaObject>
  37 #include <Phonon/SeekSlider>
  38
  39 #include <QEvent>
  40 #include <QLabel>
  41 #include <QPixmap>
  42 #include <QPointer>
  43 #include <QResizeEvent>
  44 #include <QScrollArea>
  45 #include <QTextDocument>
  46 #include <QTextLayout>
  47 #include <QTextLine>
  48 #include <QTimer>
  49 #include <QVBoxLayout>
  50
  51 #include "dolphin_informationpanelsettings.h"
  52 #include "filemetadataconfigurationdialog.h"
  53 #include "settings/dolphinsettings.h"
  54 #include "phononwidget.h"
  55 #include "pixmapviewer.h"
  56
  57 InformationPanelContent::InformationPanelContent(QWidget* parent) :
  58     QWidget(parent),
  59     m_item(),
  60     m_pendingPreview(false),
  61     m_outdatedPreviewTimer(0),
  62     m_preview(0),
  63     m_phononWidget(0),
  64     m_nameLabel(0),
  65     m_metaDataWidget(0),
  66     m_metaDataArea(0)
  67 {
  68     parent->installEventFilter(this);
  69
  70     // Initialize timer for disabling an outdated preview with a small
  71     // delay. This prevents flickering if the new preview can be generated
  72     // within a very small timeframe.
  73     m_outdatedPreviewTimer = new QTimer(this);
  74     m_outdatedPreviewTimer->setInterval(300);
  75     m_outdatedPreviewTimer->setSingleShot(true);
  76     connect(m_outdatedPreviewTimer, SIGNAL(timeout()),
  77             this, SLOT(markOutdatedPreview()));
  78
  79     QVBoxLayout* layout = new QVBoxLayout(this);
  80     layout->setSpacing(KDialog::spacingHint());
  81
  82     // preview
  83     const int minPreviewWidth = KIconLoader::SizeEnormous + KIconLoader::SizeMedium;
  84
  85     m_preview = new PixmapViewer(parent);
  86     m_preview->setMinimumWidth(minPreviewWidth);
  87     m_preview->setMinimumHeight(KIconLoader::SizeEnormous);
  88
  89     m_phononWidget = new PhononWidget(parent);
  90     m_phononWidget->hide();
  91     m_phononWidget->setMinimumWidth(minPreviewWidth);
  92     connect(m_phononWidget, SIGNAL(playingStarted()),
  93             this, SLOT(slotPlayingStarted()));
  94     connect(m_phononWidget, SIGNAL(playingStopped()),
  95             this, SLOT(slotPlayingStopped()));
  96
  97     // name
  98     m_nameLabel = new QLabel(parent);
  99     QFont font = m_nameLabel->font();
 100     font.setBold(true);
 101     m_nameLabel->setFont(font);
 102     m_nameLabel->setAlignment(Qt::AlignHCenter);
 103     m_nameLabel->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
 104
 105     const bool showPreview = InformationPanelSettings::showPreview();
 106     m_preview->setVisible(showPreview);
 107
 108     m_metaDataWidget = new KFileMetaDataWidget(parent);
 109     m_metaDataWidget->setFont(KGlobalSettings::smallestReadableFont());
 110     m_metaDataWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Minimum);
 111     connect(m_metaDataWidget, SIGNAL(urlActivated(KUrl)), this, SIGNAL(urlActivated(KUrl)));
 112
 113     // Encapsulate the MetaDataWidget inside a container that has a dummy widget
 114     // at the bottom. This prevents that the meta data widget gets vertically stretched
 115     // in the case where the height of m_metaDataArea > m_metaDataWidget.
 116     QWidget* metaDataWidgetContainer = new QWidget(parent);
 117     QVBoxLayout* containerLayout = new QVBoxLayout(metaDataWidgetContainer);
 118     containerLayout->setContentsMargins(0, 0, 0, 0);
 119     containerLayout->setSpacing(0);
 120     containerLayout->addWidget(m_metaDataWidget);
 121     containerLayout->addStretch();
 122
 123     m_metaDataArea = new QScrollArea(parent);
 124     m_metaDataArea->setWidget(metaDataWidgetContainer);
 125     m_metaDataArea->setWidgetResizable(true);
 126     m_metaDataArea->setFrameShape(QFrame::NoFrame);
 127
 128     QWidget* viewport = m_metaDataArea->viewport();
 129     viewport->installEventFilter(this);
 130
 131     QPalette palette = viewport->palette();
 132     palette.setColor(viewport->backgroundRole(), QColor(Qt::transparent));
 133     viewport->setPalette(palette);
 134
 135     layout->addWidget(m_preview);
 136     layout->addWidget(m_phononWidget);
 137     layout->addWidget(m_nameLabel);
 138     layout->addWidget(new KSeparator());
 139     layout->addWidget(m_metaDataArea);
 140 }
 141
 142 InformationPanelContent::~InformationPanelContent()
 143 {
 144     InformationPanelSettings::self()->writeConfig();
 145 }
 146
 147 void InformationPanelContent::showItem(const KFileItem& item)
 148 {
 149     m_pendingPreview = false;
 150
 151     const KUrl itemUrl = item.url();
 152     const bool isSearchUrl = itemUrl.protocol().contains("search") && item.nepomukUri().isEmpty();
 153     if (!applyPlace(itemUrl)) {
 154         setNameLabelText(item.text());
 155         if (isSearchUrl) {
 156             // in the case of a search-URL the URL is not readable for humans
 157             // (at least not useful to show in the Information Panel)
 158             KIconLoader iconLoader;
 159             QPixmap icon = iconLoader.loadIcon("nepomuk",
 160                                                KIconLoader::NoGroup,
 161                                                KIconLoader::SizeEnormous);
 162             m_preview->setPixmap(icon);
 163         } else {
 164             // try to get a preview pixmap from the item...
 165             m_pendingPreview = true;
 166
 167             // Mark the currently shown preview as outdated. This is done
 168             // with a small delay to prevent a flickering when the next preview
 169             // can be shown within a short timeframe. This timer is not started
 170             // for directories, as directory previews might fail and return the
 171             // same icon.
 172             if (!item.isDir()) {
 173                 m_outdatedPreviewTimer->start();
 174             }
 175
 176             KIO::PreviewJob* job = KIO::filePreview(KFileItemList() << item, QSize(m_preview->width(), m_preview->height()));
 177             job->setScaleType(KIO::PreviewJob::Unscaled);
 178
 179             connect(job, SIGNAL(gotPreview(const KFileItem&, const QPixmap&)),
 180                     this, SLOT(showPreview(const KFileItem&, const QPixmap&)));
 181             connect(job, SIGNAL(failed(const KFileItem&)),
 182                     this, SLOT(showIcon(const KFileItem&)));
 183         }
 184     }
 185
 186     if (m_metaDataWidget) {
 187         m_metaDataWidget->show();
 188         m_metaDataWidget->setItems(KFileItemList() << item);
 189     }
 190
 191     if (InformationPanelSettings::showPreview()) {
 192         const QString mimeType = item.mimetype();
 193         const bool usePhonon = Phonon::BackendCapabilities::isMimeTypeAvailable(mimeType) &&
 194                                (mimeType != "image/png");  // TODO: workaround, as Phonon
 195                                                            // thinks it supports PNG images
 196         if (usePhonon) {
 197             m_phononWidget->show();
 198             PhononWidget::Mode mode = mimeType.startsWith(QLatin1String("video"))
 199                                       ? PhononWidget::Video
 200                                       : PhononWidget::Audio;
 201             m_phononWidget->setMode(mode);
 202             m_phononWidget->setUrl(item.targetUrl());
 203             if ((mode == PhononWidget::Video) && m_preview->isVisible()) {
 204                 m_phononWidget->setVideoSize(m_preview->size());
 205             }
 206         } else {
 207             m_phononWidget->hide();
 208             m_preview->setVisible(true);
 209         }
 210     } else {
 211         m_phononWidget->hide();
 212     }
 213
 214     m_item = item;
 215 }
 216
 217 void InformationPanelContent::showItems(const KFileItemList& items)
 218 {
 219     m_pendingPreview = false;
 220
 221     KIconLoader iconLoader;
 222     QPixmap icon = iconLoader.loadIcon("dialog-information",
 223                                        KIconLoader::NoGroup,
 224                                        KIconLoader::SizeEnormous);
 225     m_preview->setPixmap(icon);
 226     setNameLabelText(i18ncp("@info", "%1 item selected", "%1 items selected", items.count()));
 227
 228     if (m_metaDataWidget) {
 229         m_metaDataWidget->setItems(items);
 230     }
 231
 232     m_phononWidget->hide();
 233
 234     m_item = KFileItem();
 235 }
 236
 237 bool InformationPanelContent::eventFilter(QObject* obj, QEvent* event)
 238 {
 239     switch (event->type()) {
 240     case QEvent::Resize: {
 241         QResizeEvent* resizeEvent = static_cast<QResizeEvent*>(event);
 242         if (obj == m_metaDataArea->viewport()) {
 243             // The size of the meta text area has changed. Adjust the fixed
 244             // width in a way that no horizontal scrollbar needs to be shown.
 245             m_metaDataWidget->setFixedWidth(resizeEvent->size().width());
 246         } else if (obj == parent()) {
 247             adjustWidgetSizes(resizeEvent->size().width());
 248         }
 249         break;
 250     }
 251
 252     case QEvent::Polish:
 253         adjustWidgetSizes(parentWidget()->width());
 254         break;
 255
 256     default:
 257         break;
 258     }
 259
 260     return QWidget::eventFilter(obj, event);
 261 }
 262
 263 void InformationPanelContent::configureSettings(const QList<QAction*>& customContextMenuActions)
 264 {
 265     KMenu popup(this);
 266
 267     QAction* previewAction = popup.addAction(i18nc("@action:inmenu", "Preview"));
 268     previewAction->setIcon(KIcon("view-preview"));
 269     previewAction->setCheckable(true);
 270     previewAction->setChecked(InformationPanelSettings::showPreview());
 271
 272     QAction* configureAction = popup.addAction(i18nc("@action:inmenu", "Configure..."));
 273     configureAction->setIcon(KIcon("configure"));
 274
 275     popup.addSeparator();
 276     foreach (QAction* action, customContextMenuActions) {
 277         popup.addAction(action);
 278     }
 279
 280     // Open the popup and adjust the settings for the
 281     // selected action.
 282     QAction* action = popup.exec(QCursor::pos());
 283     if (!action) {
 284         return;
 285     }
 286
 287     const bool isChecked = action->isChecked();
 288     if (action == previewAction) {
 289         m_preview->setVisible(isChecked);
 290         InformationPanelSettings::setShowPreview(isChecked);
 291     } else if (action == configureAction) {
 292         FileMetaDataConfigurationDialog* dialog = new FileMetaDataConfigurationDialog();
 293         dialog->setDescription(i18nc("@label::textbox",
 294                                      "Select which data should be shown in the information panel:"));
 295         dialog->setItems(m_metaDataWidget->items());
 296         dialog->setAttribute(Qt::WA_DeleteOnClose);
 297         dialog->show();
 298         dialog->raise();
 299         dialog->activateWindow();
 300         connect(dialog, SIGNAL(destroyed()), this, SLOT(refreshMetaData()));
 301     }
 302 }
 303
 304 void InformationPanelContent::showIcon(const KFileItem& item)
 305 {
 306     m_outdatedPreviewTimer->stop();
 307     m_pendingPreview = false;
 308     if (!applyPlace(item.targetUrl())) {
 309         KIcon icon(item.iconName(), KIconLoader::global(), item.overlays());
 310         m_preview->setPixmap(icon.pixmap(KIconLoader::SizeEnormous));
 311     }
 312 }
 313
 314 void InformationPanelContent::showPreview(const KFileItem& item,
 315                                           const QPixmap& pixmap)
 316 {
 317     m_outdatedPreviewTimer->stop();
 318     Q_UNUSED(item);
 319     if (m_pendingPreview) {
 320         QPixmap p = pixmap;
 321         KIconLoader::global()->drawOverlays(item.overlays(), p, KIconLoader::Desktop);
 322         m_preview->setPixmap(p);
 323         m_pendingPreview = false;
 324     }
 325 }
 326
 327 void InformationPanelContent::markOutdatedPreview()
 328 {
 329     KIconEffect *iconEffect = KIconLoader::global()->iconEffect();
 330     QPixmap disabledPixmap = iconEffect->apply(m_preview->pixmap(),
 331                                                KIconLoader::Desktop,
 332                                                KIconLoader::DisabledState);
 333     m_preview->setPixmap(disabledPixmap);
 334 }
 335
 336 void InformationPanelContent::slotPlayingStarted()
 337 {
 338     m_preview->setVisible(m_phononWidget->mode() != PhononWidget::Video);
 339 }
 340
 341 void InformationPanelContent::slotPlayingStopped()
 342 {
 343     m_preview->setVisible(true);
 344 }
 345
 346 void InformationPanelContent::refreshMetaData()
 347 {
 348     if (!m_item.isNull() && m_item.nepomukUri().isValid()) {
 349         showItem(m_item);
 350     }
 351 }
 352
 353 bool InformationPanelContent::applyPlace(const KUrl& url)
 354 {
 355     KFilePlacesModel* placesModel = DolphinSettings::instance().placesModel();
 356     int count = placesModel->rowCount();
 357
 358     for (int i = 0; i < count; ++i) {
 359         QModelIndex index = placesModel->index(i, 0);
 360
 361         if (url.equals(placesModel->url(index), KUrl::CompareWithoutTrailingSlash)) {
 362             setNameLabelText(placesModel->text(index));
 363             m_preview->setPixmap(placesModel->icon(index).pixmap(128, 128));
 364             return true;
 365         }
 366     }
 367
 368     return false;
 369 }
 370
 371 void InformationPanelContent::setNameLabelText(const QString& text)
 372 {
 373     QTextOption textOption;
 374     textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
 375
 376     const QString processedText = Qt::mightBeRichText(text) ? text : KStringHandler::preProcessWrap(text);
 377
 378     QTextLayout textLayout(processedText);
 379     textLayout.setFont(m_nameLabel->font());
 380     textLayout.setTextOption(textOption);
 381
 382     QString wrappedText;
 383     wrappedText.reserve(processedText.length());
 384
 385     // wrap the text to fit into the width of m_nameLabel
 386     textLayout.beginLayout();
 387     QTextLine line = textLayout.createLine();
 388     while (line.isValid()) {
 389         line.setLineWidth(m_nameLabel->width());
 390         wrappedText += processedText.mid(line.textStart(), line.textLength());
 391
 392         line = textLayout.createLine();
 393         if (line.isValid()) {
 394             wrappedText += QChar::LineSeparator;
 395         }
 396     }
 397     textLayout.endLayout();
 398
 399     m_nameLabel->setText(wrappedText);
 400 }
 401
 402 void InformationPanelContent::adjustWidgetSizes(int width)
 403 {
 404     // If the text inside the name label or the info label cannot
 405     // get wrapped, then the maximum width of the label is increased
 406     // so that the width of the information panel gets increased.
 407     // To prevent this, the maximum width is adjusted to
 408     // the current width of the panel.
 409     const int maxWidth = width - KDialog::spacingHint() * 4;
 410     m_nameLabel->setMaximumWidth(maxWidth);
 411
 412     // The metadata widget also contains a text widget which may return
 413     // a large preferred width.
 414     if (m_metaDataWidget) {
 415         m_metaDataWidget->setMaximumWidth(maxWidth);
 416     }
 417
 418     // try to increase the preview as large as possible
 419     m_preview->setSizeHint(QSize(maxWidth, maxWidth));
 420
 421     if (m_phononWidget->isVisible() && (m_phononWidget->mode() == PhononWidget::Video)) {
 422         // assure that the size of the video player is the same as the preview size
 423         m_phononWidget->setVideoSize(QSize(maxWidth, maxWidth));
 424     }
 425 }
 426
 427 #include "informationpanelcontent.moc"