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 <KNotificationJobUiDelegate>
  14 #include <KService>
  15 #include <KXMLGUIFactory>
  16 #include <KXmlGuiWindow>
  17
  18 #include <KIO/ApplicationLauncherJob>
  19
  20 #include <QApplication>
  21 #include <QDomDocument>
  22 #include <QHBoxLayout>
  23 #include <QPushButton>
  24 #include <QSplitter>
  25 #include <QToolBar>
  26
  27 #include <limits>
  28
  29 DolphinNavigatorsWidgetAction::DolphinNavigatorsWidgetAction(QWidget *parent) :
  30     QWidgetAction{parent},
  31     m_splitter{new QSplitter(Qt::Horizontal)},
  32     m_adjustSpacingTimer{new QTimer(this)},
  33     m_globalXOfSplitter{INT_MIN},
  34     m_globalXOfPrimary{INT_MIN},
  35     m_widthOfPrimary{INT_MIN},
  36     m_globalXOfSecondary{INT_MIN},
  37     m_widthOfSecondary{INT_MIN}
  38 {
  39     updateText();
  40     setIcon(QIcon::fromTheme(QStringLiteral("dialog-scripts")));
  41
  42     m_splitter->setChildrenCollapsible(false);
  43
  44     m_splitter->addWidget(createNavigatorWidget(Primary));
  45
  46     m_adjustSpacingTimer->setInterval(100);
  47     m_adjustSpacingTimer->setSingleShot(true);
  48     connect(m_adjustSpacingTimer.get(), &QTimer::timeout,
  49             this, &DolphinNavigatorsWidgetAction::adjustSpacing);
  50 }
  51
  52 void DolphinNavigatorsWidgetAction::createSecondaryUrlNavigator()
  53 {
  54     Q_ASSERT(m_splitter->count() == 1);
  55     m_splitter->addWidget(createNavigatorWidget(Secondary));
  56     Q_ASSERT(m_splitter->count() == 2);
  57     updateText();
  58 }
  59
  60 void DolphinNavigatorsWidgetAction::followViewContainerGeometry(
  61                                     int globalXOfPrimary,   int widthOfPrimary)
  62 {
  63     followViewContainersGeometry(globalXOfPrimary, widthOfPrimary, INT_MIN, INT_MIN);
  64 }
  65
  66 void DolphinNavigatorsWidgetAction::followViewContainersGeometry(
  67                                     int globalXOfPrimary,   int widthOfPrimary,
  68                                     int globalXOfSecondary, int widthOfSecondary)
  69 {
  70     if (QApplication::layoutDirection() == Qt::LeftToRight) {
  71         m_globalXOfSplitter = m_splitter->mapToGlobal(QPoint(0,0)).x();
  72         m_globalXOfPrimary = globalXOfPrimary;
  73         m_globalXOfSecondary = globalXOfSecondary;
  74     } else {
  75         // When the direction is reversed, globalX does not change.
  76         // For the adjustSpacing() code to work we need globalX to measure from right to left
  77         // and to measure up to the rightmost point of a widget instead of the leftmost.
  78         m_globalXOfSplitter = (-1) * (m_splitter->mapToGlobal(QPoint(0,0)).x() + m_splitter->width());
  79         m_globalXOfPrimary = (-1) * (globalXOfPrimary + widthOfPrimary);
  80         m_globalXOfSecondary = (globalXOfSecondary == INT_MIN) ? INT_MIN :
  81                                (-1) * (globalXOfSecondary + widthOfSecondary);
  82     }
  83     m_widthOfPrimary = widthOfPrimary;
  84     m_widthOfSecondary = widthOfSecondary;
  85     adjustSpacing();
  86 }
  87
  88 bool DolphinNavigatorsWidgetAction::isInToolbar() const
  89 {
  90     return qobject_cast<QToolBar *>(m_splitter->parentWidget());
  91 }
  92
  93 DolphinUrlNavigator* DolphinNavigatorsWidgetAction::primaryUrlNavigator() const
  94 {
  95     Q_ASSERT(m_splitter);
  96     return m_splitter->widget(0)->findChild<DolphinUrlNavigator *>();
  97 }
  98
  99 DolphinUrlNavigator* DolphinNavigatorsWidgetAction::secondaryUrlNavigator() const
 100 {
 101     Q_ASSERT(m_splitter);
 102     if (m_splitter->count() < 2) {
 103         return nullptr;
 104     }
 105     return m_splitter->widget(1)->findChild<DolphinUrlNavigator *>();
 106 }
 107
 108 void DolphinNavigatorsWidgetAction::setSecondaryNavigatorVisible(bool visible)
 109 {
 110     if (visible) {
 111         Q_ASSERT(m_splitter->count() == 2);
 112         m_splitter->widget(1)->setVisible(true);
 113     } else if (m_splitter->count() > 1) {
 114         m_splitter->widget(1)->setVisible(false);
 115         // Fix an unlikely event of wrong trash button visibility.
 116         emptyTrashButton(Secondary)->setVisible(false);
 117     }
 118     updateText();
 119 }
 120
 121 QWidget *DolphinNavigatorsWidgetAction::createWidget(QWidget *parent)
 122 {
 123     QWidget *oldParent = m_splitter->parentWidget();
 124     if (oldParent && oldParent->layout()) {
 125         oldParent->layout()->removeWidget(m_splitter.get());
 126         QGridLayout *layout = qobject_cast<QGridLayout *>(oldParent->layout());
 127         if (qobject_cast<QToolBar *>(parent) && layout) {
 128             // in DolphinTabPage::insertNavigatorsWidget the minimumHeight of this row was
 129             // set to fit the m_splitter. Since we are now removing it again, the
 130             // minimumHeight can be reset to 0.
 131             layout->setRowMinimumHeight(0, 0);
 132         }
 133     }
 134     m_splitter->setParent(parent);
 135     return m_splitter.get();
 136 }
 137
 138 void DolphinNavigatorsWidgetAction::deleteWidget(QWidget *widget)
 139 {
 140     Q_UNUSED(widget)
 141     m_splitter->setParent(nullptr);
 142 }
 143
 144 void DolphinNavigatorsWidgetAction::adjustSpacing()
 145 {
 146     Q_ASSERT(m_globalXOfSplitter != INT_MIN);
 147     Q_ASSERT(m_globalXOfPrimary  != INT_MIN);
 148     Q_ASSERT(m_widthOfPrimary    != INT_MIN);
 149     const int widthOfSplitterPrimary = m_globalXOfPrimary + m_widthOfPrimary - m_globalXOfSplitter;
 150     const QList<int> splitterSizes = {widthOfSplitterPrimary,
 151                                       m_splitter->width() - widthOfSplitterPrimary};
 152     m_splitter->setSizes(splitterSizes);
 153
 154     // primary side of m_splitter
 155     int leadingSpacing = m_globalXOfPrimary - m_globalXOfSplitter;
 156     if (leadingSpacing < 0) {
 157         leadingSpacing = 0;
 158     }
 159     int trailingSpacing = (m_globalXOfSplitter + m_splitter->width())
 160                           - (m_globalXOfPrimary + m_widthOfPrimary);
 161 #if KIO_VERSION < QT_VERSION_CHECK(5, 78, 0)
 162     if (trailingSpacing < 0 || emptyTrashButton(Primary)->isVisible()) {
 163 #else
 164     if (trailingSpacing < 0 || emptyTrashButton(Primary)->isVisible()
 165                             || networkFolderButton(Primary)->isVisible()
 166     ) {
 167 #endif
 168         trailingSpacing = 0;
 169     }
 170     const int widthLeftForUrlNavigator = m_splitter->widget(0)->width() - leadingSpacing - trailingSpacing;
 171     const int widthNeededForUrlNavigator = primaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator;
 172     if (widthNeededForUrlNavigator > 0) {
 173         trailingSpacing -= widthNeededForUrlNavigator;
 174         if (trailingSpacing < 0) {
 175             leadingSpacing += trailingSpacing;
 176             trailingSpacing = 0;
 177         }
 178         if (leadingSpacing < 0) {
 179             leadingSpacing = 0;
 180         }
 181     }
 182     spacing(Primary, Leading)->setMinimumWidth(leadingSpacing);
 183     spacing(Primary, Trailing)->setFixedWidth(trailingSpacing);
 184
 185     // secondary side of m_splitter
 186     if (m_globalXOfSecondary == INT_MIN) {
 187         Q_ASSERT(m_widthOfSecondary == INT_MIN);
 188         return;
 189     }
 190     spacing(Primary, Trailing)->setFixedWidth(0);
 191
 192     trailingSpacing = (m_globalXOfSplitter + m_splitter->width())
 193                       - (m_globalXOfSecondary + m_widthOfSecondary);
 194 #if KIO_VERSION < QT_VERSION_CHECK(5, 78, 0)
 195     if (trailingSpacing < 0 || emptyTrashButton(Secondary)->isVisible()) {
 196 #else
 197     if (trailingSpacing < 0 || emptyTrashButton(Secondary)->isVisible()
 198                             || networkFolderButton(Secondary)->isVisible()
 199     ) {
 200 #endif
 201         trailingSpacing = 0;
 202     } else {
 203         const int widthLeftForUrlNavigator2 = m_splitter->widget(1)->width() - trailingSpacing;
 204         const int widthNeededForUrlNavigator2 = secondaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator2;
 205         if (widthNeededForUrlNavigator2 > 0) {
 206             trailingSpacing -= widthNeededForUrlNavigator2;
 207             if (trailingSpacing < 0) {
 208                 trailingSpacing = 0;
 209             }
 210         }
 211     }
 212     spacing(Secondary, Trailing)->setMinimumWidth(trailingSpacing);
 213 }
 214
 215 QWidget *DolphinNavigatorsWidgetAction::createNavigatorWidget(Side side) const
 216 {
 217     auto navigatorWidget = new QWidget(m_splitter.get());
 218     auto layout = new QHBoxLayout{navigatorWidget};
 219     layout->setSpacing(0);
 220     layout->setContentsMargins(0, 0, 0, 0);
 221     if (side == Primary) {
 222         auto leadingSpacing = new QWidget{navigatorWidget};
 223         layout->addWidget(leadingSpacing);
 224     }
 225     auto urlNavigator = new DolphinUrlNavigator(navigatorWidget);
 226     layout->addWidget(urlNavigator);
 227
 228     auto emptyTrashButton = newEmptyTrashButton(urlNavigator, navigatorWidget);
 229     layout->addWidget(emptyTrashButton);
 230
 231 #if !(KIO_VERSION < QT_VERSION_CHECK(5, 78, 0))
 232     auto networkFolderButton = newNetworkFolderButton(urlNavigator, navigatorWidget);
 233     layout->addWidget(networkFolderButton);
 234 #endif
 235
 236     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [this]() {
 237         // We have to wait for DolphinUrlNavigator::sizeHint() to update which
 238         // happens a little bit later than when urlChanged is emitted.
 239         this->m_adjustSpacingTimer->start();
 240     });
 241
 242     auto trailingSpacing = new QWidget{navigatorWidget};
 243     layout->addWidget(trailingSpacing);
 244     return navigatorWidget;
 245 }
 246
 247 QPushButton * DolphinNavigatorsWidgetAction::emptyTrashButton(DolphinNavigatorsWidgetAction::Side side)
 248 {
 249     int sideIndex = (side == Primary ? 0 : 1);
 250     if (side == Primary) {
 251         return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget());
 252     }
 253     return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(1)->widget());
 254 }
 255
 256 QPushButton *DolphinNavigatorsWidgetAction::newEmptyTrashButton(const DolphinUrlNavigator *urlNavigator, QWidget *parent) const
 257 {
 258     auto emptyTrashButton = new QPushButton(QIcon::fromTheme(QStringLiteral("user-trash")),
 259                                         i18nc("@action:button", "Empty Trash"), parent);
 260     emptyTrashButton->setFlat(true);
 261     connect(emptyTrashButton, &QPushButton::clicked,
 262             this, [parent]() { Trash::empty(parent); });
 263     connect(&Trash::instance(), &Trash::emptinessChanged,
 264             emptyTrashButton, &QPushButton::setDisabled);
 265     emptyTrashButton->hide();
 266     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [emptyTrashButton, urlNavigator]() {
 267         emptyTrashButton->setVisible(urlNavigator->locationUrl().scheme() == QLatin1String("trash"));
 268     });
 269     emptyTrashButton->setDisabled(Trash::isEmpty());
 270     return emptyTrashButton;
 271 }
 272
 273 #if !(KIO_VERSION < QT_VERSION_CHECK(5, 78, 0))
 274 QPushButton *DolphinNavigatorsWidgetAction::networkFolderButton(DolphinNavigatorsWidgetAction::Side side)
 275 {
 276     int sideIndex = (side == Primary ? 0 : 1);
 277     if (side == Primary) {
 278         return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget());
 279     }
 280     return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget());
 281 }
 282
 283 QPushButton *DolphinNavigatorsWidgetAction::newNetworkFolderButton(const DolphinUrlNavigator *urlNavigator, QWidget *parent) const
 284 {
 285     auto networkFolderButton = new QPushButton(QIcon::fromTheme(QStringLiteral("folder-add")),
 286                                         i18nc("@action:button", "Add Network Folder"), parent);
 287     networkFolderButton->setFlat(true);
 288     connect(networkFolderButton, &QPushButton::clicked,
 289             this, [networkFolderButton]() {
 290                 KService::Ptr service = KService::serviceByDesktopName(QStringLiteral("org.kde.knetattach"));
 291                 auto *job = new KIO::ApplicationLauncherJob(service, networkFolderButton);
 292                 auto *delegate = new KNotificationJobUiDelegate;
 293                 delegate->setAutoErrorHandlingEnabled(true);
 294                 job->setUiDelegate(delegate);
 295                 job->start();
 296             });
 297     networkFolderButton->hide();
 298     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [networkFolderButton, urlNavigator]() {
 299         networkFolderButton->setVisible(urlNavigator->locationUrl().scheme() == QLatin1String("remote"));
 300     });
 301     return networkFolderButton;
 302 }
 303 #endif
 304
 305 QWidget *DolphinNavigatorsWidgetAction::spacing(Side side, Position position) const
 306 {
 307     int sideIndex = (side == Primary ? 0 : 1);
 308     if (position == Leading) {
 309         Q_ASSERT(side == Primary); // The secondary side of the splitter has no leading spacing.
 310         return m_splitter->widget(sideIndex)->layout()->itemAt(0)->widget();
 311     }
 312     if (side == Primary) {
 313 #if KIO_VERSION < QT_VERSION_CHECK(5, 78, 0)
 314         return m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget();
 315 #else
 316         return m_splitter->widget(sideIndex)->layout()->itemAt(4)->widget();
 317 #endif
 318     }
 319 #if KIO_VERSION < QT_VERSION_CHECK(5, 78, 0)
 320     return m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget();
 321 #else
 322     return m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget();
 323 #endif
 324 }
 325
 326 void DolphinNavigatorsWidgetAction::updateText()
 327 {
 328     const int urlNavigatorsAmount = m_splitter->count() > 1 && m_splitter->widget(1)->isVisible() ?
 329                                     2 : 1;
 330     setText(i18ncp("@action:inmenu", "Url Navigator", "Url Navigators", urlNavigatorsAmount));
 331 }