src/dolphintabwidget.cpp

   1 /***************************************************************************
   2  * Copyright (C) 2014 by Emmanuel Pescosta <emmanuelpescosta099@gmail.com> *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #include "dolphintabwidget.h"
  21
  22 #include "dolphin_generalsettings.h"
  23 #include "dolphintabbar.h"
  24 #include "dolphintabpage.h"
  25 #include "dolphinviewcontainer.h"
  26
  27 #include <KConfigGroup>
  28 #include <KRun>
  29 #include <KShell>
  30 #include <kio/global.h>
  31
  32 #include <QApplication>
  33 #include <QDropEvent>
  34
  35 DolphinTabWidget::DolphinTabWidget(QWidget* parent) :
  36     QTabWidget(parent),
  37     m_placesSelectorVisible(true),
  38     m_lastViewedTab(0)
  39 {
  40     connect(this, &DolphinTabWidget::tabCloseRequested,
  41             this, QOverload<int>::of(&DolphinTabWidget::closeTab));
  42     connect(this, &DolphinTabWidget::currentChanged,
  43             this, &DolphinTabWidget::currentTabChanged);
  44
  45     DolphinTabBar* tabBar = new DolphinTabBar(this);
  46     connect(tabBar, &DolphinTabBar::openNewActivatedTab,
  47             this, QOverload<int>::of(&DolphinTabWidget::openNewActivatedTab));
  48     connect(tabBar, &DolphinTabBar::tabDropEvent,
  49             this, &DolphinTabWidget::tabDropEvent);
  50     connect(tabBar, &DolphinTabBar::tabDetachRequested,
  51             this, &DolphinTabWidget::detachTab);
  52     tabBar->hide();
  53
  54     setTabBar(tabBar);
  55     setDocumentMode(true);
  56     setElideMode(Qt::ElideRight);
  57     setUsesScrollButtons(true);
  58 }
  59
  60 DolphinTabPage* DolphinTabWidget::currentTabPage() const
  61 {
  62     return tabPageAt(currentIndex());
  63 }
  64
  65 DolphinTabPage* DolphinTabWidget::nextTabPage() const
  66 {
  67     const int index = currentIndex() + 1;
  68     return tabPageAt(index < count() ? index : 0);
  69 }
  70
  71 DolphinTabPage* DolphinTabWidget::prevTabPage() const
  72 {
  73     const int index = currentIndex() - 1;
  74     return tabPageAt(index >= 0 ? index : (count() - 1));
  75 }
  76
  77 DolphinTabPage* DolphinTabWidget::tabPageAt(const int index) const
  78 {
  79     return static_cast<DolphinTabPage*>(widget(index));
  80 }
  81
  82 void DolphinTabWidget::saveProperties(KConfigGroup& group) const
  83 {
  84     const int tabCount = count();
  85     group.writeEntry("Tab Count", tabCount);
  86     group.writeEntry("Active Tab Index", currentIndex());
  87
  88     for (int i = 0; i < tabCount; ++i) {
  89         const DolphinTabPage* tabPage = tabPageAt(i);
  90         group.writeEntry("Tab Data " % QString::number(i), tabPage->saveState());
  91     }
  92 }
  93
  94 void DolphinTabWidget::readProperties(const KConfigGroup& group)
  95 {
  96     const int tabCount = group.readEntry("Tab Count", 0);
  97     for (int i = 0; i < tabCount; ++i) {
  98         if (i >= count()) {
  99             openNewActivatedTab();
 100         }
 101         if (group.hasKey("Tab Data " % QString::number(i))) {
 102             // Tab state created with Dolphin > 4.14.x
 103             const QByteArray state = group.readEntry("Tab Data " % QString::number(i), QByteArray());
 104             tabPageAt(i)->restoreState(state);
 105         } else {
 106             // Tab state created with Dolphin <= 4.14.x
 107             const QByteArray state = group.readEntry("Tab " % QString::number(i), QByteArray());
 108             tabPageAt(i)->restoreStateV1(state);
 109         }
 110     }
 111
 112     const int index = group.readEntry("Active Tab Index", 0);
 113     setCurrentIndex(index);
 114 }
 115
 116 void DolphinTabWidget::refreshViews()
 117 {
 118     // Left-elision is better when showing full paths, since you care most
 119     // about the current directory which is on the right
 120     if (GeneralSettings::showFullPathInTitlebar()) {
 121         setElideMode(Qt::ElideLeft);
 122     } else {
 123         setElideMode(Qt::ElideRight);
 124     }
 125
 126     const int tabCount = count();
 127     for (int i = 0; i < tabCount; ++i) {
 128         tabBar()->setTabText(i, tabName(tabPageAt(i)));
 129         tabPageAt(i)->refreshViews();
 130     }
 131 }
 132
 133 void DolphinTabWidget::openNewActivatedTab()
 134 {
 135     const DolphinViewContainer* oldActiveViewContainer = currentTabPage()->activeViewContainer();
 136     Q_ASSERT(oldActiveViewContainer);
 137
 138     const bool isUrlEditable = oldActiveViewContainer->urlNavigator()->isUrlEditable();
 139
 140     openNewActivatedTab(oldActiveViewContainer->url());
 141
 142     DolphinViewContainer* newActiveViewContainer = currentTabPage()->activeViewContainer();
 143     Q_ASSERT(newActiveViewContainer);
 144
 145     // The URL navigator of the new tab should have the same editable state
 146     // as the current tab
 147     newActiveViewContainer->urlNavigator()->setUrlEditable(isUrlEditable);
 148
 149     // Always focus the new tab's view
 150     newActiveViewContainer->view()->setFocus();
 151 }
 152
 153 void DolphinTabWidget::openNewActivatedTab(const QUrl& primaryUrl, const QUrl& secondaryUrl)
 154 {
 155     openNewTab(primaryUrl, secondaryUrl);
 156     setCurrentIndex(count() - 1);
 157 }
 158
 159 void DolphinTabWidget::openNewTab(const QUrl& primaryUrl, const QUrl& secondaryUrl, TabPlacement tabPlacement)
 160 {
 161     QWidget* focusWidget = QApplication::focusWidget();
 162
 163     DolphinTabPage* tabPage = new DolphinTabPage(primaryUrl, secondaryUrl, this);
 164     tabPage->setActive(false);
 165     tabPage->setPlacesSelectorVisible(m_placesSelectorVisible);
 166     connect(tabPage, &DolphinTabPage::activeViewChanged,
 167             this, &DolphinTabWidget::activeViewChanged);
 168     connect(tabPage, &DolphinTabPage::activeViewUrlChanged,
 169             this, &DolphinTabWidget::tabUrlChanged);
 170     int newTabIndex = -1;
 171     if (tabPlacement == AfterCurrentTab) {
 172         newTabIndex = currentIndex() + 1;
 173     }
 174     insertTab(newTabIndex, tabPage, QIcon() /* loaded in tabInserted */, tabName(tabPage));
 175
 176     if (focusWidget) {
 177         // The DolphinViewContainer grabbed the keyboard focus. As the tab is opened
 178         // in background, assure that the previous focused widget gets the focus back.
 179         focusWidget->setFocus();
 180     }
 181 }
 182
 183 void DolphinTabWidget::openDirectories(const QList<QUrl>& dirs, bool splitView)
 184 {
 185     Q_ASSERT(dirs.size() > 0);
 186
 187     QList<QUrl>::const_iterator it = dirs.constBegin();
 188     while (it != dirs.constEnd()) {
 189         const QUrl& primaryUrl = *(it++);
 190         const QPair<int, bool> viewLocation = getIndexByUrl(primaryUrl);
 191         if (viewLocation.first >= 0) {
 192             setCurrentIndex(viewLocation.first);
 193             const auto tabPage = tabPageAt(viewLocation.first);
 194             if (viewLocation.second) {
 195                 tabPage->primaryViewContainer()->setActive(true);
 196             } else {
 197                 tabPage->secondaryViewContainer()->setActive(true);
 198             }
 199             continue;
 200         }
 201         if (splitView && (it != dirs.constEnd())) {
 202             const QUrl& secondaryUrl = *(it++);
 203             openNewActivatedTab(primaryUrl, secondaryUrl);
 204         } else {
 205             openNewActivatedTab(primaryUrl);
 206         }
 207     }
 208 }
 209
 210 void DolphinTabWidget::openFiles(const QList<QUrl>& files, bool splitView)
 211 {
 212     Q_ASSERT(files.size() > 0);
 213
 214     // Get all distinct directories from 'files' and open a tab
 215     // for each directory. If the "split view" option is enabled, two
 216     // directories are shown inside one tab (see openDirectories()).
 217     QList<QUrl> dirs;
 218     foreach (const QUrl& url, files) {
 219         const QUrl dir(url.adjusted(QUrl::RemoveFilename));
 220         if (!dirs.contains(dir)) {
 221             dirs.append(dir);
 222         }
 223     }
 224
 225     const int oldTabCount = count();
 226     openDirectories(dirs, splitView);
 227     const int tabCount = count();
 228
 229     // Select the files. Although the files can be split between several
 230     // tabs, there is no need to split 'files' accordingly, as
 231     // the DolphinView will just ignore invalid selections.
 232     for (int i = oldTabCount; i < tabCount; ++i) {
 233         DolphinTabPage* tabPage = tabPageAt(i);
 234         tabPage->markUrlsAsSelected(files);
 235         tabPage->markUrlAsCurrent(files.first());
 236     }
 237 }
 238
 239 void DolphinTabWidget::closeTab()
 240 {
 241     closeTab(currentIndex());
 242 }
 243
 244 void DolphinTabWidget::closeTab(const int index)
 245 {
 246     Q_ASSERT(index >= 0);
 247     Q_ASSERT(index < count());
 248
 249     if (count() < 2) {
 250         // Close Dolphin when closing the last tab.
 251         parentWidget()->close();
 252         return;
 253     }
 254
 255     DolphinTabPage* tabPage = tabPageAt(index);
 256     emit rememberClosedTab(tabPage->activeViewContainer()->url(), tabPage->saveState());
 257
 258     removeTab(index);
 259     tabPage->deleteLater();
 260 }
 261
 262 void DolphinTabWidget::activateNextTab()
 263 {
 264     const int index = currentIndex() + 1;
 265     setCurrentIndex(index < count() ? index : 0);
 266 }
 267
 268 void DolphinTabWidget::activatePrevTab()
 269 {
 270     const int index = currentIndex() - 1;
 271     setCurrentIndex(index >= 0 ? index : (count() - 1));
 272 }
 273
 274 void DolphinTabWidget::slotPlacesPanelVisibilityChanged(bool visible)
 275 {
 276     // The places-selector from the URL navigator should only be shown
 277     // if the places dock is invisible
 278     m_placesSelectorVisible = !visible;
 279
 280     const int tabCount = count();
 281     for (int i = 0; i < tabCount; ++i) {
 282         DolphinTabPage* tabPage = tabPageAt(i);
 283         tabPage->setPlacesSelectorVisible(m_placesSelectorVisible);
 284     }
 285 }
 286
 287 void DolphinTabWidget::restoreClosedTab(const QByteArray& state)
 288 {
 289     openNewActivatedTab();
 290     currentTabPage()->restoreState(state);
 291 }
 292
 293 void DolphinTabWidget::detachTab(int index)
 294 {
 295     Q_ASSERT(index >= 0);
 296
 297     QStringList args;
 298
 299     const DolphinTabPage* tabPage = tabPageAt(index);
 300     args << tabPage->primaryViewContainer()->url().url();
 301     if (tabPage->splitViewEnabled()) {
 302         args << tabPage->secondaryViewContainer()->url().url();
 303         args << QStringLiteral("--split");
 304     }
 305     args << QStringLiteral("--new-window");
 306
 307     const QString command = QStringLiteral("dolphin %1").arg(KShell::joinArgs(args));
 308     KRun::runCommand(command, this);
 309
 310     closeTab(index);
 311 }
 312
 313 void DolphinTabWidget::openNewActivatedTab(int index)
 314 {
 315     Q_ASSERT(index >= 0);
 316     const DolphinTabPage* tabPage = tabPageAt(index);
 317     openNewActivatedTab(tabPage->activeViewContainer()->url());
 318 }
 319
 320 void DolphinTabWidget::tabDropEvent(int index, QDropEvent* event)
 321 {
 322     if (index >= 0) {
 323         DolphinView* view = tabPageAt(index)->activeViewContainer()->view();
 324         view->dropUrls(view->url(), event, view);
 325     }
 326 }
 327
 328 void DolphinTabWidget::tabUrlChanged(const QUrl& url)
 329 {
 330     const int index = indexOf(qobject_cast<QWidget*>(sender()));
 331     if (index >= 0) {
 332         tabBar()->setTabText(index, tabName(tabPageAt(index)));
 333         if (tabBar()->isVisible()) {
 334             tabBar()->setTabIcon(index, QIcon::fromTheme(KIO::iconNameForUrl(url)));
 335         } else {
 336             // Mark as dirty, actually load once the tab bar actually gets shown
 337             tabBar()->setTabIcon(index, QIcon());
 338         }
 339
 340         // Emit the currentUrlChanged signal if the url of the current tab has been changed.
 341         if (index == currentIndex()) {
 342             emit currentUrlChanged(url);
 343         }
 344     }
 345 }
 346
 347 void DolphinTabWidget::currentTabChanged(int index)
 348 {
 349     // last-viewed tab deactivation
 350     if (DolphinTabPage* tabPage = tabPageAt(m_lastViewedTab)) {
 351         tabPage->setActive(false);
 352     }
 353     DolphinTabPage* tabPage = tabPageAt(index);
 354     DolphinViewContainer* viewContainer = tabPage->activeViewContainer();
 355     emit activeViewChanged(viewContainer);
 356     emit currentUrlChanged(viewContainer->url());
 357     tabPage->setActive(true);
 358     m_lastViewedTab = index;
 359 }
 360
 361 void DolphinTabWidget::tabInserted(int index)
 362 {
 363     QTabWidget::tabInserted(index);
 364
 365     if (count() > 1) {
 366         // Resolve all pending tab icons
 367         for (int i = 0; i < count(); ++i) {
 368             if (tabBar()->tabIcon(i).isNull()) {
 369                 tabBar()->setTabIcon(i, QIcon::fromTheme(KIO::iconNameForUrl(tabPageAt(i)->activeViewContainer()->url())));
 370             }
 371         }
 372
 373         tabBar()->show();
 374     }
 375
 376     emit tabCountChanged(count());
 377 }
 378
 379 void DolphinTabWidget::tabRemoved(int index)
 380 {
 381     QTabWidget::tabRemoved(index);
 382
 383     // If only one tab is left, then remove the tab entry so that
 384     // closing the last tab is not possible.
 385     if (count() < 2) {
 386         tabBar()->hide();
 387     }
 388
 389     emit tabCountChanged(count());
 390 }
 391
 392 QString DolphinTabWidget::tabName(DolphinTabPage* tabPage) const
 393 {
 394     if (!tabPage) {
 395         return QString();
 396     }
 397     QString name = tabPage->activeViewContainer()->caption();
 398     // Make sure that a '&' inside the directory name is displayed correctly
 399     // and not misinterpreted as a keyboard shortcut in QTabBar::setTabText()
 400     return name.replace('&', QLatin1String("&&"));
 401 }
 402
 403 QPair<int, bool> DolphinTabWidget::getIndexByUrl(const QUrl& url) const
 404 {
 405     for (int i = 0; i < count(); i++) {
 406         const auto tabPage = tabPageAt(i);
 407         if (url == tabPage->primaryViewContainer()->url()) {
 408             return qMakePair(i, true);
 409         }
 410
 411         if (tabPage->splitViewEnabled() && url == tabPage->secondaryViewContainer()->url()) {
 412             return qMakePair(i, false);
 413         }
 414     }
 415     return qMakePair(-1, false);
 416 }