MailCommon::FilterImporterExporter Class
class MailCommon::FilterImporterExporterUtility class that provides persisting of filters to/from KConfig. More...
| Header: | #include <MailCommon/FilterImporterExporter> |
| CMake: | find_package(KPim6MailCommon REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::MailCommon) |
Public Functions
| FilterImporterExporter(QWidget *parent = nullptr) | |
| virtual | ~FilterImporterExporter() |
| void | exportFilters(const QList<MailCommon::MailFilter *> &filters, const QUrl &fileName = QUrl(), bool saveAll = false) |
| QList<MailCommon::MailFilter *> | importFilters(bool &canceled, MailCommon::FilterImporterExporter::FilterType type = FilterImporterExporter::KMailFilter, const QString &filename = QString()) |
Static Public Members
| QList<MailCommon::MailFilter *> | readFiltersFromConfig(const KSharedConfig::Ptr &config, bool interactive, QStringList &emptyFilters) |
| void | writeFiltersToConfig(const QList<MailCommon::MailFilter *> &filters, KSharedConfig::Ptr config, bool exportFilter = false) |
Detailed Description
Author: Till Adam <till@kdab.net>
Member Function Documentation
[explicit] FilterImporterExporter::FilterImporterExporter(QWidget *parent = nullptr)
Creates a new filter importer/exporter.
parent The parent widget.
[virtual noexcept] FilterImporterExporter::~FilterImporterExporter()
Destroys the filter importer/exporter.
void FilterImporterExporter::exportFilters(const QList<MailCommon::MailFilter *> &filters, const QUrl &fileName = QUrl(), bool saveAll = false)
Exports the given filters to the file fileName, or to a file which is asked from the user if fileName is empty. Unless saveAll is true, the list to export is also presented for confirmation/selection.
QList<MailCommon::MailFilter *> FilterImporterExporter::importFilters(bool &canceled, MailCommon::FilterImporterExporter::FilterType type = FilterImporterExporter::KMailFilter, const QString &filename = QString())
Imports filters of the given type from the file filename. If filename is empty, asks the user where to import them from. The user is also asked which filters to import. canceled is set to true if the user canceled the import.
Returns the list of imported filters.
[static] QList<MailCommon::MailFilter *> FilterImporterExporter::readFiltersFromConfig(const KSharedConfig::Ptr &config, bool interactive, QStringList &emptyFilters)
Reads a list of filters from the given config file. emptyFilters will contain filters that are empty after "purification", which removes aspects that are not applicable, usually because of references to nonexistent external entities such as accounts, folders, etc. If interactive is true, a dialog will offer to select a different account for any filter that refers to an account that doesn't exist.
Returns the list of filters read.
[static] void FilterImporterExporter::writeFiltersToConfig(const QList<MailCommon::MailFilter *> &filters, KSharedConfig::Ptr config, bool exportFilter = false)
Writes the given list of filters to the given config file. If exportFilter is true, the action arguments are written in their exportable form.