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