KDE PIM / Developers / API Docs / kmail

KMFilterDlg Class Reference

The filter dialog. The filter dialog. More...

#include <kmfilterdlg.h>

Inherits KDialogBase.

List of all members.

Public Slots

Public Member Functions

Protected Slots

Protected Attributes


Detailed Description

The filter dialog. The filter dialog.

This is a non-modal dialog used to manage KMail's filters. It should only be called through

See also:
KMFilterMgr::openDialog. The dialog consists of three main parts:
Upon creating the dialog, a (deep) copy of the current filter list is made by
See also:
KMFilterListBox. The changed filters are local to

KMFilterListBox until the user clicks the 'Apply' button.

NOTE: Though this dialog is non-modal, it completely ignores all the stuff that goes on behind the scenes with folders esp. folder creation, move and create. The widgets that depend on the filter list and the filters that use folders as parameters are not updated as you expect. I hope this will change sometime soon.

KMFilterDlg supports the creation of new filters through context menues, dubbed "rapid filters". Call

See also:
KMFilterMgr::createFilter to use this. That call will be delivered to this dialog, which in turn delivers it to the

KMFilterListBox.

If you change the (DocBook) anchor for the filter dialog help, make sure to change const QString KMFilterDlgHelpAnchor in kmfilterdlg.cpp accordingly.

Author:
Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>.
See also:
KMFilter KMFilterActionEdit KMSearchPatternEdit KMFilterListBox


Constructor & Destructor Documentation

KMFilterDlg::KMFilterDlg QWidget *  parent = 0,
const char *  name = 0,
bool  popFilter = false,
bool  createDummyFilter = true
 

Create the filter dialog.

The only class which should be able to do this is

See also:
KMFilterMgr. This ensures that there is only a single filter dialog

Member Function Documentation

void KMFilterDlg::createFilter const QCString &  field,
const QString &  value
[inline]
 

Called from.

See also:
KMFilterMgr. Creates a new filter and presets the first rule with "field equals value". Internally forwarded to

KMFilterListBox::createFilter. You should instead call

KMFilterMgr::createFilter.

void KMFilterDlg::slotFilterSelected KMFilter *  aFilter  )  [slot]
 

Internally connected to.

See also:
KMFilterListBox::filterSelected. Just does a simple check and then calls

KMSearchPatternEdit::setSearchPattern and

KMFilterActionEdit::setActionList.

void KMFilterDlg::slotActionChanged const KMPopFilterAction  aAction  )  [slot]
 

Action for popFilter.

void KMFilterDlg::slotFinished  )  [protected, slot]
 

called when the dialog is closed (finished)


Member Data Documentation

KMFilterListBox* KMFilterDlg::mFilterList [protected]
 

The widget that contains the ListBox showing the filters, and the controls to remove filters, add new ones and to change their order.

KMSearchPatternEdit* KMFilterDlg::mPatternEdit [protected]
 

The widget that allows editing of the filter pattern.

KMFilterActionWidgetLister* KMFilterDlg::mActionLister [protected]
 

The widget that allows editing of the filter actions.

KMPopFilterActionWidget* KMFilterDlg::mActionGroup [protected]
 

The widget that allows editing the popFilter actions.

QCheckBox* KMFilterDlg::mApplyOnIn [protected]
 

Lets the user select whether to apply this filter on inbound/outbound messages, both, or only on explicit CTRL-J.

QCheckBox * KMFilterDlg::mApplyOnOut [protected]
 

Lets the user select whether to apply this filter on inbound/outbound messages, both, or only on explicit CTRL-J.

QCheckBox * KMFilterDlg::mApplyOnCtrlJ [protected]
 

Lets the user select whether to apply this filter on inbound/outbound messages, both, or only on explicit CTRL-J.


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