• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

mailcommon

  • MailCommon
  • KMFilterListBox
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Attributes | List of all members
MailCommon::KMFilterListBox Class Reference

#include <kmfilterdialog.h>

Inheritance diagram for MailCommon::KMFilterListBox:
Inheritance graph
[legend]

Public Slots

void slotApplyFilterChanges (KDialog::ButtonCode)
 
void slotUpdateFilterName ()
 

Signals

void abortClosing () const
 
void applyWidgets ()
 
void filterCreated ()
 
void filterOrderAltered ()
 
void filterRemoved (const QList< MailCommon::MailFilter * > &filter)
 
void filterSelected (MailCommon::MailFilter *filter)
 
void filterUpdated (MailCommon::MailFilter *filter)
 
void resetWidgets ()
 

Public Member Functions

 KMFilterListBox (const QString &title, QWidget *parent=0)
 
 ~KMFilterListBox ()
 
void appendFilter (MailCommon::MailFilter *aFilter)
 
void createFilter (const QByteArray &field, const QString &value)
 
QList< MailCommon::MailFilter * > filtersForSaving (bool closeAfterSaving) const
 
void insertFilter (MailCommon::MailFilter *aFilter)
 
void loadFilterList (bool createDummyFilter)
 
QStringList selectedFilterId (SearchRule::RequiredPart &requiredPart, const QString &resource) const
 

Protected Slots

void slotBottom ()
 
void slotCopy ()
 
void slotDelete ()
 
void slotDown ()
 
void slotFilterEnabledChanged (QListWidgetItem *item)
 
void slotNew ()
 
void slotRename ()
 
void slotRowsMoved (const QModelIndex &, int, int, const QModelIndex &, int)
 
void slotSelected (int aIdx)
 
void slotSelectionChanged ()
 
void slotTop ()
 
void slotUp ()
 

Protected Attributes

QPushButton * mBtnBottom
 
QPushButton * mBtnCopy
 
QPushButton * mBtnDelete
 
QPushButton * mBtnDown
 
QPushButton * mBtnNew
 
QPushButton * mBtnRename
 
QPushButton * mBtnTop
 
QPushButton * mBtnUp
 
QListWidget * mListWidget
 

Detailed Description

Definition at line 97 of file kmfilterdialog.h.

Constructor & Destructor Documentation

MailCommon::KMFilterListBox::KMFilterListBox ( const QString &  title,
QWidget *  parent = 0 
)
explicit

Constructor.

Definition at line 894 of file kmfilterdialog.cpp.

MailCommon::KMFilterListBox::~KMFilterListBox ( )

Destructor.

Definition at line 1019 of file kmfilterdialog.cpp.

Member Function Documentation

void MailCommon::KMFilterListBox::abortClosing ( ) const
signal

Emitted when the user decides to continue editing after being warned about invalid filters.

void MailCommon::KMFilterListBox::appendFilter ( MailCommon::MailFilter *  aFilter)

Definition at line 1620 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::applyWidgets ( )
signal

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

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

Called from KMFilterDialog.

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 KMFilterDialog::createFilter

Definition at line 1059 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::filterCreated ( )
signal

Emitted when a new filter is created.

void MailCommon::KMFilterListBox::filterOrderAltered ( )
signal

Emitted whenever the order in which the filters are displayed is changed.

void MailCommon::KMFilterListBox::filterRemoved ( const QList< MailCommon::MailFilter * > &  filter)
signal

Emitted when a filter is deleted.

