kmail

KMFilterListBox Class Reference

#include <kmfilterdlg.h>

List of all members.


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 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 (KMSearchPatternEdit and KMFilterActionEdit) to do that.

Communication with this widget is quite easy: simply create an instance, connect the signals 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 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

Definition at line 60 of file kmfilterdlg.h.


Public Slots

void slotUpdateFilterName ()
void slotApplyFilterChanges ()
void slotShowLaterToggled (bool aOn)

Signals

void filterSelected (KMFilter *filter)
void resetWidgets ()
void applyWidgets ()

Public Member Functions

 KMFilterListBox (const QString &title, QWidget *parent=0, const char *name=0, bool popFilter=false)
void createFilter (const QCString &field, const QString &value)
void loadFilterList (bool createDummyFilter)
bool showLaterMsgs ()

Protected Slots

void slotSelected (int aIdx)
void slotNew ()
void slotCopy ()
void slotDelete ()
void slotTop ()
void slotUp ()
void slotDown ()
void slotBottom ()
void slotRename ()

Protected Attributes

QPtrList< KMFiltermFilterList
QListBox * mListBox
QPushButton * mBtnNew
QPushButton * mBtnCopy
QPushButton * mBtnDelete
QPushButton * mBtnRename
QPushButton * mBtnTop
QPushButton * mBtnUp
QPushButton * mBtnDown
QPushButton * mBtnBot
int mIdxSelItem
bool mShowLater

Constructor & Destructor Documentation

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

Constuctor.

Definition at line 568 of file kmfilterdlg.cpp.


Member Function Documentation

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

Called from 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.

See also:
KMFilterMgr::createFilter KMFilterDlg::createFilter

Definition at line 658 of file kmfilterdlg.cpp.

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.

Definition at line 963 of file kmfilterdlg.cpp.

bool KMFilterListBox::showLaterMsgs (  ) 

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

Definition at line 675 of file kmfilterdlg.cpp.

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 KMSearchPatternEdit). Updates the corresponding entry in the listbox and (if necessary) auto-names the filter.

Definition at line 680 of file kmfilterdlg.cpp.

void KMFilterListBox::slotApplyFilterChanges (  )  [slot]

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

Updates the filter list in the KMFilterMgr.

Definition at line 713 of file kmfilterdlg.cpp.

void KMFilterListBox::slotShowLaterToggled ( bool  aOn  )  [slot]

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

Definition at line 708 of file kmfilterdlg.cpp.

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 filterSelected signal.

Definition at line 770 of file kmfilterdlg.cpp.

void KMFilterListBox::slotNew (  )  [protected, slot]

Called when the user clicks the 'New' button.

Creates a new empty filter just before the current one.

Definition at line 782 of file kmfilterdlg.cpp.

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.

Definition at line 789 of file kmfilterdlg.cpp.

void KMFilterListBox::slotDelete (  )  [protected, slot]

Called when the user clicks the 'Delete' button.

Deletes the current filter.

Definition at line 810 of file kmfilterdlg.cpp.

void KMFilterListBox::slotTop (  )  [protected, slot]

Called when the user clicks the 'Top' button.

Moves the current filter to the top line.

Definition at line 844 of file kmfilterdlg.cpp.

void KMFilterListBox::slotUp (  )  [protected, slot]

Called when the user clicks the 'Up' button.

Moves the current filter up one line.

Definition at line 859 of file kmfilterdlg.cpp.

void KMFilterListBox::slotDown (  )  [protected, slot]

Called when the user clicks the 'Down' button.

Moves the current filter down one line.

Definition at line 874 of file kmfilterdlg.cpp.

void KMFilterListBox::slotBottom (  )  [protected, slot]

Called when the user clicks the 'Bottom' button.

Moves the current filter to the bottom line.

Definition at line 889 of file kmfilterdlg.cpp.

void KMFilterListBox::slotRename (  )  [protected, slot]

Called when the user clicks the 'Rename' button.

Pops up a dialog prompting to enter the new name.

Definition at line 904 of file kmfilterdlg.cpp.


Member Data Documentation

QPtrList<KMFilter> KMFilterListBox::mFilterList [protected]

The deep copy of the filter list.

Definition at line 145 of file kmfilterdlg.h.

QListBox* KMFilterListBox::mListBox [protected]

The listbox displaying the filter list.

Definition at line 147 of file kmfilterdlg.h.

QPushButton* KMFilterListBox::mBtnNew [protected]

The various action buttons.

Definition at line 149 of file kmfilterdlg.h.

The index of the currently selected item.

Definition at line 152 of file kmfilterdlg.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys