MailImporter::FilterInfo Class
class MailImporter::FilterInfoThe FilterInfo class. More...
| Header: | #include <MailImporter/FilterInfo> |
| CMake: | find_package(KPim6MailImporter REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::MailImporter) |
Public Functions
| FilterInfo() | |
| ~FilterInfo() | |
| void | addErrorLogEntry(const QString &log) |
| void | addInfoLogEntry(const QString &log) |
| void | alert(const QString &message) |
| void | clear() |
| QWidget * | parentWidget() const |
| bool | removeDupMessage() const |
| void | setCurrent(const QString ¤t) |
| void | setCurrent(int percent = 0) |
| void | setFilterInfoGui(MailImporter::FilterInfoGui *filterinfogui) |
| void | setFrom(const QString &from) |
| void | setOverall(int percent = 0) |
| void | setRemoveDupMessage(bool removeDupMessage) |
| void | setStatusMessage(const QString &status) |
| void | setTo(const QString &to) |
| bool | shouldTerminate() const |
Static Public Members
| void | terminateASAP() |
Detailed Description
Member Function Documentation
FilterInfo::FilterInfo()
Constructs a FilterInfo object.
[noexcept] FilterInfo::~FilterInfo()
Destructor for FilterInfo.
void FilterInfo::addErrorLogEntry(const QString &log)
Adds an error log entry. log The error message to log
void FilterInfo::addInfoLogEntry(const QString &log)
Adds an informational log entry. log The informational message to log
void FilterInfo::alert(const QString &message)
Shows an alert dialog with the given message. message The alert message
void FilterInfo::clear()
Clears all logged entries and progress.
QWidget *FilterInfo::parentWidget() const
Returns the parent widget. Returns The parent widget
bool FilterInfo::removeDupMessage() const
Returns whether duplicate messages should be removed. Returns True if duplicates should be removed
See also setRemoveDupMessage().
void FilterInfo::setCurrent(const QString ¤t)
Sets the current item description. current The current item being processed
void FilterInfo::setCurrent(int percent = 0)
Sets the current progress percentage. percent The progress percentage (default 0)
void FilterInfo::setFilterInfoGui(MailImporter::FilterInfoGui *filterinfogui)
Sets the FilterInfoGui object for displaying progress. filterinfogui The FilterInfoGui object
void FilterInfo::setFrom(const QString &from)
Sets the source location. from The source location
void FilterInfo::setOverall(int percent = 0)
Sets the overall progress percentage. percent The overall progress percentage (default 0)
void FilterInfo::setRemoveDupMessage(bool removeDupMessage)
Sets whether duplicate messages should be removed. removeDupMessage True to remove duplicates
See also removeDupMessage().
void FilterInfo::setStatusMessage(const QString &status)
Sets the status message. status The status message to display
void FilterInfo::setTo(const QString &to)
Sets the destination location. to The destination location
bool FilterInfo::shouldTerminate() const
Returns whether termination has been requested. Returns True if termination has been requested
[static] void FilterInfo::terminateASAP()
Signals that import should terminate as soon as possible.