src/views/dolphinviewactionhandler.h

   1 /*
   2  * SPDX-FileCopyrightText: 2008 David Faure <faure@kde.org>
   3  * SPDX-FileCopyrightText: 2012 Peter Penz <peter.penz19@gmail.com>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-or-later
   6  */
   7
   8
   9 #ifndef DOLPHINVIEWACTIONHANDLER_H
  10 #define DOLPHINVIEWACTIONHANDLER_H
  11
  12 #include "dolphin_export.h"
  13 #include "selectionmode/bottombar.h"
  14 #include "views/dolphinview.h"
  15
  16 #include <QObject>
  17
  18 class KToggleAction;
  19 class QAction;
  20 class QActionGroup;
  21 class DolphinView;
  22 class KActionCollection;
  23 class KFileItemList;
  24 namespace SelectionMode {
  25     class ActionTextHelper;
  26 }
  27
  28 /**
  29  * @short Handles all actions for DolphinView
  30  *
  31  * The action handler owns all the actions and slots related to DolphinView,
  32  * but the view that it acts upon can be switched to another one
  33  * (this is used in the case of split views).
  34  *
  35  * The purpose of this class is also to share this code between DolphinMainWindow
  36  * and DolphinPart.
  37  *
  38  * @see DolphinView
  39  * @see DolphinMainWindow
  40  * @see DolphinPart
  41  */
  42 class DOLPHIN_EXPORT DolphinViewActionHandler : public QObject
  43 {
  44     Q_OBJECT
  45
  46 public:
  47     explicit DolphinViewActionHandler(KActionCollection* collection, SelectionMode::ActionTextHelper* actionTextHelper, QObject* parent);
  48
  49     /**
  50      * Sets the view that this action handler should work on.
  51      */
  52     void setCurrentView(DolphinView* view);
  53
  54     /**
  55      * Returns the view that this action handler should work on.
  56      */
  57     DolphinView* currentView();
  58
  59     /**
  60      * Returns the name of the action for the current viewmode
  61      */
  62     QString currentViewModeActionName() const;
  63
  64     /**
  65      * Returns m_actionCollection
  66      */
  67     KActionCollection* actionCollection();
  68
  69 public Q_SLOTS:
  70     /**
  71      * Update all actions in the 'View' menu, i.e. those that depend on the
  72      * settings in the current view.
  73      */
  74     void updateViewActions();
  75
  76 Q_SIGNALS:
  77     /**
  78      * Emitted by DolphinViewActionHandler when the user triggered an action.
  79      * This is only used for clearing the statusbar in DolphinMainWindow.
  80      */
  81     void actionBeingHandled();
  82
  83     /**
  84      * Emitted if the user requested creating a new directory by the F10 key.
  85      * The receiver of the signal (DolphinMainWindow or DolphinPart) invokes
  86      * the method createDirectory of their KNewFileMenu instance.
  87      */
  88     void createDirectoryTriggered();
  89
  90     /** Used to request selection mode */
  91     void setSelectionMode(bool enabled, SelectionMode::BottomBar::Contents bottomBarContents = SelectionMode::BottomBar::Contents::GeneralContents);
  92
  93 private Q_SLOTS:
  94     /**
  95      * Emitted when the user requested a change of view mode
  96      */
  97     void slotViewModeActionTriggered(QAction*);
  98
  99     /**
 100      * Let the user input a name for the selected item(s) and trigger
 101      * a renaming afterwards.
 102      */
 103     void slotRename();
 104
 105     /**
 106      * Moves the selected items of the active view to the trash.
 107      * This methods adds "shift means del" handling.
 108      */
 109     void slotTrashActivated();
 110
 111     /**
 112      * Deletes the selected items of the active view.
 113      */
 114     void slotDeleteItems();
 115
 116     /**
 117      * Switches between showing a preview of the file content and showing the icon.
 118      */
 119     void togglePreview(bool);
 120
 121     /** Updates the state of the 'Show preview' menu action. */
 122     void slotPreviewsShownChanged(bool shown);
 123
 124     /** Increases the size of the current set view mode. */
 125     void zoomIn();
 126
 127     /** Decreases the size of the current set view mode. */
 128     void zoomOut();
 129
 130     /** Resets the size of the current set view mode to default. */
 131     void zoomReset();
 132
 133     /** Switches between a separate sorting and a mixed sorting of files and folders. */
 134     void toggleSortFoldersFirst();
 135
 136     /**
 137      * Updates the state of the 'Sort Ascending/Descending' action.
 138      */
 139     void slotSortOrderChanged(Qt::SortOrder order);
 140
 141     /**
 142      * Updates the state of the 'Sort Folders First' action.
 143      */
 144     void slotSortFoldersFirstChanged(bool foldersFirst);
 145
 146     /**
 147      * Switches between showing hidden files last or not.
 148      */
 149     void toggleSortHiddenLast();
 150
 151     /**
 152      * Updates the state of the 'Sort Hidden Last' action.
 153      */
 154     void slotSortHiddenLastChanged(bool hiddenLast);
 155
 156     /**
 157      * Updates the state of the 'Sort by' actions.
 158      */
 159     void slotSortRoleChanged(const QByteArray& role);
 160
 161     /**
 162      * Updates the state of the 'Zoom In' and 'Zoom Out' actions.
 163      */
 164     void slotZoomLevelChanged(int current, int previous);
 165
 166     /**
 167      * Switches on or off the displaying of additional information
 168      * as specified by \a action.
 169      */
 170     void toggleVisibleRole(QAction* action);
 171
 172     /**
 173      * Changes the sorting of the current view.
 174      */
 175     void slotSortTriggered(QAction*);
 176
 177     /**
 178      * Updates the state of the 'Additional Information' actions.
 179      */
 180     void slotVisibleRolesChanged(const QList<QByteArray>& current,
 181                                  const QList<QByteArray>& previous);
 182
 183     /**
 184      * Switches between sorting by groups or not.
 185      */
 186     void toggleGroupedSorting(bool);
 187
 188     /**
 189      * Updates the state of the 'Categorized sorting' menu action.
 190      */
 191     void slotGroupedSortingChanged(bool sortCategorized);
 192
 193     /**
 194      * Switches between showing and hiding of hidden marked files
 195      */
 196     void toggleShowHiddenFiles(bool);
 197
 198     /**
 199      * Updates the state of the 'Show hidden files' menu action.
 200      */
 201     void slotHiddenFilesShownChanged(bool shown);
 202
 203     /**
 204      * Updates the state of the 'Create Folder...' action.
 205      */
 206     void slotWriteStateChanged(bool isFolderWritable);
 207
 208     /**
 209      * Opens the view properties dialog, which allows to modify the properties
 210      * of the currently active view.
 211      */
 212     void slotAdjustViewProperties();
 213
 214     /**
 215      * Begins a duplicate operation on the selected files
 216      */
 217     void slotDuplicate();
 218
 219     /**
 220      * Connected to the "properties" action.
 221      * Opens the properties dialog for the selected items of the
 222      * active view. The properties dialog shows information
 223      * like name, size and permissions.
 224      */
 225     void slotProperties();
 226
 227     /**
 228      * Copies the path of the first selected KFileItem into Clipboard.
 229      */
 230     void slotCopyPath();
 231
 232     /**
 233      * Changes the name of the menu that contains basic actions like "Copy", "Rename", ...
 234      * The name is changed to something like "Actions for 3 Selected Items" to be extra
 235      * explicit of how these basic actions are used.
 236      */
 237     void slotSelectionChanged(const KFileItemList& selection);
 238
 239 private:
 240     /**
 241      * Create all the actions.
 242      * This is called only once (by the constructor)
 243      */
 244     void createActions(SelectionMode::ActionTextHelper *actionTextHelper);
 245
 246     /**
 247      * Creates an action-group out of all roles from KFileItemModel.
 248      * Dependent on the group-prefix either a radiobutton-group is
 249      * created for sorting (prefix is "sort_by_") or a checkbox-group
 250      * is created for additional information (prefix is "show_").
 251      * The changes of actions are reported to slotSortTriggered() or
 252      * toggleAdditionalInfo().
 253      */
 254     QActionGroup* createFileItemRolesActionGroup(const QString& groupPrefix);
 255
 256     /**
 257      * Returns the "switch to icons mode" action.
 258      * Helper method for createActions();
 259      */
 260     KToggleAction* iconsModeAction();
 261
 262     /**
 263      * Returns the "switch to compact mode" action.
 264      * Helper method for createActions();
 265      */
 266     KToggleAction* compactModeAction();
 267
 268     /**
 269      * Returns the "switch to details mode" action.
 270      * Helper method for createActions();
 271      */
 272     KToggleAction* detailsModeAction();
 273
 274     KActionCollection* m_actionCollection;
 275     DolphinView* m_currentView;
 276
 277     QHash<QByteArray, KToggleAction*> m_sortByActions;
 278     QHash<QByteArray, KToggleAction*> m_visibleRoles;
 279 };
 280
 281 #endif /* DOLPHINVIEWACTIONHANDLER_H */