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 <QToolBar>
  25
  26 #include <limits>
  27
  28 DolphinNavigatorsWidgetAction::DolphinNavigatorsWidgetAction(QWidget *parent) :
  29     QWidgetAction{parent},
  30     m_splitter{new QSplitter(Qt::Horizontal)},
  31     m_adjustSpacingTimer{new QTimer(this)},
  32     m_viewGeometriesHelper{m_splitter.get(), this}
  33 {
  34     updateText();
  35     setIcon(QIcon::fromTheme(QStringLiteral("dialog-scripts")));
  36
  37     m_splitter->setChildrenCollapsible(false);
  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 void DolphinNavigatorsWidgetAction::adjustSpacing()
  48 {
  49     m_previousWindowWidth = parentWidget()->window()->width();
  50     auto viewGeometries = m_viewGeometriesHelper.viewGeometries();
  51     const int widthOfSplitterPrimary = viewGeometries.globalXOfPrimary + viewGeometries.widthOfPrimary - viewGeometries.globalXOfNavigatorsWidget;
  52     const QList<int> splitterSizes = {widthOfSplitterPrimary,
  53                                       m_splitter->width() - widthOfSplitterPrimary};
  54     m_splitter->setSizes(splitterSizes);
  55
  56     // primary side of m_splitter
  57     int leadingSpacing = viewGeometries.globalXOfPrimary - viewGeometries.globalXOfNavigatorsWidget;
  58     if (leadingSpacing < 0) {
  59         leadingSpacing = 0;
  60     }
  61     int trailingSpacing = (viewGeometries.globalXOfNavigatorsWidget + m_splitter->width())
  62                           - (viewGeometries.globalXOfPrimary + viewGeometries.widthOfPrimary);
  63     if (trailingSpacing < 0 || emptyTrashButton(Primary)->isVisible()
  64                             || networkFolderButton(Primary)->isVisible()
  65     ) {
  66         trailingSpacing = 0;
  67     }
  68     const int widthLeftForUrlNavigator = m_splitter->widget(0)->width() - leadingSpacing - trailingSpacing;
  69     const int widthNeededForUrlNavigator = primaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator;
  70     if (widthNeededForUrlNavigator > 0) {
  71         trailingSpacing -= widthNeededForUrlNavigator;
  72         if (trailingSpacing < 0) {
  73             leadingSpacing += trailingSpacing;
  74             trailingSpacing = 0;
  75         }
  76         if (leadingSpacing < 0) {
  77             leadingSpacing = 0;
  78         }
  79     }
  80     spacing(Primary, Leading)->setMinimumWidth(leadingSpacing);
  81     spacing(Primary, Trailing)->setFixedWidth(trailingSpacing);
  82
  83     // secondary side of m_splitter
  84     if (viewGeometries.globalXOfSecondary == INT_MIN) {
  85         Q_ASSERT(viewGeometries.widthOfSecondary == INT_MIN);
  86         return;
  87     }
  88     spacing(Primary, Trailing)->setFixedWidth(0);
  89
  90     trailingSpacing = (viewGeometries.globalXOfNavigatorsWidget + m_splitter->width())
  91                       - (viewGeometries.globalXOfSecondary + viewGeometries.widthOfSecondary);
  92     if (trailingSpacing < 0 || emptyTrashButton(Secondary)->isVisible()
  93                             || networkFolderButton(Secondary)->isVisible()
  94     ) {
  95         trailingSpacing = 0;
  96     } else {
  97         const int widthLeftForUrlNavigator2 = m_splitter->widget(1)->width() - trailingSpacing;
  98         const int widthNeededForUrlNavigator2 = secondaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator2;
  99         if (widthNeededForUrlNavigator2 > 0) {
 100             trailingSpacing -= widthNeededForUrlNavigator2;
 101             if (trailingSpacing < 0) {
 102                 trailingSpacing = 0;
 103             }
 104         }
 105     }
 106     spacing(Secondary, Trailing)->setMinimumWidth(trailingSpacing);
 107 }
 108
 109 void DolphinNavigatorsWidgetAction::createSecondaryUrlNavigator()
 110 {
 111     Q_ASSERT(m_splitter->count() == 1);
 112     m_splitter->addWidget(createNavigatorWidget(Secondary));
 113     Q_ASSERT(m_splitter->count() == 2);
 114     updateText();
 115 }
 116
 117 void DolphinNavigatorsWidgetAction::followViewContainersGeometry(QWidget *primaryViewContainer,
 118                                                                  QWidget *secondaryViewContainer)
 119 {
 120     m_viewGeometriesHelper.setViewContainers(primaryViewContainer, secondaryViewContainer);
 121     adjustSpacing();
 122 }
 123
 124 bool DolphinNavigatorsWidgetAction::isInToolbar() const
 125 {
 126     return qobject_cast<QToolBar *>(m_splitter->parentWidget());
 127 }
 128
 129 DolphinUrlNavigator* DolphinNavigatorsWidgetAction::primaryUrlNavigator() const
 130 {
 131     Q_ASSERT(m_splitter);
 132     return m_splitter->widget(0)->findChild<DolphinUrlNavigator *>();
 133 }
 134
 135 DolphinUrlNavigator* DolphinNavigatorsWidgetAction::secondaryUrlNavigator() const
 136 {
 137     Q_ASSERT(m_splitter);
 138     if (m_splitter->count() < 2) {
 139         return nullptr;
 140     }
 141     return m_splitter->widget(1)->findChild<DolphinUrlNavigator *>();
 142 }
 143
 144 void DolphinNavigatorsWidgetAction::setSecondaryNavigatorVisible(bool visible)
 145 {
 146     if (visible) {
 147         Q_ASSERT(m_splitter->count() == 2);
 148         m_splitter->widget(1)->setVisible(true);
 149     } else if (m_splitter->count() > 1) {
 150         m_splitter->widget(1)->setVisible(false);
 151         // Fix an unlikely event of wrong trash button visibility.
 152         emptyTrashButton(Secondary)->setVisible(false);
 153     }
 154     updateText();
 155 }
 156
 157 QWidget *DolphinNavigatorsWidgetAction::createWidget(QWidget *parent)
 158 {
 159     QWidget *oldParent = m_splitter->parentWidget();
 160     if (oldParent && oldParent->layout()) {
 161         oldParent->layout()->removeWidget(m_splitter.get());
 162         QGridLayout *layout = qobject_cast<QGridLayout *>(oldParent->layout());
 163         if (qobject_cast<QToolBar *>(parent) && layout) {
 164             // in DolphinTabPage::insertNavigatorsWidget the minimumHeight of this row was
 165             // set to fit the m_splitter. Since we are now removing it again, the
 166             // minimumHeight can be reset to 0.
 167             layout->setRowMinimumHeight(0, 0);
 168         }
 169     }
 170     m_splitter->setParent(parent);
 171     return m_splitter.get();
 172 }
 173
 174 void DolphinNavigatorsWidgetAction::deleteWidget(QWidget *widget)
 175 {
 176     Q_UNUSED(widget)
 177     m_splitter->setParent(nullptr);
 178 }
 179
 180 QWidget *DolphinNavigatorsWidgetAction::createNavigatorWidget(Side side) const
 181 {
 182     auto navigatorWidget = new QWidget(m_splitter.get());
 183     auto layout = new QHBoxLayout{navigatorWidget};
 184     layout->setSpacing(0);
 185     layout->setContentsMargins(0, 0, 0, 0);
 186     if (side == Primary) {
 187         auto leadingSpacing = new QWidget{navigatorWidget};
 188         layout->addWidget(leadingSpacing);
 189     }
 190     auto urlNavigator = new DolphinUrlNavigator(navigatorWidget);
 191     layout->addWidget(urlNavigator);
 192
 193     auto emptyTrashButton = newEmptyTrashButton(urlNavigator, navigatorWidget);
 194     layout->addWidget(emptyTrashButton);
 195
 196     auto networkFolderButton = newNetworkFolderButton(urlNavigator, navigatorWidget);
 197     layout->addWidget(networkFolderButton);
 198
 199     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [urlNavigator, this]() {
 200         // Update URL navigator to show a server URL entry placeholder text if we
 201         // just loaded the remote:/ page, to make it easier for users to figure out
 202         // that they can enter arbitrary remote URLs. See bug 414670
 203         if (urlNavigator->locationUrl().scheme() == QLatin1String("remote")) {
 204             if (!urlNavigator->isUrlEditable()) {
 205                 urlNavigator->setUrlEditable(true);
 206             }
 207             urlNavigator->clearText();
 208             urlNavigator->setPlaceholderText(i18n("Enter server URL (e.g. smb://[ip address])"));
 209         } else {
 210             urlNavigator->setPlaceholderText(QString());
 211         }
 212
 213         // We have to wait for DolphinUrlNavigator::sizeHint() to update which
 214         // happens a little bit later than when urlChanged is emitted.
 215         this->m_adjustSpacingTimer->start();
 216     }, Qt::QueuedConnection);
 217
 218     auto trailingSpacing = new QWidget{navigatorWidget};
 219     layout->addWidget(trailingSpacing);
 220     return navigatorWidget;
 221 }
 222
 223 QPushButton * DolphinNavigatorsWidgetAction::emptyTrashButton(DolphinNavigatorsWidgetAction::Side side)
 224 {
 225     int sideIndex = (side == Primary ? 0 : 1);
 226     if (side == Primary) {
 227         return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget());
 228     }
 229     return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(1)->widget());
 230 }
 231
 232 QPushButton *DolphinNavigatorsWidgetAction::newEmptyTrashButton(const DolphinUrlNavigator *urlNavigator, QWidget *parent) const
 233 {
 234     auto emptyTrashButton = new QPushButton(QIcon::fromTheme(QStringLiteral("user-trash")),
 235                                         i18nc("@action:button", "Empty Trash"), parent);
 236     emptyTrashButton->setToolTip(i18n("Empties Trash to create free space"));
 237
 238     emptyTrashButton->setFlat(true);
 239     connect(emptyTrashButton, &QPushButton::clicked,
 240             this, [parent]() { Trash::empty(parent); });
 241     connect(&Trash::instance(), &Trash::emptinessChanged,
 242             emptyTrashButton, &QPushButton::setDisabled);
 243     emptyTrashButton->hide();
 244     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [emptyTrashButton, urlNavigator]() {
 245         emptyTrashButton->setVisible(urlNavigator->locationUrl().scheme() == QLatin1String("trash"));
 246     });
 247     emptyTrashButton->setDisabled(Trash::isEmpty());
 248     return emptyTrashButton;
 249 }
 250
 251 QPushButton *DolphinNavigatorsWidgetAction::networkFolderButton(DolphinNavigatorsWidgetAction::Side side)
 252 {
 253     int sideIndex = (side == Primary ? 0 : 1);
 254     if (side == Primary) {
 255         return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget());
 256     }
 257     return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget());
 258 }
 259
 260 QPushButton *DolphinNavigatorsWidgetAction::newNetworkFolderButton(const DolphinUrlNavigator *urlNavigator, QWidget *parent) const
 261 {
 262     auto networkFolderButton = new QPushButton(QIcon::fromTheme(QStringLiteral("folder-add")),
 263                                         i18nc("@action:button", "Add Network Folder"), parent);
 264     networkFolderButton->setFlat(true);
 265     KService::Ptr service = KService::serviceByDesktopName(QStringLiteral("org.kde.knetattach"));
 266     connect(networkFolderButton, &QPushButton::clicked,
 267             this, [networkFolderButton, service]() {
 268                 auto *job = new KIO::ApplicationLauncherJob(service, networkFolderButton);
 269                 auto *delegate = new KNotificationJobUiDelegate;
 270                 delegate->setAutoErrorHandlingEnabled(true);
 271                 job->setUiDelegate(delegate);
 272                 job->start();
 273             });
 274     networkFolderButton->hide();
 275     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [networkFolderButton, urlNavigator, service]() {
 276         networkFolderButton->setVisible(service && urlNavigator->locationUrl().scheme() == QLatin1String("remote"));
 277     });
 278     return networkFolderButton;
 279 }
 280
 281 QWidget *DolphinNavigatorsWidgetAction::spacing(Side side, Position position) const
 282 {
 283     int sideIndex = (side == Primary ? 0 : 1);
 284     if (position == Leading) {
 285         Q_ASSERT(side == Primary); // The secondary side of the splitter has no leading spacing.
 286         return m_splitter->widget(sideIndex)->layout()->itemAt(0)->widget();
 287     }
 288     if (side == Primary) {
 289         return m_splitter->widget(sideIndex)->layout()->itemAt(4)->widget();
 290     }
 291     return m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget();
 292 }
 293
 294 void DolphinNavigatorsWidgetAction::updateText()
 295 {
 296     const int urlNavigatorsAmount = m_splitter->count() > 1 && m_splitter->widget(1)->isVisible() ?
 297                                     2 : 1;
 298     setText(i18ncp("@action:inmenu", "Location Bar", "Location Bars", urlNavigatorsAmount));
 299 }
 300
 301 DolphinNavigatorsWidgetAction::ViewGeometriesHelper::ViewGeometriesHelper
 302     (QWidget *navigatorsWidget, DolphinNavigatorsWidgetAction *navigatorsWidgetAction) :
 303     m_navigatorsWidget{navigatorsWidget},
 304     m_navigatorsWidgetAction{navigatorsWidgetAction}
 305 {
 306     Q_CHECK_PTR(navigatorsWidget);
 307     Q_CHECK_PTR(navigatorsWidgetAction);
 308 }
 309
 310 bool DolphinNavigatorsWidgetAction::ViewGeometriesHelper::eventFilter(QObject *watched, QEvent *event)
 311 {
 312     if (event->type() == QEvent::Resize) {
 313         if (m_navigatorsWidgetAction->parentWidget()->window()->width() != m_navigatorsWidgetAction->m_previousWindowWidth) {
 314             // The window is being resized which means not all widgets have gotten their new sizes yet.
 315             // Let's wait a bit so the sizes of the navigatorsWidget and the viewContainers have all
 316             // had a chance to be updated.
 317             m_navigatorsWidgetAction->m_adjustSpacingTimer->start();
 318         } else {
 319             m_navigatorsWidgetAction->adjustSpacing();
 320             // We could always use the m_adjustSpacingTimer instead of calling adjustSpacing() directly
 321             // here but then the navigatorsWidget doesn't fluently align with the viewContainers when
 322             // the DolphinTabPage::m_expandViewAnimation is animating.
 323         }
 324         return false;
 325     }
 326     return QObject::eventFilter(watched, event);
 327 }
 328
 329 void DolphinNavigatorsWidgetAction::ViewGeometriesHelper::setViewContainers(QWidget *primaryViewContainer,
 330                                                                             QWidget *secondaryViewContainer)
 331 {
 332     Q_CHECK_PTR(primaryViewContainer);
 333     if (m_primaryViewContainer) {
 334         m_primaryViewContainer->removeEventFilter(this);
 335     }
 336     primaryViewContainer->installEventFilter(this);
 337     m_primaryViewContainer = primaryViewContainer;
 338
 339     // It is not possible to resize the secondaryViewContainer without simultaneously
 340     // resizing the primaryViewContainer so we don't have to installEventFilter() here.
 341     m_secondaryViewContainer = secondaryViewContainer;
 342 }
 343
 344 DolphinNavigatorsWidgetAction::ViewGeometriesHelper::Geometries
 345         DolphinNavigatorsWidgetAction::ViewGeometriesHelper::viewGeometries()
 346 {
 347     Q_ASSERT(m_primaryViewContainer);
 348     Geometries geometries;
 349
 350     // width
 351     geometries.widthOfPrimary = m_primaryViewContainer->width();
 352     if (m_secondaryViewContainer) {
 353         geometries.widthOfSecondary = m_secondaryViewContainer->width();
 354     } else {
 355         geometries.widthOfSecondary = INT_MIN;
 356     }
 357
 358     // globalX
 359     if (QApplication::layoutDirection() == Qt::LeftToRight) {
 360         geometries.globalXOfNavigatorsWidget = m_navigatorsWidget->mapToGlobal(QPoint(0,0)).x();
 361         geometries.globalXOfPrimary = m_primaryViewContainer->mapToGlobal(QPoint(0,0)).x();
 362         geometries.globalXOfSecondary = !m_secondaryViewContainer ? INT_MIN :
 363                 m_secondaryViewContainer->mapToGlobal(QPoint(0,0)).x();
 364     } else {
 365         // When the direction is reversed, globalX does not change.
 366         // For the adjustSpacing() code to work we need globalX to measure from right to left
 367         // and to measure up to the rightmost point of a widget instead of the leftmost.
 368         geometries.globalXOfNavigatorsWidget =
 369                 (-1) * (m_navigatorsWidget->mapToGlobal(QPoint(0,0)).x() + m_navigatorsWidget->width());
 370         geometries.globalXOfPrimary =
 371                 (-1) * (m_primaryViewContainer->mapToGlobal(QPoint(0,0)).x() + geometries.widthOfPrimary);
 372         geometries.globalXOfSecondary = !m_secondaryViewContainer ? INT_MIN :
 373                 (-1) * (m_secondaryViewContainer->mapToGlobal(QPoint(0,0)).x() + geometries.widthOfSecondary);
 374     }
 375     return geometries;
 376 }