#include <libdolphin_export.h>
#include <KFileItemList>
#include <KUrl>
+#include <kitemviews/kfileitemmodelfilter_p.h>
#include <kitemviews/kitemmodelbase.h>
#include <QHash>
*
* Also the recursive expansion of sub-directories is supported by
* KFileItemModel::setExpanded().
+ *
+ * TODO: In the longterm instead of passing a KDirLister just an URL should
+ * be passed and a KDirLister used internally. This solves the following issues:
+ * - The user of the API does not need to decide whether he listens to KDirLister
+ * or KFileItemModel.
+ * - It resolves minor conceptual differences between KDirLister and KFileItemModel.
+ * E.g. there is no way for KFileItemModel to check whether a completed() signal
+ * will be emitted after newItems() will be send by KDirLister or not (in the case
+ * of setShowingDotFiles() no completed() signal will get emitted).
*/
class LIBDOLPHINPRIVATE_EXPORT KFileItemModel : public KItemModelBase
{
void setSortFoldersFirst(bool foldersFirst);
bool sortFoldersFirst() const;
+ void setShowHiddenFiles(bool show);
+ bool showHiddenFiles() const;
+
+ /**
+ * If set to true, only folders are shown as items of the model. Files
+ * are ignored.
+ */
+ void setShowFoldersOnly(bool enabled);
+ bool showFoldersOnly() const;
+
/** @reimp */
virtual QMimeData* createMimeData(const QSet<int>& indexes) const;
virtual bool supportsDropping(int index) const;
/** @reimp */
- virtual QString roleDescription(const QByteArray& role) const;
+ virtual QString roleDescription(const QByteArray& typeForRole) const;
/** @reimp */
virtual QList<QPair<int, QVariant> > groups() const;
virtual bool setExpanded(int index, bool expanded);
virtual bool isExpanded(int index) const;
virtual bool isExpandable(int index) const;
+ virtual int expandedParentsCount(int index) const;
QSet<KUrl> expandedUrls() const;
void restoreExpandedUrls(const QSet<KUrl>& urls);
/**
- * Expands all parent-items of each URL given by \a urls.
+ * Expands all parent-items of \a url.
*/
- void setExpanded(const QSet<KUrl>& urls);
+ void expandParentItems(const KUrl& url);
void setNameFilter(const QString& nameFilter);
QString nameFilter() const;
+ struct RoleInfo
+ { QByteArray role;
+ QString translation;
+ QString group;
+ };
+
+ static QList<RoleInfo> rolesInformation();
+
signals:
+ /**
+ * Is emitted after the loading of a directory has been completed or new
+ * items have been inserted to an already loaded directory. Usually
+ * one or more itemsInserted() signals are emitted before loadingCompleted()
+ * (the only exception is loading an empty directory, where only a
+ * loadingCompleted() signal gets emitted).
+ */
void loadingCompleted();
protected:
* and foldersFirst() settings.
*/
void resortAllItems();
-
+
void slotCompleted();
void slotCanceled();
void slotNewItems(const KFileItemList& items);
void slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >& items);
void slotClear();
void slotClear(const KUrl& url);
+ void slotNaturalSortingChanged();
void dispatchPendingItemsToInsert();
private:
- enum Role {
- NoRole,
- NameRole,
- SizeRole,
- DateRole,
- PermissionsRole,
- OwnerRole,
- GroupRole,
- TypeRole,
- DestinationRole,
- PathRole,
- CommentRole,
- TagsRole,
- RatingRole,
- IsDirRole,
- IsExpandedRole,
- ExpansionLevelRole,
- RolesCount // Mandatory last entry
+ enum RoleType {
+ // User visible roles:
+ NoRole, NameRole, SizeRole, DateRole, PermissionsRole, OwnerRole,
+ GroupRole, TypeRole, DestinationRole, PathRole,
+ // User visible roles available with Nepomuk:
+ CommentRole, TagsRole, RatingRole, ImageSizeRole, OrientationRole,
+ WordCountRole, LineCountRole, ArtistRole, AlbumRole, DurationRole, TrackRole,
+ CopiedFromRole,
+ // Non-visible roles:
+ IsDirRole, IsExpandedRole, IsExpandableRole, ExpandedParentsCountRole,
+ // Mandatory last entry:
+ RolesCount
};
struct ItemData
{
KFileItem item;
QHash<QByteArray, QVariant> values;
+ ItemData* parent;
};
-
+
void insertItems(const KFileItemList& items);
void removeItems(const KFileItemList& items);
-
+
/**
* Helper method for insertItems() and removeItems(): Creates
* a list of ItemData elements based on the given items.
*/
void resetRoles();
- Role roleIndex(const QByteArray& role) const;
+ /**
+ * @return Role-type for the given role.
+ * Runtime complexity is O(1).
+ */
+ RoleType typeForRole(const QByteArray& role) const;
+
+ /**
+ * @return Role-byte-array for the given role-type.
+ * Runtime complexity is O(1).
+ */
+ QByteArray roleForType(RoleType roleType) const;
QHash<QByteArray, QVariant> retrieveData(const KFileItem& item) const;
-
+
+ /**
+ * @return True if the item-data \a a should be ordered before the item-data
+ * \b. The item-data may have different parent-items.
+ */
bool lessThan(const ItemData* a, const ItemData* b) const;
-
+
+ /**
+ * Helper method for lessThan() and expandedParentsCountCompare(): Compares
+ * the passed item-data using m_sortRole as criteria. Both items must
+ * have the same parent item, otherwise the comparison will be wrong.
+ */
+ int sortRoleCompare(const ItemData* a, const ItemData* b) const;
+
/**
* Sorts the items by using lessThan() as comparison criteria.
* The merge sort algorithm is used to assure a worst-case
* of O(n * log(n)) and to keep the number of comparisons low.
*/
void sort(QList<ItemData*>::iterator begin, QList<ItemData*>::iterator end);
-
+
/** Helper method for sort(). */
void merge(QList<ItemData*>::iterator begin,
QList<ItemData*>::iterator pivot,
QList<ItemData*>::iterator lowerBound(QList<ItemData*>::iterator begin,
QList<ItemData*>::iterator end,
const ItemData* value);
-
+
/** Helper method for sort(). */
QList<ItemData*>::iterator upperBound(QList<ItemData*>::iterator begin,
QList<ItemData*>::iterator end,
const ItemData* value);
/** Helper method for sort(). */
void reverse(QList<ItemData*>::iterator begin, QList<ItemData*>::iterator end);
-
+
int stringCompare(const QString& a, const QString& b) const;
/**
* is not sufficient, it is also important to check the hierarchy for having
* a correct order like shown in a tree.
*/
- int expansionLevelsCompare(const KFileItem& a, const KFileItem& b) const;
+ int expandedParentsCountCompare(const ItemData* a, const ItemData* b) const;
/**
- * Helper method for expansionLevelCompare().
+ * Helper method for expandedParentsCountCompare().
*/
QString subPath(const KFileItem& item,
const QString& itemPath,
QList<QPair<int, QVariant> > dateRoleGroups() const;
QList<QPair<int, QVariant> > permissionRoleGroups() const;
QList<QPair<int, QVariant> > ratingRoleGroups() const;
- QList<QPair<int, QVariant> > genericStringRoleGroups(const QByteArray& role) const;
+ QList<QPair<int, QVariant> > genericStringRoleGroups(const QByteArray& typeForRole) const;
/**
* Helper method for all xxxRoleGroups() methods to check whether the
bool isChildItem(int index) const;
/**
- * @return True if the given item matches with the current set name filter.
+ * @return Recursive list of child items that have \a item as upper most parent.
*/
- bool matchesNameFilter(const KFileItem& item) const;
+ KFileItemList childItems(const KFileItem& item) const;
+
+ /**
+ * Maps the QByteArray-roles to RoleTypes and provides translation- and
+ * group-contexts.
+ */
+ struct RoleInfoMap
+ {
+ const char* const role;
+ const RoleType roleType;
+ const char* const roleTranslationContext;
+ const char* const roleTranslation;
+ const char* const groupTranslationContext;
+ const char* const groupTranslation;
+ };
+
+ /**
+ * @return Map of user visible roles that are accessible by KFileItemModel::rolesInformation().
+ */
+ static const RoleInfoMap* rolesInfoMap(int& count);
private:
QWeakPointer<KDirLister> m_dirLister;
bool m_naturalSorting;
bool m_sortFoldersFirst;
- Role m_sortRole;
+ RoleType m_sortRole;
QSet<QByteArray> m_roles;
Qt::CaseSensitivity m_caseSensitivity;
-
+
QList<ItemData*> m_itemData;
QHash<KUrl, int> m_items; // Allows O(1) access for KFileItemModel::index(const KFileItem& item)
- QString m_nameFilter;
+ KFileItemModelFilter m_filter;
QSet<KFileItem> m_filteredItems; // Items that got hidden by KFileItemModel::setNameFilter()
bool m_requestRole[RolesCount];
mutable QList<QPair<int, QVariant> > m_groups;
// Stores the smallest expansion level of the root-URL. Is required to calculate
- // the "expansionLevel" role in an efficient way. A value < 0 indicates that
- // it has not been initialized yet.
- mutable int m_rootExpansionLevel;
+ // the "expandedParentsCount" role in an efficient way. A value < 0 indicates a
+ // special meaning:
+ enum ExpandedParentsCountRootTypes
+ {
+ // m_expandedParentsCountRoot is uninitialized and must be determined by checking
+ // the root URL from the KDirLister.
+ UninitializedExpandedParentsCountRoot = -1,
+ // All items should be forced to get an expanded parents count of 0 even if they
+ // represent child items. This is useful for slaves that provide no parent items
+ // for child items like e.g. the search IO slaves.
+ ForceExpandedParentsCountRoot = -2
+ };
+ mutable int m_expandedParentsCountRoot;
// Stores the URLs of the expanded folders.
QSet<KUrl> m_expandedUrls;
inline bool KFileItemModel::isChildItem(int index) const
{
- return m_requestRole[ExpansionLevelRole] && m_itemData.at(index)->values.value("expansionLevel").toInt() > 0;
+ return m_requestRole[ExpandedParentsCountRole] && m_itemData.at(index)->values.value("expandedParentsCount").toInt() > 0;
}
#endif
projects / dolphin.git / blobdiff