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 <KLocalizedString>
  13 #include <KNotificationJobUiDelegate>
  14 #include <KService>
  15
  16 #include <KIO/ApplicationLauncherJob>
  17
  18 #include <QApplication>
  19 #include <QHBoxLayout>
  20 #include <QPushButton>
  21 #include <QStyle>
  22 #include <QToolBar>
  23
  24 #include <limits>
  25
  26 DolphinNavigatorsWidgetAction::DolphinNavigatorsWidgetAction(QWidget *parent)
  27     : QWidgetAction{parent}
  28     , m_splitter{new QSplitter(Qt::Horizontal)}
  29     , m_adjustSpacingTimer{new QTimer(this)}
  30     , m_viewGeometriesHelper{m_splitter.get(), this}
  31 {
  32     updateText();
  33     setIcon(QIcon::fromTheme(QStringLiteral("dialog-scripts")));
  34
  35     m_splitter->setChildrenCollapsible(false);
  36
  37     m_splitter->addWidget(createNavigatorWidget(Primary));
  38     m_splitter->setFocusProxy(primaryUrlNavigator());
  39
  40     m_adjustSpacingTimer->setInterval(100);
  41     m_adjustSpacingTimer->setSingleShot(true);
  42     connect(m_adjustSpacingTimer.get(), &QTimer::timeout, this, &DolphinNavigatorsWidgetAction::adjustSpacing);
  43 }
  44
  45 void DolphinNavigatorsWidgetAction::adjustSpacing()
  46 {
  47     m_previousWindowWidth = qobject_cast<QWidget *>(parent())->window()->width();
  48     auto viewGeometries = m_viewGeometriesHelper.viewGeometries();
  49     const int widthOfSplitterPrimary = viewGeometries.globalXOfPrimary + viewGeometries.widthOfPrimary - viewGeometries.globalXOfNavigatorsWidget;
  50     const QList<int> splitterSizes = {widthOfSplitterPrimary, m_splitter->width() - widthOfSplitterPrimary - m_splitter->handleWidth()};
  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()) - (viewGeometries.globalXOfPrimary + viewGeometries.widthOfPrimary);
  59     if (trailingSpacing < 0 || emptyTrashButton(Primary)->isVisible() || networkFolderButton(Primary)->isVisible()) {
  60         trailingSpacing = 0;
  61     }
  62     const int widthLeftForUrlNavigator = m_splitter->widget(0)->width() - leadingSpacing - trailingSpacing;
  63     const int widthNeededForUrlNavigator = primaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator;
  64     if (widthNeededForUrlNavigator > 0) {
  65         trailingSpacing -= widthNeededForUrlNavigator;
  66         if (trailingSpacing < 0) {
  67             leadingSpacing += trailingSpacing;
  68             trailingSpacing = 0;
  69         }
  70         if (leadingSpacing < 0) {
  71             leadingSpacing = 0;
  72         }
  73     }
  74     spacing(Primary, Leading)->setMinimumWidth(leadingSpacing);
  75     spacing(Primary, Trailing)->setFixedWidth(trailingSpacing);
  76
  77     // secondary side of m_splitter
  78     if (viewGeometries.globalXOfSecondary == INT_MIN) {
  79         Q_ASSERT(viewGeometries.widthOfSecondary == INT_MIN);
  80         return;
  81     }
  82     spacing(Primary, Trailing)->setFixedWidth(0);
  83
  84     trailingSpacing = (viewGeometries.globalXOfNavigatorsWidget + m_splitter->width()) - (viewGeometries.globalXOfSecondary + viewGeometries.widthOfSecondary);
  85     if (trailingSpacing < 0 || emptyTrashButton(Secondary)->isVisible() || networkFolderButton(Secondary)->isVisible()) {
  86         trailingSpacing = 0;
  87     } else {
  88         const int widthLeftForUrlNavigator2 = m_splitter->widget(1)->width() - trailingSpacing;
  89         const int widthNeededForUrlNavigator2 = secondaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator2;
  90         if (widthNeededForUrlNavigator2 > 0) {
  91             trailingSpacing -= widthNeededForUrlNavigator2;
  92             if (trailingSpacing < 0) {
  93                 trailingSpacing = 0;
  94             }
  95         }
  96     }
  97     spacing(Secondary, Trailing)->setMinimumWidth(trailingSpacing);
  98 }
  99
 100 void DolphinNavigatorsWidgetAction::createSecondaryUrlNavigator()
 101 {
 102     Q_ASSERT(m_splitter->count() == 1);
 103     m_splitter->addWidget(createNavigatorWidget(Secondary));
 104     Q_ASSERT(m_splitter->count() == 2);
 105     updateText();
 106 }
 107
 108 void DolphinNavigatorsWidgetAction::followViewContainersGeometry(QWidget *primaryViewContainer, QWidget *secondaryViewContainer)
 109 {
 110     m_viewGeometriesHelper.setViewContainers(primaryViewContainer, secondaryViewContainer);
 111     adjustSpacing();
 112 }
 113
 114 bool DolphinNavigatorsWidgetAction::isInToolbar() const
 115 {
 116     return qobject_cast<QToolBar *>(m_splitter->parentWidget());
 117 }
 118
 119 DolphinUrlNavigator *DolphinNavigatorsWidgetAction::primaryUrlNavigator() const
 120 {
 121     Q_ASSERT(m_splitter);
 122     return m_splitter->widget(0)->findChild<DolphinUrlNavigator *>();
 123 }
 124
 125 DolphinUrlNavigator *DolphinNavigatorsWidgetAction::secondaryUrlNavigator() const
 126 {
 127     Q_ASSERT(m_splitter);
 128     if (m_splitter->count() < 2) {
 129         return nullptr;
 130     }
 131     return m_splitter->widget(1)->findChild<DolphinUrlNavigator *>();
 132 }
 133
 134 void DolphinNavigatorsWidgetAction::setSecondaryNavigatorVisible(bool visible)
 135 {
 136     if (visible) {
 137         Q_ASSERT(m_splitter->count() == 2);
 138         m_splitter->widget(0)->setContentsMargins(0, 0, m_splitter->style()->pixelMetric(QStyle::PM_LayoutRightMargin), 0);
 139         m_splitter->widget(1)->setContentsMargins(m_splitter->style()->pixelMetric(QStyle::PM_LayoutLeftMargin), 0, 0, 0);
 140         m_splitter->widget(1)->setVisible(true);
 141     } else if (m_splitter->count() > 1) {
 142         m_splitter->widget(1)->setVisible(false);
 143         m_splitter->widget(0)->setContentsMargins(0, 0, 0, 0);
 144         m_splitter->widget(1)->setContentsMargins(0, 0, 0, 0);
 145         // Fix an unlikely event of wrong trash button visibility.
 146         emptyTrashButton(Secondary)->setVisible(false);
 147     }
 148     updateText();
 149 }
 150
 151 QWidget *DolphinNavigatorsWidgetAction::createWidget(QWidget *parent)
 152 {
 153     QWidget *oldParent = m_splitter->parentWidget();
 154     if (oldParent && oldParent->layout()) {
 155         oldParent->layout()->removeWidget(m_splitter.get());
 156         QGridLayout *layout = qobject_cast<QGridLayout *>(oldParent->layout());
 157         if (qobject_cast<QToolBar *>(parent) && layout) {
 158             // in DolphinTabPage::insertNavigatorsWidget the minimumHeight of this row was
 159             // set to fit the m_splitter. Since we are now removing it again, the
 160             // minimumHeight can be reset to 0.
 161             layout->setRowMinimumHeight(0, 0);
 162         }
 163     }
 164     m_splitter->setParent(parent);
 165     return m_splitter.get();
 166 }
 167
 168 void DolphinNavigatorsWidgetAction::deleteWidget(QWidget *widget)
 169 {
 170     Q_UNUSED(widget)
 171     m_splitter->setParent(nullptr);
 172 }
 173
 174 QWidget *DolphinNavigatorsWidgetAction::createNavigatorWidget(Side side) const
 175 {
 176     auto navigatorWidget = new QWidget(m_splitter.get());
 177     auto layout = new QHBoxLayout{navigatorWidget};
 178     layout->setSpacing(0);
 179     layout->setContentsMargins(0, 0, 0, 0);
 180
 181     if (side == Primary) {
 182         auto leadingSpacing = new QWidget{navigatorWidget};
 183         layout->addWidget(leadingSpacing);
 184     }
 185     auto urlNavigator = new DolphinUrlNavigator(navigatorWidget);
 186     layout->addWidget(urlNavigator);
 187
 188     auto emptyTrashButton = newEmptyTrashButton(urlNavigator, navigatorWidget);
 189     layout->addWidget(emptyTrashButton);
 190
 191     auto networkFolderButton = newNetworkFolderButton(urlNavigator, navigatorWidget);
 192     layout->addWidget(networkFolderButton);
 193
 194     connect(
 195         urlNavigator,
 196         &KUrlNavigator::urlChanged,
 197         this,
 198         [urlNavigator, this]() {
 199             // Update URL navigator to show a server URL entry placeholder text if we
 200             // just loaded the remote:/ page, to make it easier for users to figure out
 201             // that they can enter arbitrary remote URLs. See bug 414670
 202             if (urlNavigator->locationUrl().scheme() == QLatin1String("remote")) {
 203                 if (!urlNavigator->isUrlEditable()) {
 204                     urlNavigator->setUrlEditable(true);
 205                 }
 206                 urlNavigator->clearText();
 207                 urlNavigator->setPlaceholderText(i18n("Enter server URL (e.g. smb://[ip address])"));
 208             } else {
 209                 urlNavigator->setPlaceholderText(QString());
 210             }
 211
 212             // We have to wait for DolphinUrlNavigator::sizeHint() to update which
 213             // happens a little bit later than when urlChanged is emitted.
 214             this->m_adjustSpacingTimer->start();
 215         },
 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("edit-delete")), i18nc("@action:button", "Empty Trash"), parent);
 235     emptyTrashButton->setToolTip(i18n("Empties Trash to create free space"));
 236
 237     emptyTrashButton->setFlat(true);
 238     connect(emptyTrashButton, &QPushButton::clicked, this, [parent]() {
 239         Trash::empty(parent);
 240     });
 241     connect(&Trash::instance(), &Trash::emptinessChanged, emptyTrashButton, &QPushButton::setDisabled);
 242     emptyTrashButton->hide();
 243     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [emptyTrashButton, urlNavigator]() {
 244         emptyTrashButton->setVisible(urlNavigator->locationUrl().scheme() == QLatin1String("trash"));
 245     });
 246     emptyTrashButton->setDisabled(Trash::isEmpty());
 247     return emptyTrashButton;
 248 }
 249
 250 QPushButton *DolphinNavigatorsWidgetAction::networkFolderButton(DolphinNavigatorsWidgetAction::Side side)
 251 {
 252     int sideIndex = (side == Primary ? 0 : 1);
 253     if (side == Primary) {
 254         return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget());
 255     }
 256     return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget());
 257 }
 258
 259 QPushButton *DolphinNavigatorsWidgetAction::newNetworkFolderButton(const DolphinUrlNavigator *urlNavigator, QWidget *parent) const
 260 {
 261     auto networkFolderButton = new QPushButton(QIcon::fromTheme(QStringLiteral("folder-add")), i18nc("@action:button", "Add Network Folder"), parent);
 262     networkFolderButton->setFlat(true);
 263     connect(networkFolderButton, &QPushButton::clicked, this, [networkFolderButton]() {
 264         const KService::Ptr service = KService::serviceByDesktopName(QStringLiteral("org.kde.knetattach"));
 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]() {
 273         if (urlNavigator->locationUrl().scheme() == QLatin1String("remote")) {
 274             // Looking up a service can be a bit slow, so we only do it now when it becomes necessary.
 275             const KService::Ptr service = KService::serviceByDesktopName(QStringLiteral("org.kde.knetattach"));
 276             networkFolderButton->setVisible(service);
 277         } else {
 278             networkFolderButton->setVisible(false);
 279         }
 280     });
 281     return networkFolderButton;
 282 }
 283
 284 QWidget *DolphinNavigatorsWidgetAction::spacing(Side side, Position position) const
 285 {
 286     int sideIndex = (side == Primary ? 0 : 1);
 287     if (position == Leading) {
 288         Q_ASSERT(side == Primary); // The secondary side of the splitter has no leading spacing.
 289         return m_splitter->widget(sideIndex)->layout()->itemAt(0)->widget();
 290     }
 291     if (side == Primary) {
 292         return m_splitter->widget(sideIndex)->layout()->itemAt(4)->widget();
 293     }
 294     return m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget();
 295 }
 296
 297 void DolphinNavigatorsWidgetAction::updateText()
 298 {
 299     const int urlNavigatorsAmount = m_splitter->count() > 1 && m_splitter->widget(1)->isVisible() ? 2 : 1;
 300     setText(i18ncp("@action:inmenu", "Location Bar", "Location Bars", urlNavigatorsAmount));
 301 }
 302
 303 DolphinNavigatorsWidgetAction::ViewGeometriesHelper::ViewGeometriesHelper(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 (qobject_cast<QWidget*>(m_navigatorsWidgetAction->parent())->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, 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 DolphinNavigatorsWidgetAction::ViewGeometriesHelper::viewGeometries()
 345 {
 346     Q_ASSERT(m_primaryViewContainer);
 347     Geometries geometries;
 348
 349     // width
 350     geometries.widthOfPrimary = m_primaryViewContainer->width();
 351     if (m_secondaryViewContainer) {
 352         geometries.widthOfSecondary = m_secondaryViewContainer->width();
 353     } else {
 354         geometries.widthOfSecondary = INT_MIN;
 355     }
 356
 357     // globalX
 358     if (QApplication::layoutDirection() == Qt::LeftToRight) {
 359         geometries.globalXOfNavigatorsWidget = m_navigatorsWidget->mapToGlobal(QPoint(0, 0)).x();
 360         geometries.globalXOfPrimary = m_primaryViewContainer->mapToGlobal(QPoint(0, 0)).x();
 361         geometries.globalXOfSecondary = !m_secondaryViewContainer ? INT_MIN : m_secondaryViewContainer->mapToGlobal(QPoint(0, 0)).x();
 362     } else {
 363         // When the direction is reversed, globalX does not change.
 364         // For the adjustSpacing() code to work we need globalX to measure from right to left
 365         // and to measure up to the rightmost point of a widget instead of the leftmost.
 366         geometries.globalXOfNavigatorsWidget = (-1) * (m_navigatorsWidget->mapToGlobal(QPoint(0, 0)).x() + m_navigatorsWidget->width());
 367         geometries.globalXOfPrimary = (-1) * (m_primaryViewContainer->mapToGlobal(QPoint(0, 0)).x() + geometries.widthOfPrimary);
 368         geometries.globalXOfSecondary =
 369             !m_secondaryViewContainer ? INT_MIN : (-1) * (m_secondaryViewContainer->mapToGlobal(QPoint(0, 0)).x() + geometries.widthOfSecondary);
 370     }
 371     return geometries;
 372 }
 373
 374 #include "moc_dolphinnavigatorswidgetaction.cpp"