KDE 4.2 API Reference kmail
KMFilterActionDict Class Reference
#include <kmfilteraction.h>
Detailed Description
Dictionary that contains a list of all registered filter actions with their creation functions.They are hard-coded into the constructor. If you want to add a new KMFilterAction, make sure you add the details of it in init, too.
You will be able to find a description of a KMFilterAction by looking up either it's (english) name or it's (i18n) label:
KMFilterActionDict dict;
get name of the action with label "move into folder":
dict[i18n("move into folder")]->name; // == "transfer"
create one such action:
KMFilterAction *action = dict["transfer"]->create();
You can iterate over all known filter actions by using list.
List of known KMFilterAction-types.
- See also:
- KMFilterAction KMFilterActionDesc KMFilter
Definition at line 671 of file kmfilteraction.h.
Public Member Functions | |
| void | insert (KMFilterActionNewFunc aNewFunc) |
| KMFilterActionDict () | |
| const QList < KMFilterActionDesc * > & | list () const |
| virtual | ~KMFilterActionDict () |
Protected Member Functions | |
| virtual void | init (void) |
Constructor & Destructor Documentation
| KMFilterActionDict::KMFilterActionDict | ( | ) |
Definition at line 1940 of file kmfilteraction.cpp.
| KMFilterActionDict::~KMFilterActionDict | ( | ) | [virtual] |
Definition at line 1913 of file kmfilteraction.cpp.
Member Function Documentation
| void KMFilterActionDict::init | ( | void | ) | [protected, virtual] |
Populate the dictionary with all known KMFilterAction types.
Called automatically from the constructor.
Definition at line 1918 of file kmfilteraction.cpp.
| void KMFilterActionDict::insert | ( | KMFilterActionNewFunc | aNewFunc | ) |
Overloaded member function, provided for convenience.
Thin wrapper around QDict::insert and QPtrList::insert. Inserts the resulting KMFilterActionDesc thrice: First with the name, then with the label as key into the QDict, then into the QPtrList. For that, it creates an instance of the action internally and deletes it again after querying it for name and label.
Definition at line 1946 of file kmfilteraction.cpp.
| const QList<KMFilterActionDesc*>& KMFilterActionDict::list | ( | ) | const [inline] |
Provides read-only access to a list of all known filter actions.
Definition at line 688 of file kmfilteraction.h.
The documentation for this class was generated from the following files:
