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 {
 152     // If there is a preview job, kill it to prevent that we have jobs for
 153     // multiple items running, and thus a race condition (bug 250787).
 154     if (m_previewJob) {
 155         m_previewJob->kill();
 156     }
 157
 158     setNameLabelText(m_item.text());
 159     if (InformationPanelSettings::previewsShown()) {
 160         m_preview->show();
 161
 162         const QUrl itemUrl = m_item.url();
 163         const bool isSearchUrl = itemUrl.scheme().contains(QStringLiteral("search")) && m_item.localPath().isEmpty();
 164         if (isSearchUrl) {
 165             // in the case of a search-URL the URL is not readable for humans
 166             // (at least not useful to show in the Information Panel)
 167             m_preview->setPixmap(
 168                 QIcon::fromTheme(QStringLiteral("nepomuk")).pixmap(KIconLoader::SizeEnormous, KIconLoader::SizeEnormous)
 169             );
 170         } else {
 171             // try to get a preview pixmap from the item...
 172
 173             // Mark the currently shown preview as outdated. This is done
 174             // with a small delay to prevent a flickering when the next preview
 175             // can be shown within a short timeframe. This timer is not started
 176             // for directories, as directory previews might fail and return the
 177             // same icon.
 178             if (!m_item.isDir()) {
 179                 m_outdatedPreviewTimer->start();
 180             }
 181
 182             QStringList plugins = KIO::PreviewJob::availablePlugins();
 183             m_previewJob = new KIO::PreviewJob(KFileItemList() << m_item,
 184                                                QSize(m_preview->width(), m_preview->height()),
 185                                                &plugins);
 186             m_previewJob->setScaleType(KIO::PreviewJob::Unscaled);
 187             m_previewJob->setIgnoreMaximumSize(m_item.isLocalFile());
 188             if (m_previewJob->uiDelegate()) {
 189                 KJobWidgets::setWindow(m_previewJob, this);
 190             }
 191
 192             connect(m_previewJob.data(), &KIO::PreviewJob::gotPreview,
 193                     this, &InformationPanelContent::showPreview);
 194             connect(m_previewJob.data(), &KIO::PreviewJob::failed,
 195                     this, &InformationPanelContent::showIcon);
 196
 197             const QString mimeType = m_item.mimetype();
 198             const bool usePhonon = mimeType.startsWith(QLatin1String("audio/")) || mimeType.startsWith(QLatin1String("video/"));
 199             if (usePhonon) {
 200                 m_phononWidget->show();
 201                 m_phononWidget->setUrl(m_item.targetUrl());
 202                 m_phononWidget->setVideoSize(m_preview->size());
 203             } else {
 204                 m_phononWidget->hide();
 205             }
 206         }
 207     } else {
 208         m_preview->hide();
 209         m_phononWidget->hide();
 210     }
 211 }
 212
 213 void InformationPanelContent::refreshMetaData()
 214 {
 215     m_metaDataWidget->setDateFormat(static_cast<Baloo::DateFormats>(InformationPanelSettings::dateFormat()));
 216     m_metaDataWidget->show();
 217     m_metaDataWidget->setItems(KFileItemList() << m_item);
 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     m_metaDataWidget->setItems(items);
 234
 235     m_phononWidget->hide();
 236
 237     m_item = KFileItem();
 238 }
 239
 240 bool InformationPanelContent::eventFilter(QObject* obj, QEvent* event)
 241 {
 242     switch (event->type()) {
 243     case QEvent::Resize: {
 244         QResizeEvent* resizeEvent = static_cast<QResizeEvent*>(event);
 245         if (obj == m_metaDataArea->viewport()) {
 246             // The size of the meta text area has changed. Adjust the fixed
 247             // width in a way that no horizontal scrollbar needs to be shown.
 248             m_metaDataWidget->setFixedWidth(resizeEvent->size().width());
 249         } else if (obj == parent()) {
 250             adjustWidgetSizes(resizeEvent->size().width());
 251         }
 252         break;
 253     }
 254
 255     case QEvent::Polish:
 256         adjustWidgetSizes(parentWidget()->width());
 257         break;
 258
 259     case QEvent::FontChange:
 260         m_metaDataWidget->setFont(QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont));
 261         break;
 262
 263     default:
 264         break;
 265     }
 266
 267     return QWidget::eventFilter(obj, event);
 268 }
 269
 270 void InformationPanelContent::showIcon(const KFileItem& item)
 271 {
 272     m_outdatedPreviewTimer->stop();
 273     QPixmap pixmap = QIcon::fromTheme(item.iconName()).pixmap(KIconLoader::SizeEnormous, KIconLoader::SizeEnormous);
 274     KIconLoader::global()->drawOverlays(item.overlays(), pixmap, KIconLoader::Desktop);
 275     m_preview->setPixmap(pixmap);
 276 }
 277
 278 void InformationPanelContent::showPreview(const KFileItem& item,
 279                                           const QPixmap& pixmap)
 280 {
 281     m_outdatedPreviewTimer->stop();
 282     Q_UNUSED(item);
 283
 284     QPixmap p = pixmap;
 285     KIconLoader::global()->drawOverlays(item.overlays(), p, KIconLoader::Desktop);
 286     m_preview->setPixmap(p);
 287 }
 288
 289 void InformationPanelContent::markOutdatedPreview()
 290 {
 291     KIconEffect *iconEffect = KIconLoader::global()->iconEffect();
 292     QPixmap disabledPixmap = iconEffect->apply(m_preview->pixmap(),
 293                                                KIconLoader::Desktop,
 294                                                KIconLoader::DisabledState);
 295     m_preview->setPixmap(disabledPixmap);
 296 }
 297
 298 KFileItemList InformationPanelContent::items()
 299 {
 300     return m_metaDataWidget->items();
 301 }
 302
 303 void InformationPanelContent::slotHasVideoChanged(bool hasVideo)
 304 {
 305     m_preview->setVisible(InformationPanelSettings::previewsShown() && !hasVideo);
 306 }
 307
 308 void InformationPanelContent::setNameLabelText(const QString& text)
 309 {
 310     QTextOption textOption;
 311     textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
 312
 313     const QString processedText = Qt::mightBeRichText(text) ? text : KStringHandler::preProcessWrap(text);
 314
 315     QTextLayout textLayout(processedText);
 316     textLayout.setFont(m_nameLabel->font());
 317     textLayout.setTextOption(textOption);
 318
 319     QString wrappedText;
 320     wrappedText.reserve(processedText.length());
 321
 322     // wrap the text to fit into the width of m_nameLabel
 323     textLayout.beginLayout();
 324     QTextLine line = textLayout.createLine();
 325     while (line.isValid()) {
 326         line.setLineWidth(m_nameLabel->width());
 327         wrappedText += processedText.midRef(line.textStart(), line.textLength());
 328
 329         line = textLayout.createLine();
 330         if (line.isValid()) {
 331             wrappedText += QChar::LineSeparator;
 332         }
 333     }
 334     textLayout.endLayout();
 335
 336     m_nameLabel->setText(wrappedText);
 337 }
 338
 339 void InformationPanelContent::adjustWidgetSizes(int width)
 340 {
 341     // If the text inside the name label or the info label cannot
 342     // get wrapped, then the maximum width of the label is increased
 343     // so that the width of the information panel gets increased.
 344     // To prevent this, the maximum width is adjusted to
 345     // the current width of the panel.
 346     const int maxWidth = width - style()->layoutSpacing(QSizePolicy::DefaultType, QSizePolicy::DefaultType, Qt::Horizontal) * 4;
 347     m_nameLabel->setMaximumWidth(maxWidth);
 348
 349     // The metadata widget also contains a text widget which may return
 350     // a large preferred width.
 351     m_metaDataWidget->setMaximumWidth(maxWidth);
 352
 353     // try to increase the preview as large as possible
 354     m_preview->setSizeHint(QSize(maxWidth, maxWidth));
 355
 356     if (m_phononWidget->isVisible()) {
 357         // assure that the size of the video player is the same as the preview size
 358         m_phononWidget->setVideoSize(QSize(maxWidth, maxWidth));
 359     }
 360 }
 361