File indexing completed on 2024-05-12 16:39:37

 /* This file is part of the KDE project
    Copyright (C) 2003-2018 Jarosław Staniek <staniek@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
 */
 
 #ifndef KEXIFILEFILTERS_H
 #define KEXIFILEFILTERS_H
 
 #include "kexicore_export.h"
 
 #include <QList>
 
 class QMimeType;
 class QString;
 class QStringList;
 
 //! Format specification for KexiFileFilters
 class KEXICORE_EXPORT KexiFileFiltersFormat
 {
 public:
     //! Format type
     enum class Type {
         Qt, //!< QFileDialog-compatible format, e.g. "Image files (*.png *.xpm *.jpg)", ";;"
             //!< separators
         KDE, //!< KDE-compatible format, e.g. "*.png *.xpm *.jpg|Image files (*.png *.xpm
              //!< *.jpg)", "\\n" separators
         KUrlRequester //!< KUrlRequester-compatible format, e.g. "*.png *.xpm *.jpg|Image
                       //!< files", "\\n" separators
     };
 
     Type type = Type::KDE;
 
     //!< Add "All files" entry needed e.g. for KexiFileRequester because KFileFilterCombo does not
     //! add it automatically while KFileWidget does.
     bool addAllFiles = false;
 };
 
 //! A tool for handling file filters for Kexi
 class KEXICORE_EXPORT KexiFileFilters
 {
 public:
     //! Filter mode
     enum Mode {
         Opening, //!< Opening existing database (or shortcut)
         CustomOpening, //!< Used for opening other files, like CSV
         SavingFileBasedDB, //!< Saving file-based database file
         CustomSavingFileBasedDB, //!< Used for saving other files, like CSV
         SavingServerBasedDB //!< Saving server-based (shortcut) file
     };
 
     KexiFileFilters();
     ~KexiFileFilters();
 
     //! @return mode for the filer
     Mode mode() const;
 
     //! Sets mode for the filter
     void setMode(Mode mode);
 
     /*! Sets a default-filter, that is used when an empty filter is set.
      * By default, this is set to "All Supported Files"
      * @see defaultFilter
      */
     void setDefaultFilter(const QString &filter);
 
     /**
      * @return the default filter, used when an empty filter is set.
      * @see setDefaultFilter
      */
     QString defaultFilter() const;
 
     //! @return additional mime types
     QStringList additionalMimeTypes() const;
 
     //! Sets additional mime types, e.g. "text/x-csv"
     void setAdditionalMimeTypes(const QStringList &mimeTypes);
 
     //! @return excluded mime types
     QStringList excludedMimeTypes() const;
 
     //! Set excluded mime types
     void setExcludedMimeTypes(const QStringList &mimeTypes);
 
     //! @return glob patterns for all mime types for given mode
     //! Includes additional mime types and excludes miem types specified by excludedMimeTypes().
     QStringList allGlobPatterns() const;
 
     //! @return mime types for this filter
     QList<QMimeType> mimeTypes() const;
 
     //! @return mime types names for this filter
     QStringList mimeTypeNames() const;
 
     //! @return @c true if existing file is required
     //! This is true for Opening and CustomOpening modes.
     bool isExistingFileRequired() const;
 
     static QString separator(const KexiFileFiltersFormat &format);
 
     //! @return filters based on supplied parameters in given format
     QString toString(const KexiFileFiltersFormat &format) const;
 
     //! @return list of filters based on supplied parameters in given format
     QStringList toList(const KexiFileFiltersFormat &format) const;
 
     //! @return filter string in given format
     static QString toString(const QMimeType &mime, const KexiFileFiltersFormat &format);
 
     //! @overload
     static QString toString(const QString& mimeName, const KexiFileFiltersFormat &format);
 
     //! @overload
     static QString toString(const QStringList &patterns, const QString &comment,
                             const KexiFileFiltersFormat &format);
 
     //! Static version of QString KexiFileFilters::toString(Format format) const
     static QString toString(const QStringList& mimeNames, const KexiFileFiltersFormat &format);
 
     //! Static version of QStringList toList(Format format) const
     static QStringList toList(const QStringList& mimeNames, const KexiFileFiltersFormat &format);
 
 private:
     class Private;
     Private * const d;
 };
 
 #endif