File indexing completed on 2024-04-28 04:21:26

 // SPDX-FileCopyrightText: 2003-2020 The KPhotoAlbum Development Team
 // SPDX-FileCopyrightText: 2021-2022 Johannes Zarl-Zierl <johannes@zarl-zierl.at>
 //
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #include "InfoBox.h"
 
 // Local includes
 #include <Browser/BrowserWidget.h>
 #include <DB/ImageDB.h>
 #include <DB/ImageInfo.h>
 #include <MainWindow/Window.h>
 #ifdef HAVE_MARBLE
 #include <Map/MapView.h>
 #endif
 #include "VisibleOptionsMenu.h"
 
 #include <KActionCollection>
 #include <KLocalizedString>
 #include <KRatingWidget>
 #include <QApplication>
 #include <QBitmap>
 #include <QDebug>
 #include <QDesktopWidget>
 #include <QMouseEvent>
 #include <QScrollBar>
 #include <QToolButton>
 
 using namespace Settings;
 
 Viewer::InfoBox::InfoBox(Viewer::ViewerWidget *viewer)
     : QTextBrowser(viewer)
     , m_viewer(viewer)
     , m_hoveringOverLink(false)
     , m_infoBoxResizer(this)
     , m_menu(nullptr)
 #ifdef HAVE_MARBLE
     , m_map(nullptr)
 #endif
 {
     setFrameStyle(Box | Plain);
     setLineWidth(1);
     setMidLineWidth(0);
     setAutoFillBackground(false);
 
     updatePalette();
 
     m_jumpToContext = new QToolButton(this);
     m_jumpToContext->setIcon(QIcon::fromTheme(QString::fromUtf8("kphotoalbum")));
     m_jumpToContext->setFixedSize(16, 16);
     connect(m_jumpToContext, &QToolButton::clicked, this, &InfoBox::jumpToContext);
     // TODO(jzarl): remove QOverload once we don't care about Debian 11 anymore:
     connect(this, QOverload<const QUrl &>::of(&QTextBrowser::highlighted), this, &InfoBox::linkHovered);
 
 #ifdef HAVE_MARBLE
     m_showOnMap = new QToolButton(this);
     m_showOnMap->setIcon(QIcon::fromTheme(QString::fromUtf8("atmosphere")));
     m_showOnMap->setFixedSize(16, 16);
     m_showOnMap->setCursor(Qt::ArrowCursor);
     m_showOnMap->setToolTip(i18n("Show the geographic position of this image on a map"));
     connect(m_showOnMap, &QToolButton::clicked, this, &InfoBox::launchMapView);
     m_showOnMap->hide();
 
     connect(m_viewer, &ViewerWidget::soughtTo, this, &InfoBox::updateMapForCurrentImage);
 #endif
 
     KRatingWidget *rating = new KRatingWidget;
 
     // Unfortunately, the KRatingWidget now thinks that it has some absurdly big
     // dimensions. This call will persuade it to stay reasonably small.
     rating->adjustSize();
 
     for (int i = 0; i <= 10; ++i) {
         rating->setRating(i);
         // QWidget::grab() does not create an alpha channel
         // Therefore, we need to create a mask using heuristics (yes, this is slow, but we only do it once)
         QPixmap pixmap = rating->grab();
         pixmap.setMask(pixmap.createHeuristicMask());
         m_ratingPixmap.append(pixmap);
     }
 
     delete rating;
 }
 
 QVariant Viewer::InfoBox::loadResource(int type, const QUrl &name)
 {
     if (name.scheme() == QString::fromUtf8("kratingwidget")) {
         int rating = name.port();
         Q_ASSERT(0 <= rating && rating <= 10);
         return m_ratingPixmap[rating];
     }
     return QTextBrowser::loadResource(type, name);
 }
 
 void Viewer::InfoBox::setSource(const QUrl &source)
 {
     int index = source.path().toInt();
     QPair<QString, QString> p = m_linkMap[index];
     QString category = p.first;
     QString value = p.second;
     Browser::BrowserWidget::instance()->load(category, value);
     showBrowser();
 }
 
 void Viewer::InfoBox::setInfo(const QString &text, const QMap<int, QPair<QString, QString>> &linkMap)
 {
     m_linkMap = linkMap;
     setText(text);
 
     hackLinkColorForQt52();
 
 #ifdef HAVE_MARBLE
     if (m_viewer->currentInfo()->coordinates().hasCoordinates()) {
         m_showOnMap->show();
     } else {
         m_showOnMap->hide();
     }
 #endif
 
     setSize();
 }
 
 void Viewer::InfoBox::setSize()
 {
     const int maxWidth = Settings::SettingsData::instance()->infoBoxWidth();
     const int maxHeight = Settings::SettingsData::instance()->infoBoxHeight();
 
     document()->setPageSize(QSize(maxWidth, maxHeight));
     bool showVerticalBar = document()->size().height() > maxHeight;
 
     setVerticalScrollBarPolicy(showVerticalBar ? Qt::ScrollBarAlwaysOn : Qt::ScrollBarAlwaysOff);
     setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
     const int realWidth = static_cast<int>(document()->idealWidth())
         + (showVerticalBar ? verticalScrollBar()->width() + frameWidth() : 0)
         + m_jumpToContext->width() + 10;
 
     resize(realWidth, qMin((int)document()->size().height(), maxHeight));
 }
 
 bool Viewer::InfoBox::event(QEvent *e)
 {
     if (e->type() == QEvent::PaletteChange)
         updatePalette();
     return QTextBrowser::event(e);
 }
 
 void Viewer::InfoBox::mousePressEvent(QMouseEvent *event)
 {
     if (event->button() == Qt::LeftButton) {
         possiblyStartResize(event->pos());
     }
     QTextBrowser::mousePressEvent(event);
 }
 
 void Viewer::InfoBox::mouseReleaseEvent(QMouseEvent *event)
 {
     if (m_infoBoxResizer.isActive()) {
         Settings::SettingsData::instance()->setInfoBoxWidth(width());
         Settings::SettingsData::instance()->setInfoBoxHeight(height());
     }
 
     m_infoBoxResizer.deactivate();
     QTextBrowser::mouseReleaseEvent(event);
 }
 
 void Viewer::InfoBox::mouseMoveEvent(QMouseEvent *event)
 {
     if (event->buttons() & Qt::LeftButton) {
         if (m_infoBoxResizer.isActive()) {
             m_infoBoxResizer.setPos(event->pos());
         } else {
             m_viewer->infoBoxMove();
         }
         // Do not tell QTextBrowser about the mouse movement, as this will just start a selection.
     } else {
         updateCursor(event->pos());
         QTextBrowser::mouseMoveEvent(event);
     }
 }
 
 void Viewer::InfoBox::linkHovered(const QUrl &link)
 {
     if (link.isEmpty()) {
         Q_EMIT noTagHovered();
     } else {
         Q_EMIT tagHovered(m_linkMap[link.path().toInt()]);
     }
 
     m_hoveringOverLink = !link.isEmpty();
 }
 
 void Viewer::InfoBox::jumpToContext()
 {
     Browser::BrowserWidget::instance()->addImageView(m_viewer->currentInfo()->fileName());
     showBrowser();
 }
 
 void Viewer::InfoBox::showBrowser()
 {
     QDesktopWidget *desktop = qApp->desktop();
     if (desktop->screenNumber(Browser::BrowserWidget::instance()) == desktop->screenNumber(m_viewer)) {
         if (m_viewer->showingFullScreen()) {
             m_viewer->setShowFullScreen(false);
         }
         MainWindow::Window::theMainWindow()->raise();
     }
 }
 
 /**
  * Update the cursor based on the cursors position in the info box
  */
 void Viewer::InfoBox::updateCursor(const QPoint &pos)
 {
     const int border = 25;
 
     bool left = (pos.x() < border);
     bool right = pos.x() > width() - border;
     bool top = pos.y() < border;
     bool bottom = pos.y() > height() - border;
 
     Settings::Position windowPos = Settings::SettingsData::instance()->infoBoxPosition();
 
     Qt::CursorShape shape = Qt::SizeAllCursor;
     if (m_hoveringOverLink) {
         shape = Qt::PointingHandCursor;
     } else if (atBlackoutPos(left, right, top, bottom, windowPos)) {
         shape = Qt::SizeAllCursor;
     } else if ((left && top) || (right && bottom)) {
         shape = Qt::SizeFDiagCursor;
     } else if ((left && bottom) || (right && top)) {
         shape = Qt::SizeBDiagCursor;
     } else if (top || bottom) {
         shape = Qt::SizeVerCursor;
     } else if (left || right) {
         shape = Qt::SizeHorCursor;
     }
 
     setCursor(shape);
     viewport()->setCursor(shape);
 }
 
 /**
  * Return true if we are at an edge of the image info box that is towards the edge of the viewer.
  * We can forexample not make the box taller at the bottom if the box is sitting at the bottom of the viewer.
  */
 bool Viewer::InfoBox::atBlackoutPos(bool left, bool right, bool top, bool bottom, Settings::Position pos) const
 {
     return (left && (pos == Left || pos == TopLeft || pos == BottomLeft))
         || (right && (pos == Right || pos == TopRight || pos == BottomRight))
         || (top && (pos == Top || pos == TopLeft || pos == TopRight))
         || (bottom && (pos == Bottom || pos == BottomLeft || pos == BottomRight));
 }
 
 void Viewer::InfoBox::possiblyStartResize(const QPoint &pos)
 {
     const int border = 25;
 
     bool left = (pos.x() < border);
     bool right = pos.x() > width() - border;
     bool top = pos.y() < border;
     bool bottom = pos.y() > height() - border;
 
     if (left || right || top || bottom) {
         m_infoBoxResizer.setup(left, right, top, bottom);
     }
 }
 
 void Viewer::InfoBox::resizeEvent(QResizeEvent *)
 {
     QPoint pos = viewport()->rect().adjusted(0, 2, -m_jumpToContext->width() - 2, 0).topRight();
     m_jumpToContext->move(pos);
 #ifdef HAVE_MARBLE
     pos.setY(pos.y() + 20);
     m_showOnMap->move(pos);
 #endif
 }
 
 /**
  * @brief override the color of links because the one in the palette isn't used.
  * As can be seen in the referenced links, QTextBrowser uses the global palette for setting the link color.
  * Until it uses the widget palette, we have to do this workaround.
  * @see https://bugreports.qt.io/browse/QTBUG-28998
  * @see https://codereview.qt-project.org/c/qt/qtbase/+/68874/2/src/gui/text/qtexthtmlparser.cpp
  */
 void Viewer::InfoBox::hackLinkColorForQt52()
 {
     QTextCursor cursor(document());
     QBrush linkColor = palette().link();
     Q_FOREVER
     {
         QTextCharFormat f = cursor.charFormat();
         if (f.isAnchor()) {
             f.setForeground(linkColor);
             QTextCursor c2 = cursor;
             c2.movePosition(QTextCursor::PreviousCharacter, QTextCursor::KeepAnchor);
             c2.setCharFormat(f);
         }
         if (cursor.atEnd()) {
             break;
         }
         cursor.movePosition(QTextCursor::NextCharacter);
     }
 }
 
 void Viewer::InfoBox::updatePalette()
 {
     QPalette p = palette();
     // we want a transparent background, not the default widget grey
     QColor bgColor = palette().shadow().color();
     bgColor.setAlpha(170);
     p.setColor(QPalette::Base, bgColor);
     // adapt other colors as necessary
     p.setColor(QPalette::WindowText, palette().brightText().color());
     p.setColor(QPalette::Text, palette().brightText().color());
     p.setColor(QPalette::Link, p.color(QPalette::Link).lighter());
     setPalette(p);
     // re-enable palette propagation:
     setAttribute(Qt::WA_SetPalette);
 }
 
 void Viewer::InfoBox::contextMenuEvent(QContextMenuEvent *event)
 {
     if (!m_menu) {
         m_menu = new VisibleOptionsMenu(m_viewer, new KActionCollection((QObject *)nullptr));
         connect(m_menu, &VisibleOptionsMenu::visibleOptionsChanged, m_viewer, &ViewerWidget::updateInfoBox);
     }
     m_menu->exec(event->globalPos());
 }
 
 #ifdef HAVE_MARBLE
 void Viewer::InfoBox::launchMapView()
 {
     if (!m_map) {
         m_map = new Map::MapView(m_viewer, Map::UsageType::MapViewWindow);
     }
 
     m_map->addImage(m_viewer->currentInfo());
     m_map->buildImageClusters();
     m_map->setShowThumbnails(false);
     m_map->zoomToMarkers();
     m_map->show();
     m_map->raise();
 }
 
 void Viewer::InfoBox::updateMapForCurrentImage(DB::FileName)
 {
     if (!m_map) {
         return;
     }
 
     if (m_viewer->currentInfo()->coordinates().hasCoordinates()) {
         m_map->displayStatus(Map::MapStatus::ImageHasCoordinates);
         m_map->clear();
         m_map->addImage(m_viewer->currentInfo());
         m_map->buildImageClusters();
         m_map->setCenter(m_viewer->currentInfo());
     } else {
         m_map->displayStatus(Map::MapStatus::ImageHasNoCoordinates);
     }
 }
 #endif
 
 // vi:expandtab:tabstop=4 shiftwidth=4:
 
 #include "moc_InfoBox.cpp"