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 <KIO/JobUiDelegate>
  23 #include <KIO/PreviewJob>
  24 #include <KIconEffect>
  25 #include <KIconLoader>
  26 #include <KJobWidgets>
  27 #include <KLocalizedString>
  28 #include <KSeparator>
  29 #include <KStringHandler>
  30
  31 #include <QIcon>
  32 #include <QTextDocument>
  33
  34 #include <Baloo/FileMetaDataWidget>
  35
  36 #include <panels/places/placesitem.h>
  37 #include <panels/places/placesitemmodel.h>
  38
  39 #include <Phonon/BackendCapabilities>
  40 #include <Phonon/MediaObject>
  41
  42 #include <QLabel>
  43 #include <QScrollArea>
  44 #include <QTextLayout>
  45 #include <QTimer>
  46 #include <QVBoxLayout>
  47 #include <QStyle>
  48
  49 #include "dolphin_informationpanelsettings.h"
  50 #include "phononwidget.h"
  51 #include "pixmapviewer.h"
  52
  53 InformationPanelContent::InformationPanelContent(QWidget* parent) :
  54     QWidget(parent),
  55     m_item(),
  56     m_previewJob(nullptr),
  57     m_outdatedPreviewTimer(nullptr),
  58     m_preview(nullptr),
  59     m_phononWidget(nullptr),
  60     m_nameLabel(nullptr),
  61     m_metaDataWidget(nullptr),
  62     m_metaDataArea(nullptr),
  63     m_placesItemModel(nullptr)
  64 {
  65     parent->installEventFilter(this);
  66
  67     // Initialize timer for disabling an outdated preview with a small
  68     // delay. This prevents flickering if the new preview can be generated
  69     // within a very small timeframe.
  70     m_outdatedPreviewTimer = new QTimer(this);
  71     m_outdatedPreviewTimer->setInterval(300);
  72     m_outdatedPreviewTimer->setSingleShot(true);
  73     connect(m_outdatedPreviewTimer, &QTimer::timeout,
  74             this, &InformationPanelContent::markOutdatedPreview);
  75
  76     QVBoxLayout* layout = new QVBoxLayout(this);
  77
  78     // preview
  79     const int minPreviewWidth = KIconLoader::SizeEnormous + KIconLoader::SizeMedium;
  80
  81     m_preview = new PixmapViewer(parent);
  82     m_preview->setMinimumWidth(minPreviewWidth);
  83     m_preview->setMinimumHeight(KIconLoader::SizeEnormous);
  84
  85     m_phononWidget = new PhononWidget(parent);
  86     m_phononWidget->hide();
  87     m_phononWidget->setMinimumWidth(minPreviewWidth);
  88     connect(m_phononWidget, &PhononWidget::hasVideoChanged,
  89             this, &InformationPanelContent::slotHasVideoChanged);
  90
  91     // name
  92     m_nameLabel = new QLabel(parent);
  93     QFont font = m_nameLabel->font();
  94     font.setBold(true);
  95     m_nameLabel->setFont(font);
  96     m_nameLabel->setTextFormat(Qt::PlainText);
  97     m_nameLabel->setAlignment(Qt::AlignHCenter);
  98     m_nameLabel->setSizePolicy(QSizePolicy::Ignored, QSizePolicy::Fixed);
  99
 100     const bool previewsShown = InformationPanelSettings::previewsShown();
 101     m_preview->setVisible(previewsShown);
 102
 103     m_metaDataWidget = new Baloo::FileMetaDataWidget(parent);
 104     m_metaDataWidget->setDateFormat(static_cast<Baloo::DateFormats>(InformationPanelSettings::dateFormat()));
 105     connect(m_metaDataWidget, &Baloo::FileMetaDataWidget::urlActivated,
 106             this, &InformationPanelContent::urlActivated);
 107     m_metaDataWidget->setFont(QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont));
 108     m_metaDataWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Minimum);
 109
 110     // Encapsulate the MetaDataWidget inside a container that has a dummy widget
 111     // at the bottom. This prevents that the meta data widget gets vertically stretched
 112     // in the case where the height of m_metaDataArea > m_metaDataWidget.
 113     QWidget* metaDataWidgetContainer = new QWidget(parent);
 114     QVBoxLayout* containerLayout = new QVBoxLayout(metaDataWidgetContainer);
 115     containerLayout->setContentsMargins(0, 0, 0, 0);
 116     containerLayout->setSpacing(0);
 117     containerLayout->addWidget(m_metaDataWidget);
 118     containerLayout->addStretch();
 119
 120     m_metaDataArea = new QScrollArea(parent);
 121     m_metaDataArea->setWidget(metaDataWidgetContainer);
 122     m_metaDataArea->setWidgetResizable(true);
 123     m_metaDataArea->setFrameShape(QFrame::NoFrame);
 124
 125     QWidget* viewport = m_metaDataArea->viewport();
 126     viewport->installEventFilter(this);
 127
 128     layout->addWidget(m_preview);
 129     layout->addWidget(m_phononWidget);
 130     layout->addWidget(m_nameLabel);
 131     layout->addWidget(new KSeparator());
 132     layout->addWidget(m_metaDataArea);
 133
 134     m_placesItemModel = new PlacesItemModel(this);
 135 }
 136
 137 InformationPanelContent::~InformationPanelContent()
 138 {
 139     InformationPanelSettings::self()->save();
 140 }
 141
 142 void InformationPanelContent::showItem(const KFileItem& item)
 143 {
 144     m_item = item;
 145
 146     refreshPreview();
 147     refreshMetaData();
 148 }
 149
 150 void InformationPanelContent::refreshPreview() {
 151     // If there is a preview job, kill it to prevent that we have jobs for
 152     // multiple items running, and thus a race condition (bug 250787).
 153     if (m_previewJob) {
 154         m_previewJob->kill();
 155     }
 156
 157     setNameLabelText(m_item.text());
 158     if (InformationPanelSettings::previewsShown()) {
 159         m_preview->show();
 160
 161         const QUrl itemUrl = m_item.url();
 162         const bool isSearchUrl = itemUrl.scheme().contains(QStringLiteral("search")) && m_item.localPath().isEmpty();
 163         if (isSearchUrl) {
 164             // in the case of a search-URL the URL is not readable for humans
 165             // (at least not useful to show in the Information Panel)
 166             m_preview->setPixmap(
 167                 QIcon::fromTheme(QStringLiteral("nepomuk")).pixmap(KIconLoader::SizeEnormous, KIconLoader::SizeEnormous)
 168             );
 169         } else {
 170             // try to get a preview pixmap from the item...
 171
 172             // Mark the currently shown preview as outdated. This is done
 173             // with a small delay to prevent a flickering when the next preview
 174             // can be shown within a short timeframe. This timer is not started
 175             // for directories, as directory previews might fail and return the
 176             // same icon.
 177             if (!m_item.isDir()) {
 178                 m_outdatedPreviewTimer->start();
 179             }
 180
 181             QStringList plugins = KIO::PreviewJob::availablePlugins();
 182             m_previewJob = new KIO::PreviewJob(KFileItemList() << m_item,
 183                                                QSize(m_preview->width(), m_preview->height()),
 184                                                &plugins);
 185             m_previewJob->setScaleType(KIO::PreviewJob::Unscaled);
 186             m_previewJob->setIgnoreMaximumSize(m_item.isLocalFile());
 187             if (m_previewJob->uiDelegate()) {
 188                 KJobWidgets::setWindow(m_previewJob, this);
 189             }
 190
 191             connect(m_previewJob.data(), &KIO::PreviewJob::gotPreview,
 192                     this, &InformationPanelContent::showPreview);
 193             connect(m_previewJob.data(), &KIO::PreviewJob::failed,
 194                     this, &InformationPanelContent::showIcon);
 195
 196             const QString mimeType = m_item.mimetype();
 197             const bool usePhonon = mimeType.startsWith(QLatin1String("audio/")) || mimeType.startsWith(QLatin1String("video/"));
 198             if (usePhonon) {
 199                 m_phononWidget->show();
 200                 m_phononWidget->setUrl(m_item.targetUrl());
 201                 m_phononWidget->setVideoSize(m_preview->size());
 202             } else {
 203                 m_phononWidget->hide();
 204             }
 205         }
 206     } else {
 207         m_preview->hide();
 208         m_phononWidget->hide();
 209     }
 210 }
 211
 212 void InformationPanelContent::refreshMetaData() {
 213     if (m_metaDataWidget) {
 214         m_metaDataWidget->setDateFormat(static_cast<Baloo::DateFormats>(InformationPanelSettings::dateFormat()));
 215         m_metaDataWidget->show();
 216         m_metaDataWidget->setItems(KFileItemList() << m_item);
 217     }
 218 }
 219
 220 void InformationPanelContent::showItems(const KFileItemList& items)
 221 {
 222     // If there is a preview job, kill it to prevent that we have jobs for
 223     // multiple items running, and thus a race condition (bug 250787).
 224     if (m_previewJob) {
 225         m_previewJob->kill();
 226     }
 227
 228     m_preview->setPixmap(
 229         QIcon::fromTheme(QStringLiteral("dialog-information")).pixmap(KIconLoader::SizeEnormous, KIconLoader::SizeEnormous)
 230     );
 231     setNameLabelText(i18ncp("@label", "%1 item selected", "%1 items selected", items.count()));
 232
 233     if (m_metaDataWidget) {
 234         m_metaDataWidget->setItems(items);
 235     }
 236
 237     m_phononWidget->hide();
 238
 239     m_item = KFileItem();
 240 }
 241
 242 bool InformationPanelContent::eventFilter(QObject* obj, QEvent* event)
 243 {
 244     switch (event->type()) {
 245     case QEvent::Resize: {
 246         QResizeEvent* resizeEvent = static_cast<QResizeEvent*>(event);
 247         if (obj == m_metaDataArea->viewport()) {
 248             // The size of the meta text area has changed. Adjust the fixed
 249             // width in a way that no horizontal scrollbar needs to be shown.
 250             m_metaDataWidget->setFixedWidth(resizeEvent->size().width());
 251         } else if (obj == parent()) {
 252             adjustWidgetSizes(resizeEvent->size().width());
 253         }
 254         break;
 255     }
 256
 257     case QEvent::Polish:
 258         adjustWidgetSizes(parentWidget()->width());
 259         break;
 260
 261     case QEvent::FontChange:
 262         m_metaDataWidget->setFont(QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont));
 263         break;
 264
 265     default:
 266         break;
 267     }
 268
 269     return QWidget::eventFilter(obj, event);
 270 }
 271
 272 void InformationPanelContent::showIcon(const KFileItem& item)
 273 {
 274     m_outdatedPreviewTimer->stop();
 275     QPixmap pixmap = QIcon::fromTheme(item.iconName()).pixmap(KIconLoader::SizeEnormous, KIconLoader::SizeEnormous);
 276     KIconLoader::global()->drawOverlays(item.overlays(), pixmap, KIconLoader::Desktop);
 277     m_preview->setPixmap(pixmap);
 278 }
 279
 280 void InformationPanelContent::showPreview(const KFileItem& item,
 281                                           const QPixmap& pixmap)
 282 {
 283     m_outdatedPreviewTimer->stop();
 284     Q_UNUSED(item);
 285
 286     QPixmap p = pixmap;
 287     KIconLoader::global()->drawOverlays(item.overlays(), p, KIconLoader::Desktop);
 288     m_preview->setPixmap(p);
 289 }
 290
 291 void InformationPanelContent::markOutdatedPreview()
 292 {
 293     KIconEffect *iconEffect = KIconLoader::global()->iconEffect();
 294     QPixmap disabledPixmap = iconEffect->apply(m_preview->pixmap(),
 295                                                KIconLoader::Desktop,
 296                                                KIconLoader::DisabledState);
 297     m_preview->setPixmap(disabledPixmap);
 298 }
 299
 300 KFileItemList InformationPanelContent::items() {
 301     return m_metaDataWidget->items();
 302 }
 303
 304 void InformationPanelContent::slotHasVideoChanged(bool hasVideo)
 305 {
 306     m_preview->setVisible(InformationPanelSettings::previewsShown() && !hasVideo);
 307 }
 308
 309 void InformationPanelContent::setNameLabelText(const QString& text)
 310 {
 311     QTextOption textOption;
 312     textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
 313
 314     const QString processedText = Qt::mightBeRichText(text) ? text : KStringHandler::preProcessWrap(text);
 315
 316     QTextLayout textLayout(processedText);
 317     textLayout.setFont(m_nameLabel->font());
 318     textLayout.setTextOption(textOption);
 319
 320     QString wrappedText;
 321     wrappedText.reserve(processedText.length());
 322
 323     // wrap the text to fit into the width of m_nameLabel
 324     textLayout.beginLayout();
 325     QTextLine line = textLayout.createLine();
 326     while (line.isValid()) {
 327         line.setLineWidth(m_nameLabel->width());
 328         wrappedText += processedText.midRef(line.textStart(), line.textLength());
 329
 330         line = textLayout.createLine();
 331         if (line.isValid()) {
 332             wrappedText += QChar::LineSeparator;
 333         }
 334     }
 335     textLayout.endLayout();
 336
 337     m_nameLabel->setText(wrappedText);
 338 }
 339
 340 void InformationPanelContent::adjustWidgetSizes(int width)
 341 {
 342     // If the text inside the name label or the info label cannot
 343     // get wrapped, then the maximum width of the label is increased
 344     // so that the width of the information panel gets increased.
 345     // To prevent this, the maximum width is adjusted to
 346     // the current width of the panel.
 347     const int maxWidth = width - style()->layoutSpacing(QSizePolicy::DefaultType, QSizePolicy::DefaultType, Qt::Horizontal) * 4;
 348     m_nameLabel->setMaximumWidth(maxWidth);
 349
 350     // The metadata widget also contains a text widget which may return
 351     // a large preferred width.
 352     if (m_metaDataWidget) {
 353         m_metaDataWidget->setMaximumWidth(maxWidth);
 354     }
 355
 356     // try to increase the preview as large as possible
 357     m_preview->setSizeHint(QSize(maxWidth, maxWidth));
 358
 359     if (m_phononWidget->isVisible()) {
 360         // assure that the size of the video player is the same as the preview size
 361         m_phononWidget->setVideoSize(QSize(maxWidth, maxWidth));
 362     }
 363 }
 364