Mailcommon

filteractionwithnone.h
1/*
2 * SPDX-FileCopyrightText: 1996-1998 Stefan Taferner <taferner@kde.org>
3 *
4 * SPDX-License-Identifier: GPL-2.0-or-later
5 *
6 */
7
8#pragma once
9
10#include "filteraction.h"
11#include "mailcommon_private_export.h"
12namespace 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 <mutz@kde.org>, based upon work by Stefan Taferner <taferner@kde.org>
26 * @see FilterAction Filter
27 */
28class MAILCOMMON_TESTS_EXPORT FilterActionWithNone : public FilterAction
29{
31
32public:
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 [[nodiscard]] QString argsAsString() const override;
47
48 /**
49 * @copydoc FilterAction::displayString
50 */
51 [[nodiscard]] QString displayString() const override;
52};
53}
QString displayString() const override
Returns a translated string describing this filter for visualization purposes, e.g.
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.
QString argsAsString() const override
Return extra arguments as string.
FilterAction(const QString &name, const QString &label, QObject *parent=nullptr)
Creates a new filter action.
QString name() const
Returns identifier name, ie.
QString label() const
Returns i18n'd label, ie.
The filter dialog.
QObject(QObject *parent)
Q_OBJECTQ_OBJECT
QObject * parent() const const
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Feb 21 2025 11:49:21 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.