src/dolphinnavigatorswidgetaction.cpp

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