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