blob: def8aa7381f7c2c7657ca1904576705b1a7ebb0b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/*
* SPDX-FileCopyrightText: 2006-2010 Peter Penz <[email protected]>
* SPDX-FileCopyrightText: 2006 Aaron J. Seigo <[email protected]>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef VIEWPROPERTIES_H
#define VIEWPROPERTIES_H
#include "dolphin_export.h"
#include "views/dolphinview.h"
#include <QUrl>
class ViewPropertySettings;
/**
* @brief Maintains the view properties like 'view mode' or
* 'show hidden files' for a directory.
*
* The view properties are automatically stored as part of the file
* .directory inside the corresponding path. To read out the view properties
* just construct an instance by passing the path of the directory:
*
* \code
* ViewProperties props(QUrl::fromLocalFile("/home/peter/Documents"));
* const DolphinView::Mode mode = props.viewMode();
* const bool hiddenFilesShown = props.hiddenFilesShown();
* \endcode
*
* When modifying a view property, the '.directory' file is automatically updated
* inside the destructor.
*
* If no .directory file is available or the global view mode is turned on
* (see GeneralSettings::globalViewMode()), the values from the global .directory file
* are used for initialization.
*/
class DOLPHIN_EXPORT ViewProperties
{
public:
explicit ViewProperties(const QUrl& url);
virtual ~ViewProperties();
void setViewMode(DolphinView::Mode mode);
DolphinView::Mode viewMode() const;
void setPreviewsShown(bool show);
bool previewsShown() const;
void setHiddenFilesShown(bool show);
bool hiddenFilesShown() const;
void setGroupedSorting(bool grouped);
bool groupedSorting() const;
void setSortRole(const QByteArray& role);
QByteArray sortRole() const;
void setSortOrder(Qt::SortOrder sortOrder);
Qt::SortOrder sortOrder() const;
void setSortFoldersFirst(bool foldersFirst);
bool sortFoldersFirst() const;
void setSortHiddenLast(bool hiddenLast);
bool sortHiddenLast() const;
/**
* Sets the additional information for the current set view-mode.
* Note that the additional-info property is the only property where
* the value is dependent from another property (in this case the view-mode).
*/
void setVisibleRoles(const QList<QByteArray>& info);
/**
* Returns the additional information for the current set view-mode.
* Note that the additional-info property is the only property where
* the value is dependent from another property (in this case the view-mode).
*/
QList<QByteArray> visibleRoles() const;
void setHeaderColumnWidths(const QList<int>& widths);
QList<int> headerColumnWidths() const;
/**
* Sets the directory properties view mode, show preview,
* show hidden files, sorting and sort order like
* set in \a props.
*/
void setDirProperties(const ViewProperties& props);
/**
* If \a autoSave is true, the properties are automatically
* saved when the destructor is called. Per default autosaving
* is enabled.
*/
void setAutoSaveEnabled(bool autoSave);
bool isAutoSaveEnabled() const;
void update();
/**
* Saves the view properties for the directory specified
* in the constructor. The method is automatically
* invoked in the destructor, if
* ViewProperties::isAutoSaveEnabled() returns true and
* at least one property has been changed.
*/
void save();
/**
* @return True if properties for the given URL exist:
* As soon as the properties for an URL have been saved with
* ViewProperties::save(), true will be returned. If false is
* returned, the default view-properties are used.
*/
bool exist() const;
private:
/**
* Returns the destination directory path where the view
* properties are stored. \a subDir specifies the used sub
* directory.
*/
QString destinationDir(const QString& subDir) const;
/**
* Returns the view-mode prefix when storing additional properties for
* a view-mode.
*/
QString viewModePrefix() const;
/**
* Provides backward compatibility with .directory files created with
* Dolphin < 2.0: Converts the old additionalInfo-property into
* the visibleRoles-property and clears the additionalInfo-property.
*/
void convertAdditionalInfo();
/**
* Provides backward compatibility with .directory files created with
* Dolphin < 2.1: Converts the old name-role "name" to the generic
* role "text".
*/
void convertNameRoleToTextRole();
/**
* Provides backward compatibility with .directory files created with
* Dolphin < 16.11.70: Converts the old name-role "date" to "modificationtime"
*/
void convertDateRoleToModificationTimeRole();
/**
* Returns true, if \a filePath is part of the home-path (see QDir::homePath()).
*/
static bool isPartOfHome(const QString& filePath);
/**
* @return A hash-value for an URL that can be used as directory name.
* Is used to be able to remember view-properties for long baloo-URLs.
*/
static QString directoryHashForUrl(const QUrl &url);
Q_DISABLE_COPY(ViewProperties)
private:
bool m_changedProps;
bool m_autoSave;
QString m_filePath;
ViewPropertySettings* m_node;
};
#endif
|
