src/dolphintabwidget.h

   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 #ifndef DOLPHIN_TAB_WIDGET_H
  21 #define DOLPHIN_TAB_WIDGET_H
  22
  23 #include <QTabWidget>
  24 #include <QUrl>
  25
  26 class DolphinViewContainer;
  27 class DolphinTabPage;
  28 class KConfigGroup;
  29
  30 class DolphinTabWidget : public QTabWidget
  31 {
  32     Q_OBJECT
  33
  34 public:
  35     /**
  36      * @brief Controls where tabs are placed
  37      */
  38     enum TabPlacement {
  39         /**
  40           * The new tab is placed after the current tab
  41           */
  42         AfterCurrentTab,
  43         /**
  44           * The new tab is placed after the last tab
  45           */
  46         AfterLastTab
  47     };
  48     explicit DolphinTabWidget(QWidget* parent);
  49
  50     /**
  51      * @return Tab page at the current index (can be 0 if tabs count is smaller than 1)
  52      */
  53     DolphinTabPage* currentTabPage() const;
  54
  55     /**
  56      * @return the next tab page. If the current active tab is the last tab,
  57      * it returns the first tab. If there is only one tab, returns nullptr
  58      */
  59     DolphinTabPage* nextTabPage() const;
  60
  61     /**
  62      * @return the previous tab page. If the current active tab is the first tab,
  63      * it returns the last tab. If there is only one tab, returns nullptr
  64      */
  65     DolphinTabPage* prevTabPage() const;
  66
  67     /**
  68      * @return Tab page at the given \a index (can be 0 if the index is out-of-range)
  69      */
  70     DolphinTabPage* tabPageAt(const int index) const;
  71
  72     void saveProperties(KConfigGroup& group) const;
  73     void readProperties(const KConfigGroup& group);
  74
  75     /**
  76      * Refreshes the views of the main window by recreating them according to
  77      * the given Dolphin settings.
  78      */
  79     void refreshViews();
  80
  81     /**
  82      * @param url The URL that we would like
  83      * @return index of the tab with the desired URL. returns -1 if not found
  84      */
  85     int getIndexByUrl(const QUrl& url) const;
  86
  87 signals:
  88     /**
  89      * Is emitted when the active view has been changed, by changing the current
  90      * tab or by activating another view when split view is enabled in the current
  91      * tab.
  92      */
  93     void activeViewChanged(DolphinViewContainer* viewContainer);
  94
  95     /**
  96      * Is emitted when the number of open tabs has changed (e.g. by opening or
  97      * closing a tab)
  98      */
  99     void tabCountChanged(int count);
 100
 101     /**
 102      * Is emitted when a tab has been closed.
 103      */
 104     void rememberClosedTab(const QUrl& url, const QByteArray& state);
 105
 106     /**
 107      * Is emitted when the url of the current tab has been changed. This signal
 108      * is also emitted when the active view has been changed.
 109      */
 110     void currentUrlChanged(const QUrl& url);
 111
 112 public slots:
 113     /**
 114      * Opens a new view with the current URL that is part of a tab and activates
 115      * the tab.
 116      */
 117     void openNewActivatedTab();
 118
 119     /**
 120      * Opens a new tab showing the  URL \a primaryUrl and the optional URL
 121      * \a secondaryUrl and activates the tab.
 122      */
 123     void openNewActivatedTab(const QUrl& primaryUrl, const QUrl& secondaryUrl = QUrl());
 124
 125     /**
 126      * Opens a new tab in the background showing the URL \a primaryUrl and the
 127      * optional URL \a secondaryUrl. \a tabPlacement controls where the new tab
 128      * is placed.
 129      */
 130     void openNewTab(const QUrl &primaryUrl, const QUrl &secondaryUrl = QUrl(),
 131                     DolphinTabWidget::TabPlacement tabPlacement = AfterLastTab);
 132
 133     /**
 134      * Opens each directory in \p dirs in a separate tab. If \a splitView is set,
 135      * 2 directories are collected within one tab.
 136      * \pre \a dirs must contain at least one url.
 137      */
 138     void openDirectories(const QList<QUrl>& dirs, bool splitView);
 139
 140     /**
 141      * Opens the directories which contain the files \p files and selects all files.
 142      * If \a splitView is set, 2 directories are collected within one tab.
 143      * \pre \a files must contain at least one url.
 144      */
 145     void openFiles(const QList<QUrl> &files, bool splitView);
 146
 147     /**
 148      * Closes the currently active tab.
 149      */
 150     void closeTab();
 151
 152     /**
 153      * Closes the tab with the index \a index and activates the tab with index - 1.
 154      */
 155     void closeTab(const int index);
 156
 157     /**
 158      * Activates the next tab in the tab bar.
 159      * If the current active tab is the last tab, it activates the first tab.
 160      */
 161     void activateNextTab();
 162
 163     /**
 164      * Activates the previous tab in the tab bar.
 165      * If the current active tab is the first tab, it activates the last tab.
 166      */
 167     void activatePrevTab();
 168
 169     /**
 170      * Is invoked if the Places panel got visible/invisible and takes care
 171      * that the places-selector of all views is only shown if the Places panel
 172      * is invisible.
 173      */
 174     void slotPlacesPanelVisibilityChanged(bool visible);
 175
 176     /**
 177      * Is called when the user wants to reopen a previously closed tab from
 178      * the recent tabs menu.
 179      */
 180     void restoreClosedTab(const QByteArray& state);
 181
 182 private slots:
 183     /**
 184      * Opens the tab with the index \a index in a new Dolphin instance and closes
 185      * this tab.
 186      */
 187     void detachTab(int index);
 188
 189     /**
 190      * Opens a new tab showing the url from tab at the given \a index and
 191      * activates the tab.
 192      */
 193     void openNewActivatedTab(int index);
 194
 195     /**
 196      * Is connected to the KTabBar signal receivedDropEvent.
 197      * Allows dragging and dropping files onto tabs.
 198      */
 199     void tabDropEvent(int tab, QDropEvent* event);
 200
 201     /**
 202      * The active view url of a tab has been changed so update the text and the
 203      * icon of the corresponding tab.
 204      */
 205     void tabUrlChanged(const QUrl& url);
 206
 207     void currentTabChanged(int index);
 208
 209 protected:
 210     void tabInserted(int index) override;
 211     void tabRemoved(int index) override;
 212
 213 private:
 214     /**
 215      * @param tabPage The tab page to get the name of
 216      * @return The name of the tab page
 217      */
 218     QString tabName(DolphinTabPage* tabPage) const;
 219
 220 private:
 221     /** Caches the (negated) places panel visibility */
 222     bool m_placesSelectorVisible;
 223
 224     int m_lastViewedTab;
 225 };
 226
 227 #endif