File indexing completed on 2024-05-12 05:47:29

 /*
  * SPDX-FileCopyrightText: 2011 Janardhan Reddy <annapareddyjanardhanreddy@gmail.com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef KFILEITEMMODELFILTER_H
 #define KFILEITEMMODELFILTER_H
 
 #include "dolphin_export.h"
 
 #include <QStringList>
 
 class KFileItem;
 class QRegularExpression;
 
 /**
  * @brief Allows to check whether an item of the KFileItemModel
  *        matches with a set filter-string.
  *
  * Currently the filter is only checked for the KFileItem::text()
  * property of the KFileItem, but this might get extended in
  * future.
  */
 class DOLPHIN_EXPORT KFileItemModelFilter
 {
 public:
     KFileItemModelFilter();
     virtual ~KFileItemModelFilter();
 
     /**
      * Sets the pattern that is used for a comparison with the item
      * in KFileItemModelFilter::matches(). Per default the pattern
      * defines a sub-string. As soon as the pattern contains at least
      * a '*', '?' or '[' the pattern represents a regular expression.
      */
     void setPattern(const QString &pattern);
     QString pattern() const;
 
     /**
      * Set the list of mimetypes that are used for comparison with the
      * item in KFileItemModelFilter::matchesMimeType.
      */
     void setMimeTypes(const QStringList &types);
     QStringList mimeTypes() const;
 
     /**
      * Set the list of mimetypes that are used for comparison and excluded with the
      * item in KFileItemModelFilter::matchesMimeType.
      */
     void setExcludeMimeTypes(const QStringList &types);
     QStringList excludeMimeTypes() const;
 
     /**
      * @return True if either the pattern or mimetype filters has been set.
      */
     bool hasSetFilters() const;
 
     /**
      * @return True if the item matches with the pattern defined by
      *         @ref setPattern() or @ref setMimeTypes
      */
     bool matches(const KFileItem &item) const;
 
 private:
     /**
      * @return True if item matches pattern set by @ref setPattern.
      */
     bool matchesPattern(const KFileItem &item) const;
 
     /**
      * @return True if item matches mimetypes set by @ref setMimeTypes.
      */
     bool matchesType(const KFileItem &item) const;
 
     bool m_useRegExp; // If true, m_regExp is used for filtering,
                       // otherwise m_lowerCaseFilter is used.
     QRegularExpression *m_regExp;
     QString m_lowerCasePattern; // Lowercase version of m_filter for
                                 // faster comparison in matches().
     QString m_pattern; // Property set by setPattern().
     QStringList m_mimeTypes; // Property set by setMimeTypes()
     QStringList m_excludeMimeTypes; // Property set by setExcludeMimeTypes()
 };
 #endif