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_globalXOfSplitter{INT_MIN},
  30     m_globalXOfPrimary{INT_MIN},
  31     m_widthOfPrimary{INT_MIN},
  32     m_globalXOfSecondary{INT_MIN},
  33     m_widthOfSecondary{INT_MIN}
  34 {
  35     updateText();
  36     setIcon(QIcon::fromTheme(QStringLiteral("dialog-scripts")));
  37
  38     m_splitter->setChildrenCollapsible(false);
  39
  40     m_splitter->addWidget(createNavigatorWidget(Primary));
  41
  42     m_adjustSpacingTimer->setInterval(100);
  43     m_adjustSpacingTimer->setSingleShot(true);
  44     connect(m_adjustSpacingTimer.get(), &QTimer::timeout,
  45             this, &DolphinNavigatorsWidgetAction::adjustSpacing);
  46 }
  47
  48 void DolphinNavigatorsWidgetAction::createSecondaryUrlNavigator()
  49 {
  50     Q_ASSERT(m_splitter->count() == 1);
  51     m_splitter->addWidget(createNavigatorWidget(Secondary));
  52     Q_ASSERT(m_splitter->count() == 2);
  53     updateText();
  54 }
  55
  56 void DolphinNavigatorsWidgetAction::followViewContainerGeometry(
  57                                     int globalXOfPrimary,   int widthOfPrimary)
  58 {
  59     followViewContainersGeometry(globalXOfPrimary, widthOfPrimary, INT_MIN, INT_MIN);
  60 }
  61
  62 void DolphinNavigatorsWidgetAction::followViewContainersGeometry(
  63                                     int globalXOfPrimary,   int widthOfPrimary,
  64                                     int globalXOfSecondary, int widthOfSecondary)
  65 {
  66     if (QApplication::layoutDirection() == Qt::LeftToRight) {
  67         m_globalXOfSplitter = m_splitter->mapToGlobal(QPoint(0,0)).x();
  68         m_globalXOfPrimary = globalXOfPrimary;
  69         m_globalXOfSecondary = globalXOfSecondary;
  70     } else {
  71         // When the direction is reversed, globalX does not change.
  72         // For the adjustSpacing() code to work we need globalX to measure from right to left
  73         // and to measure up to the rightmost point of a widget instead of the leftmost.
  74         m_globalXOfSplitter = (-1) * (m_splitter->mapToGlobal(QPoint(0,0)).x() + m_splitter->width());
  75         m_globalXOfPrimary = (-1) * (globalXOfPrimary + widthOfPrimary);
  76         m_globalXOfSecondary = (globalXOfSecondary == INT_MIN) ? INT_MIN :
  77                                (-1) * (globalXOfSecondary + widthOfSecondary);
  78     }
  79     m_widthOfPrimary = widthOfPrimary;
  80     m_widthOfSecondary = widthOfSecondary;
  81     adjustSpacing();
  82 }
  83
  84 bool DolphinNavigatorsWidgetAction::isInToolbar() const
  85 {
  86     return qobject_cast<QToolBar *>(m_splitter->parentWidget());
  87 }
  88
  89 DolphinUrlNavigator* DolphinNavigatorsWidgetAction::primaryUrlNavigator() const
  90 {
  91     Q_ASSERT(m_splitter);
  92     return m_splitter->widget(0)->findChild<DolphinUrlNavigator *>();
  93 }
  94
  95 DolphinUrlNavigator* DolphinNavigatorsWidgetAction::secondaryUrlNavigator() const
  96 {
  97     Q_ASSERT(m_splitter);
  98     if (m_splitter->count() < 2) {
  99         return nullptr;
 100     }
 101     return m_splitter->widget(1)->findChild<DolphinUrlNavigator *>();
 102 }
 103
 104 void DolphinNavigatorsWidgetAction::setSecondaryNavigatorVisible(bool visible)
 105 {
 106     if (visible) {
 107         Q_ASSERT(m_splitter->count() == 2);
 108         m_splitter->widget(1)->setVisible(true);
 109     } else if (m_splitter->count() > 1) {
 110         m_splitter->widget(1)->setVisible(false);
 111         // Fix an unlikely event of wrong trash button visibility.
 112         emptyTrashButton(Secondary)->setVisible(false);
 113     }
 114     updateText();
 115 }
 116
 117 QWidget *DolphinNavigatorsWidgetAction::createWidget(QWidget *parent)
 118 {
 119     QWidget *oldParent = m_splitter->parentWidget();
 120     if (oldParent && oldParent->layout()) {
 121         oldParent->layout()->removeWidget(m_splitter.get());
 122         QGridLayout *layout = qobject_cast<QGridLayout *>(oldParent->layout());
 123         if (qobject_cast<QToolBar *>(parent) && layout) {
 124             // in DolphinTabPage::insertNavigatorsWidget the minimumHeight of this row was
 125             // set to fit the m_splitter. Since we are now removing it again, the
 126             // minimumHeight can be reset to 0.
 127             layout->setRowMinimumHeight(0, 0);
 128         }
 129     }
 130     m_splitter->setParent(parent);
 131     return m_splitter.get();
 132 }
 133
 134 void DolphinNavigatorsWidgetAction::deleteWidget(QWidget *widget)
 135 {
 136     Q_UNUSED(widget)
 137     m_splitter->setParent(nullptr);
 138 }
 139
 140 void DolphinNavigatorsWidgetAction::adjustSpacing()
 141 {
 142     Q_ASSERT(m_globalXOfSplitter != INT_MIN);
 143     Q_ASSERT(m_globalXOfPrimary  != INT_MIN);
 144     Q_ASSERT(m_widthOfPrimary    != INT_MIN);
 145     const int widthOfSplitterPrimary = m_globalXOfPrimary + m_widthOfPrimary - m_globalXOfSplitter;
 146     const QList<int> splitterSizes = {widthOfSplitterPrimary,
 147                                       m_splitter->width() - widthOfSplitterPrimary};
 148     m_splitter->setSizes(splitterSizes);
 149
 150     // primary side of m_splitter
 151     int leadingSpacing = m_globalXOfPrimary - m_globalXOfSplitter;
 152     if (leadingSpacing < 0) {
 153         leadingSpacing = 0;
 154     }
 155     int trailingSpacing = (m_globalXOfSplitter + m_splitter->width())
 156                           - (m_globalXOfPrimary + m_widthOfPrimary);
 157     if (trailingSpacing < 0 || emptyTrashButton(Primary)->isVisible()) {
 158         trailingSpacing = 0;
 159     }
 160     const int widthLeftForUrlNavigator = m_splitter->widget(0)->width() - leadingSpacing - trailingSpacing;
 161     const int widthNeededForUrlNavigator = primaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator;
 162     if (widthNeededForUrlNavigator > 0) {
 163         trailingSpacing -= widthNeededForUrlNavigator;
 164         if (trailingSpacing < 0) {
 165             leadingSpacing += trailingSpacing;
 166             trailingSpacing = 0;
 167         }
 168         if (leadingSpacing < 0) {
 169             leadingSpacing = 0;
 170         }
 171     }
 172     spacing(Primary, Leading)->setMinimumWidth(leadingSpacing);
 173     spacing(Primary, Trailing)->setFixedWidth(trailingSpacing);
 174
 175     // secondary side of m_splitter
 176     if (m_globalXOfSecondary == INT_MIN) {
 177         Q_ASSERT(m_widthOfSecondary == INT_MIN);
 178         return;
 179     }
 180     spacing(Primary, Trailing)->setFixedWidth(0);
 181
 182     trailingSpacing = (m_globalXOfSplitter + m_splitter->width())
 183                       - (m_globalXOfSecondary + m_widthOfSecondary);
 184     if (trailingSpacing < 0 || emptyTrashButton(Secondary)->isVisible()) {
 185         trailingSpacing = 0;
 186     } else {
 187         const int widthLeftForUrlNavigator2 = m_splitter->widget(1)->width() - trailingSpacing;
 188         const int widthNeededForUrlNavigator2 = secondaryUrlNavigator()->sizeHint().width() - widthLeftForUrlNavigator2;
 189         if (widthNeededForUrlNavigator2 > 0) {
 190             trailingSpacing -= widthNeededForUrlNavigator2;
 191             if (trailingSpacing < 0) {
 192                 trailingSpacing = 0;
 193             }
 194         }
 195     }
 196     spacing(Secondary, Trailing)->setMinimumWidth(trailingSpacing);
 197 }
 198
 199 QWidget *DolphinNavigatorsWidgetAction::createNavigatorWidget(Side side) const
 200 {
 201     auto navigatorWidget = new QWidget(m_splitter.get());
 202     auto layout = new QHBoxLayout{navigatorWidget};
 203     layout->setSpacing(0);
 204     layout->setContentsMargins(0, 0, 0, 0);
 205     if (side == Primary) {
 206         auto leadingSpacing = new QWidget{navigatorWidget};
 207         layout->addWidget(leadingSpacing);
 208     }
 209     auto urlNavigator = new DolphinUrlNavigator(navigatorWidget);
 210     layout->addWidget(urlNavigator);
 211
 212     auto emptyTrashButton = newEmptyTrashButton(urlNavigator, navigatorWidget);
 213     layout->addWidget(emptyTrashButton);
 214
 215     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [urlNavigator, this]() {
 216         // Update URL navigator to show a server URL entry placeholder text if we
 217         // just loaded the remote:/ page, to make it easier for users to figure out
 218         // that they can enter arbitrary remote URLs. See bug 414670
 219         if (urlNavigator->locationUrl().scheme() == QLatin1String("remote")) {
 220             if (!urlNavigator->isUrlEditable()) {
 221                 urlNavigator->setUrlEditable(true);
 222             }
 223             urlNavigator->clearText();
 224             urlNavigator->setPlaceholderText(i18n("Enter server URL (e.g. smb://[ip address])"));
 225         } else {
 226             urlNavigator->setPlaceholderText(QString());
 227         }
 228
 229         // We have to wait for DolphinUrlNavigator::sizeHint() to update which
 230         // happens a little bit later than when urlChanged is emitted.
 231         this->m_adjustSpacingTimer->start();
 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("user-trash")),
 251                                         i18nc("@action:button", "Empty Trash"), parent);
 252     emptyTrashButton->setFlat(true);
 253     connect(emptyTrashButton, &QPushButton::clicked,
 254             this, [parent]() { Trash::empty(parent); });
 255     connect(&Trash::instance(), &Trash::emptinessChanged,
 256             emptyTrashButton, &QPushButton::setDisabled);
 257     emptyTrashButton->hide();
 258     connect(urlNavigator, &KUrlNavigator::urlChanged, this, [emptyTrashButton, urlNavigator]() {
 259         emptyTrashButton->setVisible(urlNavigator->locationUrl().scheme() == QLatin1String("trash"));
 260     });
 261     emptyTrashButton->setDisabled(Trash::isEmpty());
 262     return emptyTrashButton;
 263 }
 264
 265 QWidget *DolphinNavigatorsWidgetAction::spacing(Side side, Position position) const
 266 {
 267     int sideIndex = (side == Primary ? 0 : 1);
 268     if (position == Leading) {
 269         Q_ASSERT(side == Primary); // The secondary side of the splitter has no leading spacing.
 270         return m_splitter->widget(sideIndex)->layout()->itemAt(0)->widget();
 271     }
 272     if (side == Primary) {
 273         return m_splitter->widget(sideIndex)->layout()->itemAt(3)->widget();
 274     }
 275     return m_splitter->widget(sideIndex)->layout()->itemAt(2)->widget();
 276 }
 277
 278 void DolphinNavigatorsWidgetAction::updateText()
 279 {
 280     const int urlNavigatorsAmount = m_splitter->count() > 1 && m_splitter->widget(1)->isVisible() ?
 281                                     2 : 1;
 282     setText(i18ncp("@action:inmenu", "Location Bar", "Location Bars", urlNavigatorsAmount));
 283 }