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 #ifndef DOLPHINVIEWACTIONHANDLER_H
   9 #define DOLPHINVIEWACTIONHANDLER_H
  10
  11 #include "dolphin_export.h"
  12 #include "selectionmode/bottombar.h"
  13 #include "views/dolphinview.h"
  14
  15 #include <QObject>
  16
  17 class KToggleAction;
  18 class QAction;
  19 class QActionGroup;
  20 class DolphinView;
  21 class KActionCollection;
  22 class KFileItemList;
  23 namespace SelectionMode
  24 {
  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 either entering or leaving of selection mode */
  91     void selectionModeChangeTriggered(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 'Group Ascending/Descending' action.
 163      */
 164     void slotGroupOrderChanged(Qt::SortOrder order);
 165
 166     /**
 167      * Updates the state of the 'Group by' actions.
 168      */
 169     void slotGroupRoleChanged(const QByteArray &role);
 170
 171     /**
 172      * Updates the state of the 'Zoom In' and 'Zoom Out' actions.
 173      */
 174     void slotZoomLevelChanged(int current, int previous);
 175
 176     /**
 177      * Switches on or off the displaying of additional information
 178      * as specified by \a action.
 179      */
 180     void toggleVisibleRole(QAction *action);
 181
 182     /**
 183      * Changes the sorting of the current view.
 184      */
 185     void slotSortTriggered(QAction *);
 186
 187     /**
 188      * Updates the state of the 'Additional Information' actions.
 189      */
 190     void slotVisibleRolesChanged(const QList<QByteArray> &current, const QList<QByteArray> &previous);
 191
 192     /**
 193      * Changes the grouping of the current view.
 194      */
 195     void slotGroupTriggered(QAction *);
 196
 197     /**
 198      * Switches between sorting by groups or not.
 199      */
 200     void toggleGroupedSorting(bool);
 201
 202     /**
 203      * Updates the state of the 'Categorized sorting' menu action.
 204      */
 205     void slotGroupedSortingChanged(bool sortCategorized);
 206
 207     /**
 208      * Switches between showing and hiding of hidden marked files
 209      */
 210     void toggleShowHiddenFiles(bool);
 211
 212     /**
 213      * Updates the state of the 'Show hidden files' menu action.
 214      */
 215     void slotHiddenFilesShownChanged(bool shown);
 216
 217     /**
 218      * Updates the state of the 'Create Folder...' action.
 219      */
 220     void slotWriteStateChanged(bool isFolderWritable);
 221
 222     /**
 223      * Opens the view properties dialog, which allows to modify the properties
 224      * of the currently active view.
 225      */
 226     void slotAdjustViewProperties();
 227
 228     /**
 229      * Begins a duplicate operation on the selected files
 230      */
 231     void slotDuplicate();
 232
 233     /**
 234      * Connected to the "properties" action.
 235      * Opens the properties dialog for the selected items of the
 236      * active view. The properties dialog shows information
 237      * like name, size and permissions.
 238      */
 239     void slotProperties();
 240
 241     /**
 242      * Copies the path of the first selected KFileItem into Clipboard.
 243      */
 244     void slotCopyPath();
 245
 246     /**
 247      * Changes the name of the menu that contains basic actions like "Copy", "Rename", ...
 248      * The name is changed to something like "Actions for 3 Selected Items" to be extra
 249      * explicit of how these basic actions are used.
 250      */
 251     void slotSelectionChanged(const KFileItemList &selection);
 252
 253 private:
 254     /**
 255      * Create all the actions.
 256      * This is called only once (by the constructor)
 257      */
 258     void createActions(SelectionMode::ActionTextHelper *actionTextHelper);
 259
 260     /**
 261      * Creates an action-group out of all roles from KFileItemModel.
 262      * Dependent on the group-prefix either a radiobutton-group is
 263      * created for sorting (prefix is "sort_by_") or a checkbox-group
 264      * is created for additional information (prefix is "show_").
 265      * The changes of actions are reported to slotSortTriggered() or
 266      * toggleAdditionalInfo().
 267      */
 268     QActionGroup *createFileItemRolesActionGroup(const QString &groupPrefix);
 269
 270     /**
 271      * Returns the "switch to icons mode" action.
 272      * Helper method for createActions();
 273      */
 274     KToggleAction *iconsModeAction();
 275
 276     /**
 277      * Returns the "switch to compact mode" action.
 278      * Helper method for createActions();
 279      */
 280     KToggleAction *compactModeAction();
 281
 282     /**
 283      * Returns the "switch to details mode" action.
 284      * Helper method for createActions();
 285      */
 286     KToggleAction *detailsModeAction();
 287
 288     KActionCollection *m_actionCollection;
 289     DolphinView *m_currentView;
 290
 291     QHash<QByteArray, KToggleAction *> m_sortByActions;
 292     QHash<QByteArray, KToggleAction *> m_groupByActions;
 293     QHash<QByteArray, KToggleAction *> m_visibleRoles;
 294 };
 295
 296 #endif /* DOLPHINVIEWACTIONHANDLER_H */