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