itemsortsettings.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-05-31
 * Description : Sort settings for use with ItemFilterModel
 *
 * Copyright (C) 2009 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_ITEM_SORT_SETTINGS_H
#define DIGIKAM_ITEM_SORT_SETTINGS_H
 
// Qt includes
 
#include <QString>
#include <QVariant>
 
// Local includes
 
#include "digikam_export.h"
#include "itemsortcollator.h"
 
namespace Digikam
{
 
class ItemInfo;
class FaceTagsIface;
 
namespace DatabaseFields
{
    class Set;
}
 
class DIGIKAM_DATABASE_EXPORT ItemSortSettings
{
public:
 
    enum SortOrder
    {
        AscendingOrder  = Qt::AscendingOrder,
        DescendingOrder = Qt::DescendingOrder,
        DefaultOrder                
    };
 
    enum CategorizationMode
    {
        NoCategories,               
        OneCategory,                
        CategoryByAlbum,
        CategoryByFormat,
        CategoryByMonth,
        CategoryByFaces
    };
 
    enum SortRole
    {
        // Note: For legacy reasons, the order of the first five entries must remain unchanged
        SortByFileName,
        SortByFilePath,
        SortByCreationDate,
        SortByModificationDate,
        SortByFileSize,
        SortByRating,
        SortByImageSize,            
        SortByAspectRatio,          
        SortByFaces,                
        SortBySimilarity,
        SortByManualOrderAndName,
        SortByManualOrderAndDate
    };
 
public:
 
    explicit ItemSortSettings();
 
    bool operator==(const ItemSortSettings& other) const;
 
    int compareCategories(const ItemInfo& left, const ItemInfo& right,
                          const FaceTagsIface& leftFace, const FaceTagsIface& rightFace) const;
 
    bool lessThan(const ItemInfo& left, const ItemInfo& right) const;
 
    int compare(const ItemInfo& left, const ItemInfo& right) const;
 
    bool lessThan(const QVariant& left, const QVariant& right) const;
 
    void setSortRole(SortRole role);
    void setSortOrder(SortOrder order);
    void setStringTypeNatural(bool natural);
 
public:
 
 
    void setCategorizationMode(CategorizationMode mode);
    void setCategorizationSortOrder(SortOrder order);
 
 
    bool isCategorized() const
    {
        return (categorizationMode >= CategoryByAlbum);
    }
 
public:
 
 
    int compare(const ItemInfo& left, const ItemInfo& right, SortRole sortRole) const;
 
    static Qt::SortOrder defaultSortOrderForCategorizationMode(CategorizationMode mode);
    static Qt::SortOrder defaultSortOrderForSortRole(SortRole role);
 
public:
 
 
    DatabaseFields::Set watchFlags() const;
 
public:
 
 
    template <typename T>
    static inline bool lessThanByOrder(const T& a, const T& b, Qt::SortOrder sortOrder)
    {
        if (sortOrder == Qt::AscendingOrder)
        {
            return (a < b);
        }
 
        return (b < a);
    }
 
    template <typename T>
    static inline int compareValue(const T& a, const T& b)
    {
        if (a == b)
        {
            return 0;
        }
 
        if (a > b)
        {
            return 1;
        }
 
        return (-1);
    }
 
    static inline int compareByOrder(int compareResult, Qt::SortOrder sortOrder)
    {
        if (sortOrder == Qt::AscendingOrder)
        {
            return compareResult;
        }
 
        return (- compareResult);
    }
 
    template <typename T>
    static inline int compareByOrder(const T& a, const T& b, Qt::SortOrder sortOrder)
    {
        return compareByOrder(compareValue(a, b), sortOrder);
    }
 
    static inline int naturalCompare(const QString& a,
                                     const QString& b,
                                     Qt::SortOrder sortOrder,
                                     Qt::CaseSensitivity caseSensitive = Qt::CaseSensitive,
                                     bool natural = true)
    {
        ItemSortCollator* const sorter = ItemSortCollator::instance();
 
        return compareByOrder(sorter->itemCompare(a, b, caseSensitive, natural), sortOrder);
    }
 
public:
 
    CategorizationMode   categorizationMode;
    SortOrder            categorizationSortOrder;
 
    Qt::SortOrder        currentCategorizationSortOrder;
    Qt::CaseSensitivity  categorizationCaseSensitivity;
 
    SortRole             sortRole;
    SortOrder            sortOrder;
    bool                 strTypeNatural;
 
    Qt::SortOrder        currentSortOrder;
    Qt::CaseSensitivity  sortCaseSensitivity;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_SORT_SETTINGS_H