src/dolphintabwidget.h

   1 /*
   2  * SPDX-FileCopyrightText: 2014 Emmanuel Pescosta <emmanuelpescosta099@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #ifndef DOLPHIN_TAB_WIDGET_H
   8 #define DOLPHIN_TAB_WIDGET_H
   9
  10 #include "dolphinnavigatorswidgetaction.h"
  11 #include "dolphintabpage.h"
  12
  13 #include <QTabWidget>
  14 #include <QUrl>
  15
  16 #include <optional>
  17
  18 class DolphinViewContainer;
  19 class KConfigGroup;
  20
  21 class DolphinTabWidget : public QTabWidget
  22 {
  23     Q_OBJECT
  24
  25 public:
  26     /**
  27      * @param navigatorsWidget The navigatorsWidget which is always going to be connected
  28      *                         to the active tabPage.
  29      */
  30     explicit DolphinTabWidget(DolphinNavigatorsWidgetAction *navigatorsWidget, QWidget *parent);
  31
  32     /**
  33      * Where a newly opened tab should be placed.
  34      */
  35     enum class NewTabPosition {
  36         FollowSetting, ///< Honor openNewTabAfterLastTab setting
  37         AfterCurrent, ///< After the current tab
  38         AtEnd, ///< At the end of the tab bar
  39     };
  40
  41     /**
  42      * @return Tab page at the current index (can be 0 if tabs count is smaller than 1)
  43      */
  44     DolphinTabPage *currentTabPage() const;
  45
  46     /**
  47      * @return the next tab page. If the current active tab is the last tab,
  48      * it returns the first tab. If there is only one tab, returns nullptr
  49      */
  50     DolphinTabPage *nextTabPage() const;
  51
  52     /**
  53      * @return the previous tab page. If the current active tab is the first tab,
  54      * it returns the last tab. If there is only one tab, returns nullptr
  55      */
  56     DolphinTabPage *prevTabPage() const;
  57
  58     /**
  59      * @return Tab page at the given \a index (can be 0 if the index is out-of-range)
  60      */
  61     DolphinTabPage *tabPageAt(const int index) const;
  62
  63     void saveProperties(KConfigGroup &group) const;
  64     void readProperties(const KConfigGroup &group);
  65
  66     /**
  67      * Refreshes the views of the main window by recreating them according to
  68      * the given Dolphin settings.
  69      */
  70     void refreshViews();
  71
  72     /**
  73      * @return Whether any of the tab pages has @p url opened
  74      * in their primary or secondary view.
  75      */
  76     bool isUrlOpen(const QUrl &url) const;
  77
  78     /**
  79      * @return Whether the item with @p url can be found in any view only by switching
  80      * between already open tabs and scrolling in their primary or secondary view.
  81      */
  82     bool isItemVisibleInAnyView(const QUrl &urlOfItem) const;
  83
  84 Q_SIGNALS:
  85     /**
  86      * Is emitted when the active view has been changed, by changing the current
  87      * tab or by activating another view when split view is enabled in the current
  88      * tab.
  89      */
  90     void activeViewChanged(DolphinViewContainer *viewContainer);
  91
  92     /**
  93      * Is emitted when the number of open tabs has changed (e.g. by opening or
  94      * closing a tab)
  95      */
  96     void tabCountChanged(int count);
  97
  98     /**
  99      * Is emitted when a tab has been closed.
 100      */
 101     void rememberClosedTab(const QUrl &url, const QByteArray &state);
 102
 103     /**
 104      * Is emitted when the url of the current tab has been changed. This signal
 105      * is also emitted when the active view has been changed.
 106      */
 107     void currentUrlChanged(const QUrl &url);
 108
 109 public Q_SLOTS:
 110     /**
 111      * Opens a new view with the current URL that is part of a tab and activates
 112      * the tab.
 113      */
 114     void openNewActivatedTab();
 115
 116     /**
 117      * Opens a new tab showing the  URL \a primaryUrl and the optional URL
 118      * \a secondaryUrl and activates the tab.
 119      */
 120     void openNewActivatedTab(const QUrl &primaryUrl, const QUrl &secondaryUrl = QUrl());
 121
 122     /**
 123      * Opens a new tab in the background showing the URL \a primaryUrl and the
 124      * optional URL \a secondaryUrl.
 125      */
 126     void openNewTab(const QUrl &primaryUrl,
 127                     const QUrl &secondaryUrl = QUrl(),
 128                     DolphinTabWidget::NewTabPosition position = DolphinTabWidget::NewTabPosition::FollowSetting);
 129
 130     /**
 131      * Opens each directory in \p dirs in a separate tab unless it is already open.
 132      * If \a splitView is set, 2 directories are collected within one tab.
 133      * \pre \a dirs must contain at least one url.
 134      */
 135     void openDirectories(const QList<QUrl> &dirs, bool splitView);
 136
 137     /**
 138      * Opens the directories which contain the files \p files and selects all files.
 139      * If \a splitView is set, 2 directories are collected within one tab.
 140      * \pre \a files must contain at least one url.
 141      */
 142     void openFiles(const QList<QUrl> &files, bool splitView);
 143
 144     /**
 145      * Closes the currently active tab.
 146      */
 147     void closeTab();
 148
 149     /**
 150      * Closes the tab with the index \a index and activates the tab with index - 1.
 151      */
 152     void closeTab(const int index);
 153
 154     /**
 155      * Activates the tab with the index \a index.
 156      */
 157     void activateTab(const int index);
 158
 159     /**
 160      * Activates the last tab in the tab bar.
 161      */
 162     void activateLastTab();
 163
 164     /**
 165      * Activates the next tab in the tab bar.
 166      * If the current active tab is the last tab, it activates the first tab.
 167      */
 168     void activateNextTab();
 169
 170     /**
 171      * Activates the previous tab in the tab bar.
 172      * If the current active tab is the first tab, it activates the last tab.
 173      */
 174     void activatePrevTab();
 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     /** Copies all selected items to the inactive view. */
 183     void copyToInactiveSplitView();
 184
 185     /** Moves all selected items to the inactive view. */
 186     void moveToInactiveSplitView();
 187
 188 private Q_SLOTS:
 189     /**
 190      * Opens the tab with the index \a index in a new Dolphin instance and closes
 191      * this tab.
 192      */
 193     void detachTab(int index);
 194
 195     /**
 196      * Opens a new tab showing the url from tab at the given \a index and
 197      * activates the tab.
 198      */
 199     void openNewActivatedTab(int index);
 200
 201     /**
 202      * Is connected to the KTabBar signal receivedDropEvent.
 203      * Allows dragging and dropping files onto tabs.
 204      */
 205     void tabDropEvent(int tab, QDropEvent *event);
 206
 207     /**
 208      * The active view url of a tab has been changed so update the text and the
 209      * icon of the corresponding tab.
 210      */
 211     void tabUrlChanged(const QUrl &url);
 212
 213     void currentTabChanged(int index);
 214
 215 protected:
 216     void tabInserted(int index) override;
 217     void tabRemoved(int index) override;
 218
 219 private:
 220     /**
 221      * @param tabPage The tab page to get the name of
 222      * @return The name of the tab page
 223      */
 224     QString tabName(DolphinTabPage *tabPage) const;
 225
 226     struct ViewIndex {
 227         const int tabIndex;
 228         const bool isInPrimaryView;
 229     };
 230
 231     /**
 232      * Getter for a view container.
 233      * @param viewIndex specifies the tab and the view within that tab.
 234      * @return the view container specified in @p viewIndex or nullptr if it doesn't exist.
 235      */
 236     DolphinViewContainer *viewContainerAt(ViewIndex viewIndex) const;
 237
 238     /**
 239      * Makes the view container specified in @p viewIndex become the active view container within this tab widget.
 240      * @param viewIndex Specifies the tab to activate and the view container within the tab to activate.
 241      * @return the freshly activated view container or nullptr if there is no view container at @p viewIndex.
 242      */
 243     DolphinViewContainer *activateViewContainerAt(ViewIndex viewIndex);
 244
 245     /**
 246      * Get the position of the view within this widget that is open at @p directory.
 247      * @param directory The URL of the directory we want to find.
 248      * @return a small struct containing the tab index of the view and whether it is
 249      * in the primary view. A std::nullopt is returned if there is no view open for @p directory.
 250      */
 251     const std::optional<const ViewIndex> viewOpenAtDirectory(const QUrl &directory) const;
 252
 253     /**
 254      * Get the position of the view within this widget that has @p item in the view.
 255      * This means that the item can be seen by the user in that view when scrolled to the right position.
 256      * If the view has folders expanded and @p item is one of them, the view will also be returned.
 257      * @param item The URL of the item we want to find.
 258      * @return a small struct containing the tab index of the view and whether it is
 259      * in the primary view. A std::nullopt is returned if there is no view open that has @p item visible anywhere.
 260      */
 261     const std::optional<const ViewIndex> viewShowingItem(const QUrl &item) const;
 262
 263 private:
 264     QPointer<DolphinTabPage> m_lastViewedTab;
 265     QPointer<DolphinNavigatorsWidgetAction> m_navigatorsWidget;
 266 };
 267
 268 #endif