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