src/dolphintabpage.h

   1 /*
   2  * SPDX-FileCopyrightText: 2014 Emmanuel Pescosta <emmanuelpescosta099@gmail.com>
   3  * SPDX-FileCopyrightText: 2020 Felix Ernst <fe.a.ernst@gmail.com>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-or-later
   6  */
   7
   8 #ifndef DOLPHIN_TAB_PAGE_H
   9 #define DOLPHIN_TAB_PAGE_H
  10
  11 #include <QPointer>
  12 #include <QUrl>
  13 #include <QWidget>
  14
  15 class DolphinNavigatorsWidgetAction;
  16 class DolphinViewContainer;
  17 class QSplitter;
  18 class QVariantAnimation;
  19 class KFileItemList;
  20
  21 enum Animated {
  22     WithAnimation,
  23     WithoutAnimation
  24 };
  25
  26 class DolphinTabPage : public QWidget
  27 {
  28     Q_OBJECT
  29
  30 public:
  31     explicit DolphinTabPage(const QUrl& primaryUrl, const QUrl& secondaryUrl = QUrl(), QWidget* parent = nullptr);
  32
  33     /**
  34      * @return True if primary view is the active view in this tab.
  35      */
  36     bool primaryViewActive() const;
  37
  38     /**
  39      * @return True if split view is enabled.
  40      */
  41     bool splitViewEnabled() const;
  42
  43     /**
  44      * Enables or disables the split view mode.
  45      *
  46      * @param enabled      If true, creates a secondary viewContainer in this tab.
  47      *                     Otherwise deletes it.
  48      * @param animated     Decides wether the effects of this method call should
  49      *                     happen instantly or be transitioned to smoothly.
  50      * @param secondaryUrl If \p enabled is true, the new viewContainer will be opened at this
  51      *                     parameter. The default value will set the Url of the new viewContainer
  52      *                     to be the same as the existing one.
  53      */
  54     void setSplitViewEnabled(bool enabled, Animated animated, const QUrl &secondaryUrl = QUrl());
  55
  56     /**
  57      * @return The primary view container.
  58      */
  59     DolphinViewContainer* primaryViewContainer() const;
  60
  61     /**
  62      * @return The secondary view container, can be 0 if split view is disabled.
  63      */
  64     DolphinViewContainer* secondaryViewContainer() const;
  65
  66     /**
  67      * @return DolphinViewContainer of the active view
  68      */
  69     DolphinViewContainer* activeViewContainer() const;
  70
  71     /**
  72      * Returns the selected items. The list is empty if no item has been
  73      * selected.
  74      */
  75     KFileItemList selectedItems() const;
  76
  77     /**
  78      * Returns the number of selected items (this is faster than
  79      * invoking selectedItems().count()).
  80      */
  81     int selectedItemsCount() const;
  82
  83     /**
  84      * Connects a navigatorsWidget to this. It will be connected to the DolphinViewContainers
  85      * managed by this tab. For alignment purposes this will from now on notify the
  86      * navigatorsWidget when this tab or its viewContainers are resized.
  87      */
  88     void connectNavigators(DolphinNavigatorsWidgetAction *navigatorsWidget);
  89
  90     /**
  91      * Makes it so this tab and its DolphinViewContainers aren't controlled by any
  92      * UrlNavigators anymore.
  93      */
  94     void disconnectNavigators();
  95
  96     void insertNavigatorsWidget(DolphinNavigatorsWidgetAction *navigatorsWidget);
  97
  98     /**
  99      * Marks the items indicated by \p urls to get selected after the
 100      * directory DolphinView::url() has been loaded. Note that nothing
 101      * gets selected if no loading of a directory has been triggered
 102      * by DolphinView::setUrl() or DolphinView::reload().
 103      */
 104     void markUrlsAsSelected(const QList<QUrl> &urls);
 105
 106     /**
 107      * Marks the item indicated by \p url to be scrolled to and as the
 108      * current item after directory DolphinView::url() has been loaded.
 109      */
 110     void markUrlAsCurrent(const QUrl& url);
 111
 112     /**
 113      * Refreshes the views of the main window by recreating them according to
 114      * the given Dolphin settings.
 115      */
 116     void refreshViews();
 117
 118     /**
 119      * Saves all tab related properties (urls, splitter layout, ...).
 120      *
 121      * @return A byte-array which contains all properties.
 122      */
 123     QByteArray saveState() const;
 124
 125     /**
 126      * Restores all tab related properties (urls, splitter layout, ...) from
 127      * the given \a state.
 128      */
 129     void restoreState(const QByteArray& state);
 130
 131     /**
 132      * Restores all tab related properties (urls, splitter layout, ...) from
 133      * the given \a state.
 134      *
 135      * @deprecated The first tab state version has no version number, we keep
 136      *             this method to restore old states (<= Dolphin 4.14.x).
 137      */
 138     Q_DECL_DEPRECATED void restoreStateV1(const QByteArray& state);
 139
 140     /**
 141      * Set whether the tab page is active
 142      *
 143      */
 144     void setActive(bool active);
 145
 146 Q_SIGNALS:
 147     void activeViewChanged(DolphinViewContainer* viewContainer);
 148     void activeViewUrlChanged(const QUrl& url);
 149     void splitterMoved(int pos, int index);
 150
 151 private Q_SLOTS:
 152     /**
 153      * Deletes all zombie viewContainers that were used for the animation
 154      * and resets the minimum size of the others to a sane value.
 155      */
 156     void slotAnimationFinished();
 157
 158     /**
 159      * This method is called for every frame of the m_expandViewAnimation.
 160      */
 161     void slotAnimationValueChanged(const QVariant &value);
 162
 163     /**
 164      * Handles the view activated event.
 165      *
 166      * It sets the previous active view to inactive, updates the current
 167      * active view type and triggers the activeViewChanged event.
 168      */
 169     void slotViewActivated();
 170
 171     /**
 172      * Handles the view url redirection event.
 173      *
 174      * It emits the activeViewUrlChanged signal with the url \a newUrl.
 175      */
 176     void slotViewUrlRedirection(const QUrl& oldUrl, const QUrl& newUrl);
 177
 178     void switchActiveView();
 179
 180 private:
 181     /**
 182      * Creates a new view container and does the default initialization.
 183      */
 184     DolphinViewContainer* createViewContainer(const QUrl& url) const;
 185
 186     /**
 187      * Starts an animation that transitions between split view mode states.
 188      *
 189      * One of the viewContainers is always being expanded when toggling so
 190      * this method can animate both opening and closing of viewContainers.
 191      * @param expandingContainer The container that will increase in size
 192      *                           over the course of the animation.
 193      */
 194     void startExpandViewAnimation(DolphinViewContainer *expandingContainer);
 195
 196 private:
 197     QSplitter* m_splitter;
 198
 199     QPointer<DolphinNavigatorsWidgetAction> m_navigatorsWidget;
 200     QPointer<DolphinViewContainer> m_primaryViewContainer;
 201     QPointer<DolphinViewContainer> m_secondaryViewContainer;
 202
 203     DolphinViewContainer *m_expandingContainer;
 204     QPointer<QVariantAnimation> m_expandViewAnimation;
 205
 206     bool m_primaryViewActive;
 207     bool m_splitViewEnabled;
 208     bool m_active;
 209 };
 210
 211 #endif // DOLPHIN_TAB_PAGE_H