src/dolphinnavigatorswidgetaction.cpp

   1 /*
   2     This file is part of the KDE project
   3     SPDX-FileCopyrightText: 2020 Felix Ernst <fe.a.ernst@gmail.com>
   4
   5     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
   6 */
   7
   8 #include "dolphinnavigatorswidgetaction.h"
   9
  10 #include "trash/dolphintrash.h"
  11
  12 #include <KLocalizedString>
  13 #include <KXMLGUIFactory>
  14 #include <KXmlGuiWindow>
  15
  16 #include <QApplication>
  17 #include <QDomDocument>
  18 #include <QHBoxLayout>
  19 #include <QPushButton>
  20 #include <QSplitter>
  21
  22 #include <limits>
  23
  24 DolphinNavigatorsWidgetAction::DolphinNavigatorsWidgetAction(QWidget *parent) :
  25     QWidgetAction{parent},
  26     m_splitter{new QSplitter(Qt::Horizontal)},
  27     m_adjustSpacingTimer{new QTimer(this)},
  28     m_globalXOfSplitter{INT_MIN},
  29     m_globalXOfPrimary{INT_MIN},
  30     m_widthOfPrimary{INT_MIN},
  31     m_globalXOfSecondary{INT_MIN},
  32     m_widthOfSecondary{INT_MIN}
  33 {
  34     updateText();
  35     setIcon(QIcon::fromTheme(QStringLiteral("dialog-scripts")));
  36
  37     m_splitter->setChildrenCollapsible(false);
  38     setDefaultWidget(m_splitter.get());
  39
  40     m_splitter->addWidget(createNavigatorWidget(Primary));
  41
  42     m_adjustSpacingTimer->setInterval(100);
  43     m_adjustSpacingTimer->setSingleShot(true);
  44     connect(m_adjustSpacingTimer.get(), &QTimer::timeout,
  45             this, &DolphinNavigatorsWidgetAction::adjustSpacing);
  46 }
  47
  48 bool DolphinNavigatorsWidgetAction::addToToolbarAndSave(KXmlGuiWindow *mainWindow)
  49 {
  50     const QString rawXml = KXMLGUIFactory::readConfigFile(mainWindow->xmlFile());
  51     QDomDocument domDocument;
  52     if (rawXml.isEmpty() || !domDocument.setContent(rawXml) || domDocument.isNull()) {
  53         return false;
  54     }
  55     QDomNode toolbar = domDocument.elementsByTagName(QStringLiteral("ToolBar")).at(0);
  56     if (toolbar.isNull()) {
  57         return false;
  58     }
  59
  60     QDomElement urlNavigatorElement = domDocument.createElement(QStringLiteral("Action"));
  61     urlNavigatorElement.setAttribute(QStringLiteral("name"), QStringLiteral("url_navigators"));
  62
  63     QDomNode position = toolbar.firstChildElement(QStringLiteral("Spacer"));
  64     if (position.isNull()) {
  65         toolbar.appendChild(urlNavigatorElement);
  66     } else {
  67         toolbar.replaceChild(urlNavigatorElement, position);
  68     }
  69
  70     KXMLGUIFactory::saveConfigFile(domDocument, mainWindow->xmlFile());
  71     mainWindow->reloadXML();
  72     mainWindow->createGUI();
  73     return true;
  74 }
  75
  76 void DolphinNavigatorsWidgetAction::createSecondaryUrlNavigator()
  77 {
  78     Q_ASSERT(m_splitter->count() == 1);
  79     m_splitter->addWidget(createNavigatorWidget(Secondary));
  80     Q_ASSERT(m_splitter->count() == 2);
  81     updateText();
  82 }
  83
  84 void DolphinNavigatorsWidgetAction::followViewContainerGeometry(
  85                                     int globalXOfPrimary,   int widthOfPrimary)
  86 {
  87     followViewContainersGeometry(globalXOfPrimary, widthOfPrimary, INT_MIN, INT_MIN);
  88 }
  89
  90 void DolphinNavigatorsWidgetAction::followViewContainersGeometry(
  91                                     int globalXOfPrimary,   int widthOfPrimary,
  92                                     int globalXOfSecondary, int widthOfSecondary)
  93 {
  94     if (QApplication::layoutDirection() == Qt::LeftToRight) {
  95         m_globalXOfSplitter = m_splitter->mapToGlobal(QPoint(0,0)).x();
  96         m_globalXOfPrimary = globalXOfPrimary;
  97         m_globalXOfSecondary = globalXOfSecondary;
  98     } else {
  99         // When the direction is reversed, globalX does not change.
 100         // For the adjustSpacing() code to work we need globalX to measure from right to left
 101         // and to measure up to the rightmost point of a widget instead of the leftmost.
 102         m_globalXOfSplitter = (-1) * (m_splitter->mapToGlobal(QPoint(0,0)).x() + m_splitter->width());
 103         m_globalXOfPrimary = (-1) * (globalXOfPrimary + widthOfPrimary);
 104         m_globalXOfSecondary = (globalXOfSecondary == INT_MIN) ? INT_MIN :
 105                                (-1) * (globalXOfSecondary + widthOfSecondary);
 106     }
 107     m_widthOfPrimary = widthOfPrimary;
 108     m_widthOfSecondary = widthOfSecondary;
 109     adjustSpacing();
 110 }
 111
 112 DolphinUrlNavigator* DolphinNavigatorsWidgetAction::primaryUrlNavigator() const
 113 {
 114     Q_ASSERT(m_splitter);
 115     return m_splitter->widget(0)->findChild<DolphinUrlNavigator *>();
 116 }
 117
 118 DolphinUrlNavigator* DolphinNavigatorsWidgetAction::secondaryUrlNavigator() const
 119 {
 120     Q_ASSERT(m_splitter);
 121     if (m_splitter->count() < 2) {
 122         return nullptr;
 123     }
 124     return m_splitter->widget(1)->findChild<DolphinUrlNavigator *>();
 125 }
 126
 127 void DolphinNavigatorsWidgetAction::setSecondaryNavigatorVisible(bool visible)
 128 {
 129     if (visible) {
 130         Q_ASSERT(m_splitter->count() == 2);
 131         m_splitter->widget(1)->setVisible(true);
 132     } else if (m_splitter->count() > 1) {
 133         m_splitter->widget(1)->setVisible(false);
 134         // Fix an unlikely event of wrong trash button visibility.
 135         emptyTrashButton(Secondary)->setVisible(false);
 136     }
 137     updateText();
 138 }
 139
 140 void DolphinNavigatorsWidgetAction::adjustSpacing()
 141 {
 142     Q_ASSERT(m_globalXOfSplitter != INT_MIN);
 143     Q_ASSERT(m_globalXOfPrimary  != INT_MIN);
 144     Q_ASSERT(m_widthOfPrimary    != INT_MIN);
 145     const int widthOfSplitterPrimary = m_globalXOfPrimary + m_widthOfPrimary - m_globalXOfSplitter;
 146     const QList<int> splitterSizes = {widthOfSplitterPrimary,
 147                                       m_splitter->width() - widthOfSplitterPrimary};
 148     m_splitter->setSizes(splitterSizes);
 149
 150     // primary side of m_splitter
 151     int leadingSpacing = m_globalXOfPrimary - m_globalXOfSplitter;
 152     if (leadingSpacing < 0) {
 153         leadingSpacing = 0;
 154     }
 155     int trailingSpacing = (m_globalXOfSplitter + m_splitter->width())
 156                           - (m_globalXOfPrimary + m_widthOfPrimary);
 157     if (trailingSpacing < 0 || emptyTrashButton(Primary)->isVisible()) {
 158         trailingSpacing = 0;
 159     }
 160     const int widthLeftForUrlNavigator = m_splitter->widget(0)->width() - leadingSpacing - trailingSpacing;
 161     const int widthNeededForUrlNavigator = primaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator;
 162     if (widthNeededForUrlNavigator > 0) {
 163         trailingSpacing -= widthNeededForUrlNavigator;
 164         if (trailingSpacing < 0) {
 165             leadingSpacing += trailingSpacing;
 166             trailingSpacing = 0;
 167         }
 168         if (leadingSpacing < 0) {
 169             leadingSpacing = 0;
 170         }
 171     }
 172     spacing(Primary, Leading)->setMinimumWidth(leadingSpacing);
 173     spacing(Primary, Trailing)->setFixedWidth(trailingSpacing);
 174
 175     // secondary side of m_splitter
 176     if (m_globalXOfSecondary == INT_MIN) {
 177         Q_ASSERT(m_widthOfSecondary == INT_MIN);
 178         return;
 179     }
 180     spacing(Primary, Trailing)->setFixedWidth(0);
 181
 182     trailingSpacing = (m_globalXOfSplitter + m_splitter->width())
 183                       - (m_globalXOfSecondary + m_widthOfSecondary);
 184     if (trailingSpacing < 0 || emptyTrashButton(Secondary)->isVisible()) {
 185         trailingSpacing = 0;
 186     } else {
 187         const int widthLeftForUrlNavigator2 = m_splitter->widget(1)->width() - trailingSpacing;
 188         const int widthNeededForUrlNavigator2 = secondaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator2;
 189         if (widthNeededForUrlNavigator2 > 0) {
 190             trailingSpacing -= widthNeededForUrlNavigator2;
 191             if (trailingSpacing < 0) {
 192                 trailingSpacing = 0;
 193             }
 194         }
 195     }
 196     spacing(Secondary, Trailing)->setMinimumWidth(trailingSpacing);
 197 }
 198
 199 QWidget *DolphinNavigatorsWidgetAction::createNavigatorWidget(Side side) const
 200 {
 201     auto navigatorWidget = new QWidget(m_splitter.get());
 202     auto layout = new QHBoxLayout{navigatorWidget};
 203     layout->setSpacing(0);
 204     layout->setContentsMargins(0, 0, 0, 0);
 205     if (side == Primary) {
 206         auto leadingSpacing = new QWidget{navigatorWidget};
 207         layout->addWidget(leadingSpacing);
 208     }
 209     auto urlNavigator = new DolphinUrlNavigator(navigatorWidget);
 210     layout->addWidget(urlNavigator);
 211
 212     auto emptyTrashButton = newEmptyTrashButton(urlNavigator, navigatorWidget);
 213     layout->addWidget(emptyTrashButton);
 214
 215     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [this]() {
 216         // We have to wait for DolphinUrlNavigator::sizeHint() to update which
 217         // happens a little bit later than when urlChanged is emitted.
 218         this->m_adjustSpacingTimer->start();
 219     });
 220
 221     auto trailingSpacing = new QWidget{navigatorWidget};
 222     layout->addWidget(trailingSpacing);
 223     return navigatorWidget;
 224 }
 225
 226 QPushButton * DolphinNavigatorsWidgetAction::emptyTrashButton(DolphinNavigatorsWidgetAction::Side side)
 227 {
 228     int sideIndex = (side == Primary ? 0 : 1);
 229     if (side == Primary) {
 230         return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget());
 231     }
 232     return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(1)->widget());
 233 }
 234
 235 QPushButton *DolphinNavigatorsWidgetAction::newEmptyTrashButton(const DolphinUrlNavigator *urlNavigator, QWidget *parent) const
 236 {
 237     auto emptyTrashButton = new QPushButton(QIcon::fromTheme(QStringLiteral("user-trash")),
 238                                         i18nc("@action:button", "Empty Trash"), parent);
 239     emptyTrashButton->setFlat(true);
 240     connect(emptyTrashButton, &QPushButton::clicked,
 241             this, [parent]() { Trash::empty(parent); });
 242     connect(&Trash::instance(), &Trash::emptinessChanged,
 243             emptyTrashButton, &QPushButton::setDisabled);
 244     emptyTrashButton->hide();
 245     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [emptyTrashButton, urlNavigator]() {
 246         emptyTrashButton->setVisible(urlNavigator->locationUrl().scheme() == QLatin1String("trash"));
 247     });
 248     emptyTrashButton->setDisabled(Trash::isEmpty());
 249     return emptyTrashButton;
 250 }
 251
 252 QWidget *DolphinNavigatorsWidgetAction::spacing(Side side, Position position) const
 253 {
 254     int sideIndex = (side == Primary ? 0 : 1);
 255     if (position == Leading) {
 256         Q_ASSERT(side == Primary); // The secondary side of the splitter has no leading spacing.
 257         return m_splitter->widget(sideIndex)->layout()->itemAt(0)->widget();
 258     }
 259     if (side == Primary) {
 260         return m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget();
 261     }
 262     return m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget();
 263 }
 264
 265 void DolphinNavigatorsWidgetAction::updateText()
 266 {
 267     const int urlNavigatorsAmount = m_splitter->count() > 1 && m_splitter->widget(1)->isVisible() ?
 268                                     2 : 1;
 269     setText(i18ncp("@action:inmenu", "Url Navigator", "Url Navigators", urlNavigatorsAmount));
 270 }