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

mailcommon

  • MailCommon
  • FilterActionSetIdentity
Public Member Functions | Static Public Member Functions | List of all members
MailCommon::FilterActionSetIdentity Class Reference

#include <filteractionsetidentity.h>

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

Public Member Functions

 FilterActionSetIdentity (QObject *parent=0)
 
void applyParamWidgetValue (QWidget *parent)
 
bool argsFromStringInteractive (const QString &argsStr, const QString &filterName)
 
void clearParamWidget (QWidget *param) const
 
QWidget * createParamWidget (QWidget *parent) const
 
ReturnCode process (ItemContext &context, bool applyOnOutbound) const
 
SearchRule::RequiredPart requiredPart () const
 
void setParamWidgetValue (QWidget *parent) const
 
- Public Member Functions inherited from MailCommon::FilterActionWithUOID
 FilterActionWithUOID (const QString &name, const QString &label, QObject *parent=0)
 
virtual QString argsAsString () const
 
virtual void argsFromString (const QString &argsStr)
 
virtual QString displayString () const
 
virtual bool isEmpty () const
 
- Public Member Functions inherited from MailCommon::FilterAction
 FilterAction (const QString &name, const QString &label, QObject *parent=0)
 
virtual ~FilterAction ()
 
virtual QString argsAsStringReal () const
 
virtual bool folderRemoved (const Akonadi::Collection &aFolder, const Akonadi::Collection &aNewFolder)
 
QString label () const
 
QString name () const
 
virtual QString sieveCode () const
 
virtual QStringList sieveRequires () const
 

Static Public Member Functions

static FilterAction * newAction ()
 
- Static Public Member Functions inherited from MailCommon::FilterAction
static FilterAction * newAction ()
 
static void sendMDN (const Akonadi::Item &item, KMime::MDN::DispositionType d, const QList< KMime::MDN::DispositionModifier > &m=QList< KMime::MDN::DispositionModifier >())
 

Additional Inherited Members

- Public Types inherited from MailCommon::FilterAction
enum  ReturnCode { ErrorNeedComplete = 0x1, GoOn = 0x2, ErrorButGoOn = 0x4, CriticalError = 0x8 }
 
- Signals inherited from MailCommon::FilterAction
void filterActionModified ()
 
- Protected Attributes inherited from MailCommon::FilterActionWithUOID
uint mParameter
 

Detailed Description

Definition at line 31 of file filteractionsetidentity.h.

Constructor & Destructor Documentation

FilterActionSetIdentity::FilterActionSetIdentity ( QObject *  parent = 0)
explicit

Definition at line 40 of file filteractionsetidentity.cpp.

Member Function Documentation

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

Definition at line 109 of file filteractionsetidentity.cpp.

bool FilterActionSetIdentity::argsFromStringInteractive ( const QString &  argsStr,
const QString &  filterName 
)
virtual

Read extra arguments from given string.

Return true if we need to update config file

Reimplemented from MailCommon::FilterAction.

Definition at line 46 of file filteractionsetidentity.cpp.

void FilterActionSetIdentity::clearParamWidget ( QWidget *  paramWidget) const
virtual

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

Reimplemented from MailCommon::FilterAction.

Definition at line 117 of file filteractionsetidentity.cpp.

QWidget * FilterActionSetIdentity::createParamWidget ( QWidget *  parent) const
virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterAction.

Definition at line 99 of file filteractionsetidentity.cpp.

FilterAction * FilterActionSetIdentity::newAction ( )
static

Definition at line 35 of file filteractionsetidentity.cpp.

FilterAction::ReturnCode FilterActionSetIdentity::process ( ItemContext &  context,
bool  applyOnOutbound 
) const
virtual

Execute action on given message (inside the item context).

Returns CriticalError if a critical error has occurred (eg. disk full), ErrorButGoOn if there was a non-critical error (e.g. invalid address in 'forward' action), ErrorNeedComplete if a complete message is required, GoOn if the message shall be processed by further filters and Ok otherwise.

Implements MailCommon::FilterAction.

Definition at line 64 of file filteractionsetidentity.cpp.

SearchRule::RequiredPart FilterActionSetIdentity::requiredPart ( ) const
virtual

Returns the required part from the item that is needed for the action to operate.

See SearchRule::RequiredPart

Implements MailCommon::FilterAction.

Definition at line 93 of file filteractionsetidentity.cpp.

void FilterActionSetIdentity::setParamWidgetValue ( QWidget *  paramWidget) const
virtual

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

Reimplemented from MailCommon::FilterAction.

Definition at line 125 of file filteractionsetidentity.cpp.


The documentation for this class was generated from the following files:
  • filteractionsetidentity.h
  • filteractionsetidentity.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