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