KDE PIM / Developers / API Docs / kmail

KMFilterActionDict Class Reference

Dictionary that contains a list of all registered filter actions with their creation functions. List of known KMFilterAction-types. More...

#include <kmfilteraction.h>

Inherits QDict.

List of all members.

Public Member Functions

Protected Member Functions


Detailed Description

Dictionary that contains a list of all registered filter actions with their creation functions. List of known KMFilterAction-types.

They are hard-coded into the constructor. If you want to add a new

See also:
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

See also:
list.

Author:
Marc Mutz <Marc@Mutz.com>, based on work by Stefan Taferner <taferner@kde.org>
See also:
KMFilterAction KMFilterActionDesc KMFilter


Member Function Documentation

void KMFilterActionDict::insert KMFilterActionNewFunc  aNewFunc  ) 
 

Overloaded member function, provided for convenience.

Thin wrapper around

See also:
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.

const QPtrList<KMFilterActionDesc>& KMFilterActionDict::list  )  const [inline]
 

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

void KMFilterActionDict::init void   )  [protected, virtual]
 

Populate the dictionary with all known.

See also:
KMFilterAction types. Called automatically from the constructor.

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