KDE PIM / Developers / API Docs / kmail

KMFilterActionWidget Class Reference

This widgets allows to edit a single A widget to edit a single KMFilterAction. More...

#include <kmfilterdlg.h>

Inherits QHBox.

List of all members.

Public Member Functions


Detailed Description

This widgets allows to edit a single A widget to edit a single KMFilterAction.

See also:
KMFilterAction (in fact any derived class that is registered in

KMFilterActionDict). It consists of a combo box which allows to select the type of actions this widget should act upon and a

QWidgetStack, which holds the parameter widgets for the different rule types.

You can load a
See also:
KMFilterAction into this widget with

setAction, and retrieve the result of user action with

action. The widget will copy it's setting into the corresponding parameter widget. For that, it internally creates an instance of every

KMFilterAction in

KMFilterActionDict and asks each one to create a parameter widget. The parameter widgets are put on the widget stack and are raised when their corresponding action type is selected in the combo box.

Author:
Marc Mutz <Marc@Mutz.com>
See also:
KMFilterAction KMFilter KMFilterActionWidgetLister


Constructor & Destructor Documentation

KMFilterActionWidget::KMFilterActionWidget QWidget *  parent = 0,
const char *  name = 0
 

Constructor.

Creates a filter action widget with no type selected.


Member Function Documentation

void KMFilterActionWidget::setAction const KMFilterAction aAction  ) 
 

Set an action.

The action's type is determined and the corresponding widget it loaded with aAction's parameters and then raised. If @ aAction is 0, the widget is cleared.

KMFilterAction * KMFilterActionWidget::action  ) 
 

Retrieve the action.

This method is necessary because the type of actions can change during editing. Therefore the widget always creates a new action object from the data in the combo box and the widget stack and returns that.


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