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      * Update the name of the tab with the index \a index.
  74      */
  75     void updateTabName(int index);
  76
  77     /**
  78      * @return Whether any of the tab pages has @p url opened
  79      * in their primary or secondary view.
  80      */
  81     bool isUrlOpen(const QUrl &url) const;
  82
  83     /**
  84      * @return Whether the item with @p url can be found in any view only by switching
  85      * between already open tabs and scrolling in their primary or secondary view.
  86      */
  87     bool isItemVisibleInAnyView(const QUrl &urlOfItem) const;
  88
  89 Q_SIGNALS:
  90     /**
  91      * Is emitted when the active view has been changed, by changing the current
  92      * tab or by activating another view when split view is enabled in the current
  93      * tab.
  94      */
  95     void activeViewChanged(DolphinViewContainer *viewContainer);
  96
  97     /**
  98      * Is emitted when the number of open tabs has changed (e.g. by opening or
  99      * closing a tab)
 100      */
 101     void tabCountChanged(int count);
 102
 103     /**
 104      * Is emitted when a tab has been closed.
 105      */
 106     void rememberClosedTab(const QUrl &url, const QByteArray &state);
 107
 108     /**
 109      * Is emitted when the url of the current tab has been changed. This signal
 110      * is also emitted when the active view has been changed.
 111      */
 112     void currentUrlChanged(const QUrl &url);
 113
 114     /**
 115      * Is emitted when the url of any tab has been changed (including the current tab).
 116      */
 117     void urlChanged(const QUrl &url);
 118
 119 public Q_SLOTS:
 120     /**
 121      * Opens a new view with the current URL that is part of a tab and activates
 122      * the tab.
 123      */
 124     void openNewActivatedTab();
 125
 126     /**
 127      * Opens a new tab showing the  URL \a primaryUrl and the optional URL
 128      * \a secondaryUrl and activates the tab.
 129      */
 130     void openNewActivatedTab(const QUrl &primaryUrl, const QUrl &secondaryUrl = QUrl());
 131
 132     /**
 133      * Opens a new tab in the background showing the URL \a primaryUrl and the
 134      * optional URL \a secondaryUrl.
 135      * @return A pointer to the opened DolphinTabPage.
 136      */
 137     DolphinTabPage *openNewTab(const QUrl &primaryUrl,
 138                                const QUrl &secondaryUrl = QUrl(),
 139                                DolphinTabWidget::NewTabPosition position = DolphinTabWidget::NewTabPosition::FollowSetting);
 140
 141     /**
 142      * Opens each directory in \p dirs in a separate tab unless it is already open.
 143      * If \a splitView is set, 2 directories are collected within one tab.
 144      * \pre \a dirs must contain at least one url.
 145      */
 146     void openDirectories(const QList<QUrl> &dirs, bool splitView);
 147
 148     /**
 149      * Opens the directories which contain the files \p files and selects all files.
 150      * If \a splitView is set, 2 directories are collected within one tab.
 151      * \pre \a files must contain at least one url.
 152      */
 153     void openFiles(const QList<QUrl> &files, bool splitView);
 154
 155     /**
 156      * Closes the currently active tab.
 157      */
 158     void closeTab();
 159
 160     /**
 161      * Closes the tab with the index \a index and activates the tab with index - 1.
 162      */
 163     void closeTab(const int index);
 164
 165     /**
 166      * Activates the tab with the index \a index.
 167      */
 168     void activateTab(const int index);
 169
 170     /**
 171      * Activates the last tab in the tab bar.
 172      */
 173     void activateLastTab();
 174
 175     /**
 176      * Activates the next tab in the tab bar.
 177      * If the current active tab is the last tab, it activates the first tab.
 178      */
 179     void activateNextTab();
 180
 181     /**
 182      * Activates the previous tab in the tab bar.
 183      * If the current active tab is the first tab, it activates the last tab.
 184      */
 185     void activatePrevTab();
 186
 187     /**
 188      * Is called when the user wants to reopen a previously closed tab from
 189      * the recent tabs menu.
 190      */
 191     void restoreClosedTab(const QByteArray &state);
 192
 193     /** Copies all selected items to the inactive view. */
 194     void copyToInactiveSplitView();
 195
 196     /** Moves all selected items to the inactive view. */
 197     void moveToInactiveSplitView();
 198
 199 private Q_SLOTS:
 200     /**
 201      * Opens the tab with the index \a index in a new Dolphin instance and closes
 202      * this tab.
 203      */
 204     void detachTab(int index);
 205
 206     /**
 207      * Opens a new tab showing the url from tab at the given \a index and
 208      * activates the tab.
 209      */
 210     void openNewActivatedTab(int index);
 211
 212     /**
 213      * Is connected to the KTabBar signal receivedDragMoveEvent.
 214      * Allows dragging and dropping files onto tabs.
 215      */
 216     void tabDragMoveEvent(int tab, QDragMoveEvent *event);
 217
 218     /**
 219      * Is connected to the KTabBar signal receivedDropEvent.
 220      * Allows dragging and dropping files onto tabs.
 221      */
 222     void tabDropEvent(int tab, QDropEvent *event);
 223
 224     /**
 225      * The active view url of a tab has been changed so update the text and the
 226      * icon of the corresponding tab.
 227      */
 228     void tabUrlChanged(const QUrl &url);
 229
 230     void currentTabChanged(int index);
 231
 232     /**
 233      * Calls DolphinTabPage::setCustomLabel(label) for the tab at @p index
 234      * and propagates that change to the DolphinTabBar.
 235      * @see DolphinTabPage::setCustomLabel().
 236      */
 237     void renameTab(int index, const QString &label);
 238
 239 protected:
 240     void tabInserted(int index) override;
 241     void tabRemoved(int index) override;
 242
 243 private:
 244     /**
 245      * @param tabPage The tab page to get the name of
 246      * @return The name of the tab page
 247      */
 248     QString tabName(DolphinTabPage *tabPage) const;
 249
 250     struct ViewIndex {
 251         const int tabIndex;
 252         const bool isInPrimaryView;
 253     };
 254
 255     /**
 256      * Getter for a view container.
 257      * @param viewIndex specifies the tab and the view within that tab.
 258      * @return the view container specified in @p viewIndex or nullptr if it doesn't exist.
 259      */
 260     DolphinViewContainer *viewContainerAt(ViewIndex viewIndex) const;
 261
 262     /**
 263      * Makes the view container specified in @p viewIndex become the active view container within this tab widget.
 264      * @param viewIndex Specifies the tab to activate and the view container within the tab to activate.
 265      * @return the freshly activated view container or nullptr if there is no view container at @p viewIndex.
 266      */
 267     DolphinViewContainer *activateViewContainerAt(ViewIndex viewIndex);
 268
 269     /**
 270      * Get the position of the view within this widget that is open at @p directory.
 271      * @param directory The URL of the directory we want to find.
 272      * @return a small struct containing the tab index of the view and whether it is
 273      * in the primary view. A std::nullopt is returned if there is no view open for @p directory.
 274      */
 275     const std::optional<const ViewIndex> viewOpenAtDirectory(const QUrl &directory) const;
 276
 277     /**
 278      * Get the position of the view within this widget that has @p item in the view.
 279      * This means that the item can be seen by the user in that view when scrolled to the right position.
 280      * If the view has folders expanded and @p item is one of them, the view will also be returned.
 281      * @param item The URL of the item we want to find.
 282      * @return a small struct containing the tab index of the view and whether it is
 283      * in the primary view. A std::nullopt is returned if there is no view open that has @p item visible anywhere.
 284      */
 285     const std::optional<const ViewIndex> viewShowingItem(const QUrl &item) const;
 286
 287 private:
 288     QPointer<DolphinTabPage> m_lastViewedTab;
 289     QPointer<DolphinNavigatorsWidgetAction> m_navigatorsWidget;
 290 };
 291
 292 #endif