MailCommon::FilterActionWidget Class Reference

#include <filteractionwidget.h>

Inheritance diagram for MailCommon::FilterActionWidget:

Signals
void	addWidget (QWidget *)
void	filterModified ()
void	removeWidget (QWidget *)

Public Member Functions
	FilterActionWidget (QWidget *parent=0)
	~FilterActionWidget ()
MailCommon::FilterAction *	action () const
void	setAction (const MailCommon::FilterAction *action)
void	updateAddRemoveButton (bool addButtonEnabled, bool removeButtonEnabled)

Detailed Description

A widget to edit a single MailCommon::FilterAction.

This widgets allows to edit a single MailCommon::FilterAction (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.

You can load a MailCommon::FilterAction 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 MailCommon::FilterAction in KMFilterActionDict and asks each one to create a parameter widget.

Author

Marc Mutz mutz@.nosp@m.kde..nosp@m.org

See also

MailCommon::FilterAction MailCommon::MailFilter FilterActionWidgetLister

Definition at line 54 of file filteractionwidget.h.

Constructor & Destructor Documentation

FilterActionWidget::FilterActionWidget ( QWidget *  parent = 0 )

explicit

Creates a filter action widget with no type selected.

Parameters

parent

The parent widget.

Definition at line 103 of file filteractionwidget.cpp.

FilterActionWidget::~FilterActionWidget

(

)

Destroys the filter action widget.

Definition at line 180 of file filteractionwidget.cpp.

Member Function Documentation

FilterAction * FilterActionWidget::action

(

)

const

Returns the filter 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 returns that.

Definition at line 225 of file filteractionwidget.cpp.

void MailCommon::FilterActionWidget::addWidget ( QWidget *  )

signal

void MailCommon::FilterActionWidget::filterModified ( )

signal

void MailCommon::FilterActionWidget::removeWidget ( QWidget *  )

signal

void FilterActionWidget::setAction

(

const MailCommon::FilterAction *

action

)

Sets the filter action.

The action's type is determined and the corresponding widget it loaded with action's parameters and then raised.

If action is 0, the widget is cleared.

Note

The widget takes ownership of the passed action.

Definition at line 191 of file filteractionwidget.cpp.

void FilterActionWidget::updateAddRemoveButton	(	bool	addButtonEnabled,
		bool	removeButtonEnabled
	)

Definition at line 185 of file filteractionwidget.cpp.

---

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

• filteractionwidget.h
• filteractionwidget.cpp