KDE PIM / Developers / API Docs / kmail

KMFilterListBox Class Reference

This is a complex widget that is used to manipulate KMail's filter list. A complex widget that allows managing a list of KMFilter's. More...

#include <kmfilterdlg.h>

Inherits QGroupBox.

List of all members.

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Attributes


Detailed Description

This is a complex widget that is used to manipulate KMail's filter list. A complex widget that allows managing a list of KMFilter's.

It consists of an internal list of filters, which is a deep copy of the list

See also:
KMFilterMgr manages, a

QListBox displaying that list, and a few buttons used to create new filters, delete them, rename them and change the order of filters.

It does not provide means to change the actual filter (besides the name), but relies on auxiliary widgets (
See also:
KMSearchPatternEdit and

KMFilterActionEdit) to do that.

Communication with this widget is quite easy: simply create an instance, connect the signals
See also:
filterSelected,

resetWidgets and

applyWidgets with a slot that does the right thing and there you go...

This widget will operate on it's own copy of the filter list as long as you don't call
See also:
slotApplyFilterChanges. It will then transfer the altered filter list back to

KMFilterMgr.

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


Constructor & Destructor Documentation

KMFilterListBox::KMFilterListBox const QString &  title,
QWidget *  parent = 0,
const char *  name = 0,
bool  popFilter = false
 

Constuctor.


Member Function Documentation

void KMFilterListBox::createFilter const QCString &  field,
const QString &  value
 

Called from.

See also:
KMFilterDlg. Creates a new filter and presets the first rule with "field equals value". It's there mainly to support "rapid filter creation" from a context menu. You should instead call

KMFilterMgr::createFilter.

KMFilterMgr::createFilter KMFilterDlg::createFilter

void KMFilterListBox::loadFilterList bool  createDummyFilter  ) 
 

Loads the filter list and selects the first filter.

Should be called when all signals are connected properly. If createDummyFilter is true, an empty filter is created to improve the usability of the dialog in case no filter has been defined so far.

bool KMFilterListBox::showLaterMsgs  ) 
 

Returns wheather the global option 'Show Later Msgs' is set or not.

void KMFilterListBox::filterSelected KMFilter *  filter  )  [signal]
 

Emitted when a new filter has been selected by the user or if the current filter has changed after a 'new' or 'delete' operation.

void KMFilterListBox::resetWidgets  )  [signal]
 

Emitted when this widget wants the edit widgets to let go of their filter reference.

Everyone holding a reference to a filter should update it from the contents of the widgets used to edit it and set their internal reference to 0.

void KMFilterListBox::applyWidgets  )  [signal]
 

Emitted when this widget wants the edit widgets to apply the changes to the current filter.

void KMFilterListBox::slotUpdateFilterName  )  [slot]
 

Called when the name of a filter might have changed (e.g.

through changing the first rule in

See also:
KMSearchPatternEdit). Updates the corresponding entry in the listbox and (if necessary) auto-names the filter.

void KMFilterListBox::slotApplyFilterChanges  )  [slot]
 

Called when the user clicks either 'Apply' or 'OK' in.

See also:
KMFilterDlg. Updates the filter list in the

KMFilterMgr.

void KMFilterListBox::slotShowLaterToggled bool  aOn  )  [slot]
 

Called when the user toggles the 'Show Download Later Msgs' Checkbox in the Global Options section.

void KMFilterListBox::slotSelected int  aIdx  )  [protected, slot]
 

Called when the user clicks on a filter in the filter list.

Calculates the corresponding filter and emits the

See also:
filterSelected signal.

void KMFilterListBox::slotNew  )  [protected, slot]
 

Called when the user clicks the 'New' button.

Creates a new empty filter just before the current one.

void KMFilterListBox::slotCopy  )  [protected, slot]
 

Called when the user clicks the 'Copy' button.

Creates a copy of the current filter and inserts it just before the current one.

void KMFilterListBox::slotDelete  )  [protected, slot]
 

Called when the user clicks the 'Delete' button.

Deletes the current filter.

void KMFilterListBox::slotUp  )  [protected, slot]
 

Called when the user clicks the 'Up' button.

Moves the current filter up one line.

void KMFilterListBox::slotDown  )  [protected, slot]
 

Called when the user clicks the 'Down' button.

Moves the current filter down one line.

void KMFilterListBox::slotRename  )  [protected, slot]
 

Called when the user clicks the 'Rename' button.

Pops up a dialog prompting to enter the new name.


Member Data Documentation

QPtrList<KMFilter> KMFilterListBox::mFilterList [protected]
 

The deep copy of the filter list.

QListBox* KMFilterListBox::mListBox [protected]
 

The listbox displaying the filter list.

QPushButton* KMFilterListBox::mBtnNew [protected]
 

The various action buttons.

QPushButton * KMFilterListBox::mBtnCopy [protected]
 

The various action buttons.

QPushButton * KMFilterListBox::mBtnDelete [protected]
 

The various action buttons.

QPushButton * KMFilterListBox::mBtnUp [protected]
 

The various action buttons.

QPushButton * KMFilterListBox::mBtnDown [protected]
 

The various action buttons.

QPushButton * KMFilterListBox::mBtnRename [protected]
 

The various action buttons.

int KMFilterListBox::mIdxSelItem [protected]
 

The index of the currently selected item.


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