Mailcommon

filteractionwithnone.h
1 /*
2  * SPDX-FileCopyrightText: 1996-1998 Stefan Taferner <[email protected]>
3  *
4  * SPDX-License-Identifier: GPL-2.0-or-later
5  *
6  */
7 
8 #pragma once
9 
10 #include "filteraction.h"
11 
12 namespace MailCommon
13 {
14 /**
15  * @short Abstract base class for filter actions with no parameter.
16  *
17  * Abstract base class for mail filter actions that need no
18  * parameter, e.g. "Confirm Delivery". Creates an (empty) QWidget as
19  * parameter widget. A subclass of this must provide at least
20  * implementations for the following methods:
21  *
22  * @li virtual FilterAction::ReturnCodes FilterAction::process
23  * @li static FilterAction::newAction
24  *
25  * @author Marc Mutz <[email protected]>, based upon work by Stefan Taferner <[email protected]>
26  * @see FilterAction Filter
27  */
29 {
30  Q_OBJECT
31 
32 public:
33  /**
34  * @copydoc FilterAction::FilterAction
35  */
36  FilterActionWithNone(const QString &name, const QString &label, QObject *parent = nullptr);
37 
38  /**
39  * @copydoc FilterAction::argsFromString
40  */
41  void argsFromString(const QString &) override;
42 
43  /**
44  * @copydoc FilterAction::argsAsString
45  */
46  Q_REQUIRED_RESULT QString argsAsString() const override;
47 
48  /**
49  * @copydoc FilterAction::displayString
50  */
51  Q_REQUIRED_RESULT QString displayString() const override;
52 };
53 }
Q_OBJECTQ_OBJECT
QString argsAsString() const override
Return extra arguments as string.
Abstract base class for filter actions with no parameter.
QString name() const
Returns identifier name, ie.
Abstract base class for mail filter actions.
Definition: filteraction.h:38
QString displayString() const override
Returns a translated string describing this filter for visualization purposes, e.g.
QString label() const
Returns i18n'd label, ie.
FilterActionWithNone(const QString &name, const QString &label, QObject *parent=nullptr)
Creates a new filter action.
void argsFromString(const QString &) override
Read extra arguments from given string.
QObject * parent() const const
The filter dialog.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sat Oct 1 2022 04:00:53 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.