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

kmail

KMFilterActionWithTest Class Reference

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithTest:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 593 of file kmfilteraction.h.


Public Member Functions

virtual void applyParamWidgetValue (QWidget *paramWidget)
virtual const QString argsAsString () const
virtual void argsFromString (const QString &argsStr)
virtual void clearParamWidget (QWidget *paramWidget) const
virtual QWidget * createParamWidget (QWidget *parent) const
virtual const QString displayString () const
virtual bool isEmpty () const
 KMFilterActionWithTest (const char *aName, const QString &aLabel)
virtual void setParamWidgetValue (QWidget *paramWidget) const
 ~KMFilterActionWithTest ()

Protected Attributes

QString mParameter

Constructor & Destructor Documentation

KMFilterActionWithTest::KMFilterActionWithTest ( const char *  aName,
const QString &  aLabel 
)

Initialize filter action with (english) name aName.

This is the name under which this action is known in the config file.

Definition at line 1774 of file kmfilteraction.cpp.

KMFilterActionWithTest::~KMFilterActionWithTest (  ) 

Definition at line 1779 of file kmfilteraction.cpp.


Member Function Documentation

void KMFilterActionWithTest::applyParamWidgetValue ( QWidget *  paramWidget  )  [virtual]

The filter action shall set it's parameter from the widget's contents.

It is allowed that the value is read by the action before this function is called.

Reimplemented from KMFilterAction.

Definition at line 1791 of file kmfilteraction.cpp.

const QString KMFilterActionWithTest::argsAsString (  )  const [virtual]

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 1811 of file kmfilteraction.cpp.

void KMFilterActionWithTest::argsFromString ( const QString &  argsStr  )  [virtual]

Read extra arguments from given string.

Implements KMFilterAction.

Definition at line 1806 of file kmfilteraction.cpp.

void KMFilterActionWithTest::clearParamWidget ( QWidget *  paramWidget  )  const [virtual]

The filter action shall clear it's parameter widget's contents.

Reimplemented from KMFilterAction.

Definition at line 1801 of file kmfilteraction.cpp.

QWidget * KMFilterActionWithTest::createParamWidget ( QWidget *  parent  )  const [virtual]

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from KMFilterAction.

Definition at line 1783 of file kmfilteraction.cpp.

const QString KMFilterActionWithTest::displayString (  )  const [virtual]

Returns a translated string describing this filter for visualization purposes, e.g.

in the filter log.

Implements KMFilterAction.

Definition at line 1816 of file kmfilteraction.cpp.

virtual bool KMFilterActionWithTest::isEmpty (  )  const [inline, virtual]

Determines whether this action is valid.

But this is just a quick test. Eg., actions that have a mail address as parameter shouldn't try real address validation, but only check if the string representation is empty.

Reimplemented from KMFilterAction.

Definition at line 604 of file kmfilteraction.h.

void KMFilterActionWithTest::setParamWidgetValue ( QWidget *  paramWidget  )  const [virtual]

The filter action shall set it's widget's contents from it's parameter.

Reimplemented from KMFilterAction.

Definition at line 1796 of file kmfilteraction.cpp.


Member Data Documentation

QString KMFilterActionWithTest::mParameter [protected]

Definition at line 634 of file kmfilteraction.h.


The documentation for this class was generated from the following files:
  • kmfilteraction.h
  • kmfilteraction.cpp

kmail

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

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal