kmail

Public Member Functions | Protected Member Functions | List of all members
KMFilterActionDict Class Reference

#include <kmfilteraction.h>

Inherits TQDict< KMFilterActionDesc >.

Public Member Functions

void insert (KMFilterActionNewFunc aNewFunc)
 
const TQPtrList< KMFilterActionDesc > & list () const
 

Protected Member Functions

virtual void init (void)
 

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.

Author
Marc Mutz Marc@.nosp@m.Mutz.nosp@m..com, based on work by Stefan Taferner tafer.nosp@m.ner@.nosp@m.kde.o.nosp@m.rg
See also
KMFilterAction KMFilterActionDesc KMFilter

Definition at line 673 of file kmfilteraction.h.

Member Function Documentation

◆ init()

void KMFilterActionDict::init ( void  )
protectedvirtual

Populate the dictionary with all known KMFilterAction types.

Called automatically from the constructor.

Definition at line 1968 of file kmfilteraction.cpp.

◆ insert()

void KMFilterActionDict::insert ( KMFilterActionNewFunc  aNewFunc)

Overloaded member function, provided for convenience.

Thin wrapper around TQDict::insert and TQPtrList::insert. Inserts the resulting KMFilterActionDesc thrice: First with the name, then with the label as key into the TQDict, then into the TQPtrList. For that, it creates an instance of the action internally and deletes it again after querying it for name and label.

Definition at line 1997 of file kmfilteraction.cpp.

◆ list()

const TQPtrList<KMFilterActionDesc>& KMFilterActionDict::list ( ) const
inline

Provides read-only access to a list of all known filter actions.

Definition at line 689 of file kmfilteraction.h.

The documentation for this class was generated from the following files: