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 <KXMLGUIFactory>
  14 #include <KXmlGuiWindow>
  15
  16 #include <QApplication>
  17 #include <QDomDocument>
  18 #include <QHBoxLayout>
  19 #include <QPushButton>
  20 #include <QSplitter>
  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     auto viewGeometries = m_viewGeometriesHelper.viewGeometries();
  47     const int widthOfSplitterPrimary = viewGeometries.globalXOfPrimary + viewGeometries.widthOfPrimary - viewGeometries.globalXOfNavigatorsWidget;
  48     const QList<int> splitterSizes = {widthOfSplitterPrimary,
  49                                       m_splitter->width() - widthOfSplitterPrimary};
  50     m_splitter->setSizes(splitterSizes);
  51
  52     // primary side of m_splitter
  53     int leadingSpacing = viewGeometries.globalXOfPrimary - viewGeometries.globalXOfNavigatorsWidget;
  54     if (leadingSpacing < 0) {
  55         leadingSpacing = 0;
  56     }
  57     int trailingSpacing = (viewGeometries.globalXOfNavigatorsWidget + m_splitter->width())
  58                           - (viewGeometries.globalXOfPrimary + viewGeometries.widthOfPrimary);
  59     if (trailingSpacing < 0 || emptyTrashButton(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())
  85                       - (viewGeometries.globalXOfSecondary + viewGeometries.widthOfSecondary);
  86     if (trailingSpacing < 0 || emptyTrashButton(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     updateText();
 107 }
 108
 109 void DolphinNavigatorsWidgetAction::followViewContainersGeometry(QWidget *primaryViewContainer,
 110                                                                  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(1)->setVisible(true);
 141     } else if (m_splitter->count() > 1) {
 142         m_splitter->widget(1)->setVisible(false);
 143         // Fix an unlikely event of wrong trash button visibility.
 144         emptyTrashButton(Secondary)->setVisible(false);
 145     }
 146     updateText();
 147 }
 148
 149 QWidget *DolphinNavigatorsWidgetAction::createWidget(QWidget *parent)
 150 {
 151     QWidget *oldParent = m_splitter->parentWidget();
 152     if (oldParent && oldParent->layout()) {
 153         oldParent->layout()->removeWidget(m_splitter.get());
 154         QGridLayout *layout = qobject_cast<QGridLayout *>(oldParent->layout());
 155         if (qobject_cast<QToolBar *>(parent) && layout) {
 156             // in DolphinTabPage::insertNavigatorsWidget the minimumHeight of this row was
 157             // set to fit the m_splitter. Since we are now removing it again, the
 158             // minimumHeight can be reset to 0.
 159             layout->setRowMinimumHeight(0, 0);
 160         }
 161     }
 162     m_splitter->setParent(parent);
 163     return m_splitter.get();
 164 }
 165
 166 void DolphinNavigatorsWidgetAction::deleteWidget(QWidget *widget)
 167 {
 168     Q_UNUSED(widget)
 169     m_splitter->setParent(nullptr);
 170 }
 171
 172 QWidget *DolphinNavigatorsWidgetAction::createNavigatorWidget(Side side) const
 173 {
 174     auto navigatorWidget = new QWidget(m_splitter.get());
 175     auto layout = new QHBoxLayout{navigatorWidget};
 176     layout->setSpacing(0);
 177     layout->setContentsMargins(0, 0, 0, 0);
 178     if (side == Primary) {
 179         auto leadingSpacing = new QWidget{navigatorWidget};
 180         layout->addWidget(leadingSpacing);
 181     }
 182     auto urlNavigator = new DolphinUrlNavigator(navigatorWidget);
 183     layout->addWidget(urlNavigator);
 184
 185     auto emptyTrashButton = newEmptyTrashButton(urlNavigator, navigatorWidget);
 186     layout->addWidget(emptyTrashButton);
 187
 188     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [urlNavigator, this]() {
 189         // Update URL navigator to show a server URL entry placeholder text if we
 190         // just loaded the remote:/ page, to make it easier for users to figure out
 191         // that they can enter arbitrary remote URLs. See bug 414670
 192         if (urlNavigator->locationUrl().scheme() == QLatin1String("remote")) {
 193             if (!urlNavigator->isUrlEditable()) {
 194                 urlNavigator->setUrlEditable(true);
 195             }
 196             urlNavigator->clearText();
 197             urlNavigator->setPlaceholderText(i18n("Enter server URL (e.g. smb://[ip address])"));
 198         } else {
 199             urlNavigator->setPlaceholderText(QString());
 200         }
 201
 202         // We have to wait for DolphinUrlNavigator::sizeHint() to update which
 203         // happens a little bit later than when urlChanged is emitted.
 204         this->m_adjustSpacingTimer->start();
 205     }, Qt::QueuedConnection);
 206
 207     auto trailingSpacing = new QWidget{navigatorWidget};
 208     layout->addWidget(trailingSpacing);
 209     return navigatorWidget;
 210 }
 211
 212 QPushButton * DolphinNavigatorsWidgetAction::emptyTrashButton(DolphinNavigatorsWidgetAction::Side side)
 213 {
 214     int sideIndex = (side == Primary ? 0 : 1);
 215     if (side == Primary) {
 216         return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget());
 217     }
 218     return static_cast<QPushButton *>(m_splitter->widget(sideIndex)->layout()->itemAt(1)->widget());
 219 }
 220
 221 QPushButton *DolphinNavigatorsWidgetAction::newEmptyTrashButton(const DolphinUrlNavigator *urlNavigator, QWidget *parent) const
 222 {
 223     auto emptyTrashButton = new QPushButton(QIcon::fromTheme(QStringLiteral("user-trash")),
 224                                         i18nc("@action:button", "Empty Trash"), parent);
 225     emptyTrashButton->setFlat(true);
 226     connect(emptyTrashButton, &QPushButton::clicked,
 227             this, [parent]() { Trash::empty(parent); });
 228     connect(&Trash::instance(), &Trash::emptinessChanged,
 229             emptyTrashButton, &QPushButton::setDisabled);
 230     emptyTrashButton->hide();
 231     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [emptyTrashButton, urlNavigator]() {
 232         emptyTrashButton->setVisible(urlNavigator->locationUrl().scheme() == QLatin1String("trash"));
 233     });
 234     emptyTrashButton->setDisabled(Trash::isEmpty());
 235     return emptyTrashButton;
 236 }
 237
 238 QWidget *DolphinNavigatorsWidgetAction::spacing(Side side, Position position) const
 239 {
 240     int sideIndex = (side == Primary ? 0 : 1);
 241     if (position == Leading) {
 242         Q_ASSERT(side == Primary); // The secondary side of the splitter has no leading spacing.
 243         return m_splitter->widget(sideIndex)->layout()->itemAt(0)->widget();
 244     }
 245     if (side == Primary) {
 246         return m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget();
 247     }
 248     return m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget();
 249 }
 250
 251 void DolphinNavigatorsWidgetAction::updateText()
 252 {
 253     const int urlNavigatorsAmount = m_splitter->count() > 1 && m_splitter->widget(1)->isVisible() ?
 254                                     2 : 1;
 255     setText(i18ncp("@action:inmenu", "Location Bar", "Location Bars", urlNavigatorsAmount));
 256 }
 257
 258 DolphinNavigatorsWidgetAction::ViewGeometriesHelper::ViewGeometriesHelper
 259     (QWidget *navigatorsWidget, DolphinNavigatorsWidgetAction *navigatorsWidgetAction) :
 260     m_navigatorsWidget{navigatorsWidget},
 261     m_navigatorsWidgetAction{navigatorsWidgetAction}
 262 {
 263     Q_CHECK_PTR(navigatorsWidget);
 264     Q_CHECK_PTR(navigatorsWidgetAction);
 265 }
 266
 267 bool DolphinNavigatorsWidgetAction::ViewGeometriesHelper::eventFilter(QObject *watched, QEvent *event)
 268 {
 269     if (event->type() == QEvent::Resize) {
 270         m_navigatorsWidgetAction->adjustSpacing();
 271         return false;
 272     }
 273     return QObject::eventFilter(watched, event);
 274 }
 275
 276 void DolphinNavigatorsWidgetAction::ViewGeometriesHelper::setViewContainers(QWidget *primaryViewContainer,
 277                                                                             QWidget *secondaryViewContainer)
 278 {
 279     Q_CHECK_PTR(primaryViewContainer);
 280     if (m_primaryViewContainer) {
 281         m_primaryViewContainer->removeEventFilter(this);
 282     }
 283     primaryViewContainer->installEventFilter(this);
 284     m_primaryViewContainer = primaryViewContainer;
 285
 286     // It is not possible to resize the secondaryViewContainer without simultaneously
 287     // resizing the primaryViewContainer so we don't have to installEventFilter() here.
 288     m_secondaryViewContainer = secondaryViewContainer;
 289 }
 290
 291 DolphinNavigatorsWidgetAction::ViewGeometriesHelper::Geometries
 292         DolphinNavigatorsWidgetAction::ViewGeometriesHelper::viewGeometries()
 293 {
 294     Q_ASSERT(m_primaryViewContainer);
 295     Geometries geometries;
 296
 297     // width
 298     geometries.widthOfPrimary = m_primaryViewContainer->width();
 299     if (m_secondaryViewContainer) {
 300         geometries.widthOfSecondary = m_secondaryViewContainer->width();
 301     } else {
 302         geometries.widthOfSecondary = INT_MIN;
 303     }
 304
 305     // globalX
 306     if (QApplication::layoutDirection() == Qt::LeftToRight) {
 307         geometries.globalXOfNavigatorsWidget = m_navigatorsWidget->mapToGlobal(QPoint(0,0)).x();
 308         geometries.globalXOfPrimary = m_primaryViewContainer->mapToGlobal(QPoint(0,0)).x();
 309         geometries.globalXOfSecondary = !m_secondaryViewContainer ? INT_MIN :
 310                 m_secondaryViewContainer->mapToGlobal(QPoint(0,0)).x();
 311     } else {
 312         // When the direction is reversed, globalX does not change.
 313         // For the adjustSpacing() code to work we need globalX to measure from right to left
 314         // and to measure up to the rightmost point of a widget instead of the leftmost.
 315         geometries.globalXOfNavigatorsWidget =
 316                 (-1) * (m_navigatorsWidget->mapToGlobal(QPoint(0,0)).x() + m_navigatorsWidget->width());
 317         geometries.globalXOfPrimary =
 318                 (-1) * (m_primaryViewContainer->mapToGlobal(QPoint(0,0)).x() + geometries.widthOfPrimary);
 319         geometries.globalXOfSecondary = !m_secondaryViewContainer ? INT_MIN :
 320                 (-1) * (m_secondaryViewContainer->mapToGlobal(QPoint(0,0)).x() + geometries.widthOfSecondary);
 321     }
 322     return geometries;
 323 }