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