1 /***************************************************************************
2 * Copyright (C) 2008 by David Faure <faure@kde.org> *
3 * Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
19 ***************************************************************************/
21 #include "dolphinviewactionhandler.h"
23 #include <config-baloo.h>
25 #include "settings/viewpropertiesdialog.h"
26 #include "views/dolphinview.h"
27 #include "views/zoomlevelinfo.h"
28 #include <konq_operations.h>
33 #include <KActionCollection>
34 #include <KActionMenu>
35 #include <kitemviews/kfileitemmodel.h>
38 #include <KNewFileMenu>
39 #include <KSelectAction>
40 #include <KToggleAction>
41 #include <KPropertiesDialog>
47 #include <KF5/Baloo/indexerconfig.h>
50 DolphinViewActionHandler::DolphinViewActionHandler(KActionCollection
* collection
, QObject
* parent
) :
52 m_actionCollection(collection
),
57 Q_ASSERT(m_actionCollection
);
61 void DolphinViewActionHandler::setCurrentView(DolphinView
* view
)
66 disconnect(m_currentView
, 0, this, 0);
71 connect(view
, &DolphinView::modeChanged
,
72 this, &DolphinViewActionHandler::updateViewActions
);
73 connect(view
, &DolphinView::previewsShownChanged
,
74 this, &DolphinViewActionHandler::slotPreviewsShownChanged
);
75 connect(view
, &DolphinView::sortOrderChanged
,
76 this, &DolphinViewActionHandler::slotSortOrderChanged
);
77 connect(view
, &DolphinView::sortFoldersFirstChanged
,
78 this, &DolphinViewActionHandler::slotSortFoldersFirstChanged
);
79 connect(view
, &DolphinView::visibleRolesChanged
,
80 this, &DolphinViewActionHandler::slotVisibleRolesChanged
);
81 connect(view
, &DolphinView::groupedSortingChanged
,
82 this, &DolphinViewActionHandler::slotGroupedSortingChanged
);
83 connect(view
, &DolphinView::hiddenFilesShownChanged
,
84 this, &DolphinViewActionHandler::slotHiddenFilesShownChanged
);
85 connect(view
, &DolphinView::sortRoleChanged
,
86 this, &DolphinViewActionHandler::slotSortRoleChanged
);
87 connect(view
, &DolphinView::zoomLevelChanged
,
88 this, &DolphinViewActionHandler::slotZoomLevelChanged
);
89 connect(view
, &DolphinView::writeStateChanged
,
90 this, &DolphinViewActionHandler::slotWriteStateChanged
);
93 DolphinView
* DolphinViewActionHandler::currentView()
98 void DolphinViewActionHandler::createActions()
100 // This action doesn't appear in the GUI, it's for the shortcut only.
101 // KNewFileMenu takes care of the GUI stuff.
102 QAction
* newDirAction
= m_actionCollection
->addAction("create_dir");
103 newDirAction
->setText(i18nc("@action", "Create Folder..."));
104 newDirAction
->setShortcut(Qt::Key_F10
);
105 newDirAction
->setIcon(KIcon("folder-new"));
106 newDirAction
->setEnabled(false); // Will be enabled in slotWriteStateChanged(bool) if the current URL is writable
107 connect(newDirAction
, &QAction::triggered
, this, &DolphinViewActionHandler::createDirectory
);
111 QAction
* rename
= m_actionCollection
->addAction("rename");
112 rename
->setText(i18nc("@action:inmenu File", "Rename..."));
113 rename
->setShortcut(Qt::Key_F2
);
114 rename
->setIcon(KIcon("edit-rename"));
115 connect(rename
, &QAction::triggered
, this, &DolphinViewActionHandler::slotRename
);
117 QAction
* moveToTrash
= m_actionCollection
->addAction("move_to_trash");
118 moveToTrash
->setText(i18nc("@action:inmenu File", "Move to Trash"));
119 moveToTrash
->setIcon(KIcon("user-trash"));
120 moveToTrash
->setShortcut(QKeySequence::Delete
);
121 connect(moveToTrash
, &QAction::triggered
,
122 this, &DolphinViewActionHandler::slotTrashActivated
);
124 QAction
* deleteAction
= m_actionCollection
->addAction("delete");
125 deleteAction
->setIcon(KIcon("edit-delete"));
126 deleteAction
->setText(i18nc("@action:inmenu File", "Delete"));
127 deleteAction
->setShortcut(Qt::SHIFT
| Qt::Key_Delete
);
128 connect(deleteAction
, &QAction::triggered
, this, &DolphinViewActionHandler::slotDeleteItems
);
130 // This action is useful for being enabled when "move_to_trash" should be
131 // disabled and "delete" is enabled (e.g. non-local files), so that Key_Del
132 // can be used for deleting the file (#76016). It needs to be a separate action
133 // so that the Edit menu isn't affected.
134 QAction
* deleteWithTrashShortcut
= m_actionCollection
->addAction("delete_shortcut");
135 // The descriptive text is just for the shortcuts editor.
136 deleteWithTrashShortcut
->setText(i18nc("@action \"Move to Trash\" for non-local files, etc.", "Delete (using shortcut for Trash)"));
137 deleteWithTrashShortcut
->setShortcut(QKeySequence::Delete
);
138 deleteWithTrashShortcut
->setEnabled(false);
139 connect(deleteWithTrashShortcut
, &QAction::triggered
, this, &DolphinViewActionHandler::slotDeleteItems
);
141 QAction
*propertiesAction
= m_actionCollection
->addAction( "properties" );
142 // Well, it's the File menu in dolphinmainwindow and the Edit menu in dolphinpart... :)
143 propertiesAction
->setText( i18nc("@action:inmenu File", "Properties") );
144 propertiesAction
->setIcon(KIcon("document-properties"));
145 propertiesAction
->setShortcuts(QList
<QKeySequence
>() << Qt::ALT
+ Qt::Key_Return
<< Qt::ALT
+ Qt::Key_Enter
);
146 connect(propertiesAction
, &QAction::triggered
, this, &DolphinViewActionHandler::slotProperties
);
149 KToggleAction
* iconsAction
= iconsModeAction();
150 KToggleAction
* compactAction
= compactModeAction();
151 KToggleAction
* detailsAction
= detailsModeAction();
153 KSelectAction
* viewModeActions
= m_actionCollection
->add
<KSelectAction
>("view_mode");
154 viewModeActions
->setText(i18nc("@action:intoolbar", "View Mode"));
155 viewModeActions
->addAction(iconsAction
);
156 viewModeActions
->addAction(compactAction
);
157 viewModeActions
->addAction(detailsAction
);
158 viewModeActions
->setToolBarMode(KSelectAction::MenuMode
);
159 connect(viewModeActions
, static_cast<void(KSelectAction::*)(QAction
*)>(&KSelectAction::triggered
), this, &DolphinViewActionHandler::slotViewModeActionTriggered
);
161 KStandardAction::zoomIn(this,
165 KStandardAction::zoomOut(this,
169 KToggleAction
* showPreview
= m_actionCollection
->add
<KToggleAction
>("show_preview");
170 showPreview
->setText(i18nc("@action:intoolbar", "Preview"));
171 showPreview
->setToolTip(i18nc("@info", "Show preview of files and folders"));
172 showPreview
->setIcon(KIcon("view-preview"));
173 connect(showPreview
, &KToggleAction::triggered
, this, &DolphinViewActionHandler::togglePreview
);
175 KToggleAction
* sortDescending
= m_actionCollection
->add
<KToggleAction
>("descending");
176 sortDescending
->setText(i18nc("@action:inmenu Sort", "Descending"));
177 connect(sortDescending
, &KToggleAction::triggered
, this, &DolphinViewActionHandler::toggleSortOrder
);
179 KToggleAction
* sortFoldersFirst
= m_actionCollection
->add
<KToggleAction
>("folders_first");
180 sortFoldersFirst
->setText(i18nc("@action:inmenu Sort", "Folders First"));
181 connect(sortFoldersFirst
, &KToggleAction::triggered
, this, &DolphinViewActionHandler::toggleSortFoldersFirst
);
184 QActionGroup
* sortByActionGroup
= createFileItemRolesActionGroup("sort_by_");
186 KActionMenu
* sortByActionMenu
= m_actionCollection
->add
<KActionMenu
>("sort");
187 sortByActionMenu
->setText(i18nc("@action:inmenu View", "Sort By"));
188 sortByActionMenu
->setDelayed(false);
190 foreach (QAction
* action
, sortByActionGroup
->actions()) {
191 sortByActionMenu
->addAction(action
);
193 sortByActionMenu
->addSeparator();
194 sortByActionMenu
->addAction(sortDescending
);
195 sortByActionMenu
->addAction(sortFoldersFirst
);
197 // View -> Additional Information
198 QActionGroup
* visibleRolesGroup
= createFileItemRolesActionGroup("show_");
200 KActionMenu
* visibleRolesMenu
= m_actionCollection
->add
<KActionMenu
>("additional_info");
201 visibleRolesMenu
->setText(i18nc("@action:inmenu View", "Additional Information"));
202 visibleRolesMenu
->setDelayed(false);
204 foreach (QAction
* action
, visibleRolesGroup
->actions()) {
205 visibleRolesMenu
->addAction(action
);
208 KToggleAction
* showInGroups
= m_actionCollection
->add
<KToggleAction
>("show_in_groups");
209 showInGroups
->setIcon(KIcon("view-group"));
210 showInGroups
->setText(i18nc("@action:inmenu View", "Show in Groups"));
211 connect(showInGroups
, &KToggleAction::triggered
, this, &DolphinViewActionHandler::toggleGroupedSorting
);
213 KToggleAction
* showHiddenFiles
= m_actionCollection
->add
<KToggleAction
>("show_hidden_files");
214 showHiddenFiles
->setText(i18nc("@action:inmenu View", "Show Hidden Files"));
215 showHiddenFiles
->setShortcuts(QList
<QKeySequence
>() << Qt::ALT
+ Qt::Key_Period
<< Qt::Key_F8
);
216 connect(showHiddenFiles
, &KToggleAction::triggered
, this, &DolphinViewActionHandler::toggleShowHiddenFiles
);
218 QAction
* adjustViewProps
= m_actionCollection
->addAction("view_properties");
219 adjustViewProps
->setText(i18nc("@action:inmenu View", "Adjust View Properties..."));
220 connect(adjustViewProps
, &QAction::triggered
, this, &DolphinViewActionHandler::slotAdjustViewProperties
);
223 QActionGroup
* DolphinViewActionHandler::createFileItemRolesActionGroup(const QString
& groupPrefix
)
225 const bool isSortGroup
= (groupPrefix
== QLatin1String("sort_by_"));
226 Q_ASSERT(isSortGroup
|| (!isSortGroup
&& groupPrefix
== QLatin1String("show_")));
228 QActionGroup
* rolesActionGroup
= new QActionGroup(m_actionCollection
);
229 rolesActionGroup
->setExclusive(isSortGroup
);
231 connect(rolesActionGroup
, &QActionGroup::triggered
,
232 this, &DolphinViewActionHandler::slotSortTriggered
);
234 connect(rolesActionGroup
, &QActionGroup::triggered
,
235 this, &DolphinViewActionHandler::toggleVisibleRole
);
239 KActionMenu
* groupMenu
= 0;
240 QActionGroup
* groupMenuGroup
= 0;
242 bool indexingEnabled
= false;
244 Baloo::IndexerConfig config
;
245 indexingEnabled
= config
.fileIndexingEnabled();
248 const QList
<KFileItemModel::RoleInfo
> rolesInfo
= KFileItemModel::rolesInformation();
249 foreach (const KFileItemModel::RoleInfo
& info
, rolesInfo
) {
250 if (!isSortGroup
&& info
.role
== "text") {
251 // It should not be possible to hide the "text" role
255 KToggleAction
* action
= 0;
256 const QString name
= groupPrefix
+ info
.role
;
257 if (info
.group
.isEmpty()) {
258 action
= m_actionCollection
->add
<KToggleAction
>(name
);
259 action
->setActionGroup(rolesActionGroup
);
261 if (!groupMenu
|| info
.group
!= groupName
) {
262 groupName
= info
.group
;
263 groupMenu
= m_actionCollection
->add
<KActionMenu
>(groupName
);
264 groupMenu
->setText(groupName
);
265 groupMenu
->setActionGroup(rolesActionGroup
);
267 groupMenuGroup
= new QActionGroup(groupMenu
);
268 groupMenuGroup
->setExclusive(isSortGroup
);
270 connect(groupMenuGroup
, &QActionGroup::triggered
,
271 this, &DolphinViewActionHandler::slotSortTriggered
);
273 connect(groupMenuGroup
, &QActionGroup::triggered
,
274 this, &DolphinViewActionHandler::toggleVisibleRole
);
278 action
= new KToggleAction(groupMenu
);
279 action
->setActionGroup(groupMenuGroup
);
280 groupMenu
->addAction(action
);
282 action
->setText(info
.translation
);
283 action
->setData(info
.role
);
285 const bool enable
= (!info
.requiresBaloo
&& !info
.requiresIndexer
) ||
286 (info
.requiresBaloo
) ||
287 (info
.requiresIndexer
&& indexingEnabled
);
288 action
->setEnabled(enable
);
291 m_sortByActions
.insert(info
.role
, action
);
293 m_visibleRoles
.insert(info
.role
, action
);
297 return rolesActionGroup
;
300 void DolphinViewActionHandler::slotViewModeActionTriggered(QAction
* action
)
302 const DolphinView::Mode mode
= action
->data().value
<DolphinView::Mode
>();
303 m_currentView
->setMode(mode
);
305 QAction
* viewModeMenu
= m_actionCollection
->action("view_mode");
306 viewModeMenu
->setIcon(KIcon(action
->icon()));
309 void DolphinViewActionHandler::slotRename()
311 emit
actionBeingHandled();
312 m_currentView
->renameSelectedItems();
315 void DolphinViewActionHandler::slotTrashActivated()
317 emit
actionBeingHandled();
318 m_currentView
->trashSelectedItems();
321 void DolphinViewActionHandler::slotDeleteItems()
323 emit
actionBeingHandled();
324 m_currentView
->deleteSelectedItems();
327 void DolphinViewActionHandler::togglePreview(bool show
)
329 emit
actionBeingHandled();
330 m_currentView
->setPreviewsShown(show
);
333 void DolphinViewActionHandler::slotPreviewsShownChanged(bool shown
)
336 // It is not enough to update the 'Show Preview' action, also
337 // the 'Zoom In' and 'Zoom Out' actions must be adapted.
341 QString
DolphinViewActionHandler::currentViewModeActionName() const
343 switch (m_currentView
->mode()) {
344 case DolphinView::IconsView
:
346 case DolphinView::DetailsView
:
348 case DolphinView::CompactView
:
354 return QString(); // can't happen
357 KActionCollection
* DolphinViewActionHandler::actionCollection()
359 return m_actionCollection
;
362 void DolphinViewActionHandler::updateViewActions()
364 QAction
* viewModeAction
= m_actionCollection
->action(currentViewModeActionName());
365 if (viewModeAction
) {
366 viewModeAction
->setChecked(true);
368 QAction
* viewModeMenu
= m_actionCollection
->action("view_mode");
369 viewModeMenu
->setIcon(KIcon(viewModeAction
->icon()));
372 QAction
* showPreviewAction
= m_actionCollection
->action("show_preview");
373 showPreviewAction
->setChecked(m_currentView
->previewsShown());
375 slotSortOrderChanged(m_currentView
->sortOrder());
376 slotSortFoldersFirstChanged(m_currentView
->sortFoldersFirst());
377 slotVisibleRolesChanged(m_currentView
->visibleRoles(), QList
<QByteArray
>());
378 slotGroupedSortingChanged(m_currentView
->groupedSorting());
379 slotSortRoleChanged(m_currentView
->sortRole());
380 slotZoomLevelChanged(m_currentView
->zoomLevel(), -1);
382 QAction
* showHiddenFilesAction
= m_actionCollection
->action("show_hidden_files");
383 showHiddenFilesAction
->setChecked(m_currentView
->hiddenFilesShown());
386 void DolphinViewActionHandler::zoomIn()
388 const int level
= m_currentView
->zoomLevel();
389 m_currentView
->setZoomLevel(level
+ 1);
393 void DolphinViewActionHandler::zoomOut()
395 const int level
= m_currentView
->zoomLevel();
396 m_currentView
->setZoomLevel(level
- 1);
400 void DolphinViewActionHandler::toggleSortOrder()
402 const Qt::SortOrder order
= (m_currentView
->sortOrder() == Qt::AscendingOrder
) ?
403 Qt::DescendingOrder
:
405 m_currentView
->setSortOrder(order
);
408 void DolphinViewActionHandler::toggleSortFoldersFirst()
410 const bool sortFirst
= m_currentView
->sortFoldersFirst();
411 m_currentView
->setSortFoldersFirst(!sortFirst
);
414 void DolphinViewActionHandler::slotSortOrderChanged(Qt::SortOrder order
)
416 QAction
* descending
= m_actionCollection
->action("descending");
417 const bool sortDescending
= (order
== Qt::DescendingOrder
);
418 descending
->setChecked(sortDescending
);
421 void DolphinViewActionHandler::slotSortFoldersFirstChanged(bool foldersFirst
)
423 m_actionCollection
->action("folders_first")->setChecked(foldersFirst
);
426 void DolphinViewActionHandler::toggleVisibleRole(QAction
* action
)
428 emit
actionBeingHandled();
430 const QByteArray toggledRole
= action
->data().toByteArray();
432 QList
<QByteArray
> roles
= m_currentView
->visibleRoles();
434 const bool show
= action
->isChecked();
436 const int index
= roles
.indexOf(toggledRole
);
437 const bool containsInfo
= (index
>= 0);
438 if (show
&& !containsInfo
) {
439 roles
.append(toggledRole
);
440 m_currentView
->setVisibleRoles(roles
);
441 } else if (!show
&& containsInfo
) {
442 roles
.removeAt(index
);
443 m_currentView
->setVisibleRoles(roles
);
444 Q_ASSERT(roles
.indexOf(toggledRole
) < 0);
448 void DolphinViewActionHandler::slotVisibleRolesChanged(const QList
<QByteArray
>& current
,
449 const QList
<QByteArray
>& previous
)
453 const QSet
<QByteArray
> checkedRoles
= current
.toSet();
454 QHashIterator
<QByteArray
, KToggleAction
*> it(m_visibleRoles
);
455 while (it
.hasNext()) {
457 const QByteArray
& role
= it
.key();
458 KToggleAction
* action
= it
.value();
459 action
->setChecked(checkedRoles
.contains(role
));
463 void DolphinViewActionHandler::toggleGroupedSorting(bool grouped
)
465 m_currentView
->setGroupedSorting(grouped
);
468 void DolphinViewActionHandler::slotGroupedSortingChanged(bool groupedSorting
)
470 QAction
* showInGroupsAction
= m_actionCollection
->action("show_in_groups");
471 showInGroupsAction
->setChecked(groupedSorting
);
474 void DolphinViewActionHandler::toggleShowHiddenFiles(bool show
)
476 emit
actionBeingHandled();
477 m_currentView
->setHiddenFilesShown(show
);
480 void DolphinViewActionHandler::slotHiddenFilesShownChanged(bool shown
)
482 QAction
* showHiddenFilesAction
= m_actionCollection
->action("show_hidden_files");
483 showHiddenFilesAction
->setChecked(shown
);
486 void DolphinViewActionHandler::slotWriteStateChanged(bool isFolderWritable
)
488 m_actionCollection
->action("create_dir")->setEnabled(isFolderWritable
);
491 KToggleAction
* DolphinViewActionHandler::iconsModeAction()
493 KToggleAction
* iconsView
= m_actionCollection
->add
<KToggleAction
>("icons");
494 iconsView
->setText(i18nc("@action:inmenu View Mode", "Icons"));
495 iconsView
->setToolTip(i18nc("@info", "Icons view mode"));
496 iconsView
->setShortcut(Qt::CTRL
| Qt::Key_1
);
497 iconsView
->setIcon(KIcon("view-list-icons"));
498 iconsView
->setData(QVariant::fromValue(DolphinView::IconsView
));
502 KToggleAction
* DolphinViewActionHandler::compactModeAction()
504 KToggleAction
* iconsView
= m_actionCollection
->add
<KToggleAction
>("compact");
505 iconsView
->setText(i18nc("@action:inmenu View Mode", "Compact"));
506 iconsView
->setToolTip(i18nc("@info", "Compact view mode"));
507 iconsView
->setShortcut(Qt::CTRL
| Qt::Key_2
);
508 iconsView
->setIcon(KIcon("view-list-details")); // TODO: discuss with Oxygen-team the wrong (?) name
509 iconsView
->setData(QVariant::fromValue(DolphinView::CompactView
));
513 KToggleAction
* DolphinViewActionHandler::detailsModeAction()
515 KToggleAction
* detailsView
= m_actionCollection
->add
<KToggleAction
>("details");
516 detailsView
->setText(i18nc("@action:inmenu View Mode", "Details"));
517 detailsView
->setToolTip(i18nc("@info", "Details view mode"));
518 detailsView
->setShortcut(Qt::CTRL
| Qt::Key_3
);
519 detailsView
->setIcon(KIcon("view-list-tree"));
520 detailsView
->setData(QVariant::fromValue(DolphinView::DetailsView
));
524 void DolphinViewActionHandler::slotSortRoleChanged(const QByteArray
& role
)
526 KToggleAction
* action
= m_sortByActions
.value(role
);
528 action
->setChecked(true);
530 if (!action
->icon().isNull()) {
531 QAction
* sortByMenu
= m_actionCollection
->action("sort");
532 sortByMenu
->setIcon(KIcon(action
->icon()));
537 void DolphinViewActionHandler::slotZoomLevelChanged(int current
, int previous
)
541 QAction
* zoomInAction
= m_actionCollection
->action(KStandardAction::name(KStandardAction::ZoomIn
));
543 zoomInAction
->setEnabled(current
< ZoomLevelInfo::maximumLevel());
546 QAction
* zoomOutAction
= m_actionCollection
->action(KStandardAction::name(KStandardAction::ZoomOut
));
548 zoomOutAction
->setEnabled(current
> ZoomLevelInfo::minimumLevel());
552 void DolphinViewActionHandler::slotSortTriggered(QAction
* action
)
554 // The radiobuttons of the "Sort By"-menu are split between the main-menu
555 // and several sub-menus. Because of this they don't have a common
556 // action-group that assures an exclusive toggle-state between the main-menu
557 // actions and the sub-menu-actions. If an action gets checked, it must
558 // be assured that all other actions get unchecked.
559 QAction
* sortByMenu
= m_actionCollection
->action("sort");
560 foreach (QAction
* groupAction
, sortByMenu
->menu()->actions()) {
561 KActionMenu
* actionMenu
= qobject_cast
<KActionMenu
*>(groupAction
);
563 foreach (QAction
* subAction
, actionMenu
->menu()->actions()) {
564 subAction
->setChecked(false);
566 } else if (groupAction
->actionGroup()) {
567 groupAction
->setChecked(false);
570 action
->setChecked(true);
572 // Apply the activated sort-role to the view
573 const QByteArray role
= action
->data().toByteArray();
574 m_currentView
->setSortRole(role
);
577 void DolphinViewActionHandler::slotAdjustViewProperties()
579 emit
actionBeingHandled();
580 QPointer
<ViewPropertiesDialog
> dialog
= new ViewPropertiesDialog(m_currentView
);
585 void DolphinViewActionHandler::slotProperties()
587 KPropertiesDialog
* dialog
= 0;
588 const KFileItemList list
= m_currentView
->selectedItems();
589 if (list
.isEmpty()) {
590 const KUrl url
= m_currentView
->url();
591 dialog
= new KPropertiesDialog(url
, m_currentView
);
593 dialog
= new KPropertiesDialog(list
, m_currentView
);
596 dialog
->setAttribute(Qt::WA_DeleteOnClose
);
599 dialog
->activateWindow();