void MailCommon::KMFilterListBox::filterSelected ( MailCommon::MailFilter *  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.

QList< MailFilter * > MailCommon::KMFilterListBox::filtersForSaving ( bool  closeAfterSaving) const

Returns a list of copies of the current list of filters.

The list owns the contents and thus the caller needs to clean them up.

Parameters
closeAfterSavingIf true user is given option to continue editing after being warned about invalid filters. Otherwise, user is just warned.

Definition at line 1147 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::filterUpdated ( MailCommon::MailFilter *  filter)
signal

Emitted when a filter is updated (e.g.

renamed).

void MailCommon::KMFilterListBox::insertFilter ( MailCommon::MailFilter *  aFilter)

Definition at line 1599 of file kmfilterdialog.cpp.

void MailCommon::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 1561 of file kmfilterdialog.cpp.

void MailCommon::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.

QStringList MailCommon::KMFilterListBox::selectedFilterId ( SearchRule::RequiredPart &  requiredPart,
const QString &  resource 
) const

Definition at line 1371 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotApplyFilterChanges ( KDialog::ButtonCode  button)
slot

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

Updates the filter list in the FilterManager.

Definition at line 1123 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotBottom ( )
protectedslot

Called when the user clicks the 'Bottom' button.

Moves the current filter to bottom.

Definition at line 1388 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotCopy ( )
protectedslot

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 1237 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotDelete ( )
protectedslot

Called when the user clicks the 'Delete' button.

Deletes the current filter.

Definition at line 1262 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotDown ( )
protectedslot

Called when the user clicks the 'Down' button.

Moves the current filter down one line.

Definition at line 1449 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotFilterEnabledChanged ( QListWidgetItem *  item)
protectedslot

Definition at line 1035 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotNew ( )
protectedslot

Called when the user clicks the 'New' button.

Creates a new empty filter just before the current one.

Definition at line 1226 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotRename ( )
protectedslot

Called when the user clicks the 'Rename' button.

Pops up a dialog prompting to enter the new name.

Definition at line 1480 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotRowsMoved ( const QModelIndex &  ,
int  sourcestart,
int  sourceEnd,
const QModelIndex &  ,
int  destinationRow 
)
protectedslot

Definition at line 1047 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotSelected ( int  aIdx)
protectedslot

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

Calculates the corresponding filter and emits the filterSelected signal.

Definition at line 1208 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotSelectionChanged ( )
protectedslot

Definition at line 1200 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotTop ( )
protectedslot

Called when the user clicks the 'Top' button.

Moves the current filter to top.

Definition at line 1328 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotUp ( )
protectedslot

Called when the user clicks the 'Up' button.

Moves the current filter up one line.

Definition at line 1421 of file kmfilterdialog.cpp.

void MailCommon::KMFilterListBox::slotUpdateFilterName ( )
slot

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

through changing the first rule in SearchPatternEdit). Updates the corresponding entry in the listbox and (if necessary) auto-names the filter.

Definition at line 1078 of file kmfilterdialog.cpp.

Member Data Documentation

QPushButton* MailCommon::KMFilterListBox::mBtnBottom
protected

Definition at line 276 of file kmfilterdialog.h.

QPushButton* MailCommon::KMFilterListBox::mBtnCopy
protected

Definition at line 270 of file kmfilterdialog.h.

QPushButton* MailCommon::KMFilterListBox::mBtnDelete
protected

Definition at line 271 of file kmfilterdialog.h.

QPushButton* MailCommon::KMFilterListBox::mBtnDown
protected

Definition at line 273 of file kmfilterdialog.h.

QPushButton* MailCommon::KMFilterListBox::mBtnNew
protected

The various action buttons.

Definition at line 269 of file kmfilterdialog.h.

QPushButton* MailCommon::KMFilterListBox::mBtnRename
protected

Definition at line 274 of file kmfilterdialog.h.

QPushButton* MailCommon::KMFilterListBox::mBtnTop
protected

Definition at line 275 of file kmfilterdialog.h.

QPushButton* MailCommon::KMFilterListBox::mBtnUp
protected

Definition at line 272 of file kmfilterdialog.h.

QListWidget* MailCommon::KMFilterListBox::mListWidget
protected

The listbox displaying the filter list.

Definition at line 266 of file kmfilterdialog.h.


The documentation for this class was generated from the following files:
  • kmfilterdialog.h
  • kmfilterdialog.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:55:15 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

mailcommon

Skip menu "mailcommon"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal