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

mailcommon

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

#include <filteractionforward.h>

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

Public Member Functions

 FilterActionForward (QObject *parent=0)
 
void applyParamWidgetValue (QWidget *paramWidget)
 
QString argsAsString () const
 
void argsFromString (const QString &argsStr)
 
bool argsFromStringInteractive (const QString &argsStr, const QString &filterName)
 
void clearParamWidget (QWidget *paramWidget) const
 
QWidget * createParamWidget (QWidget *parent) const
 
QString displayString () const
 
ReturnCode process (ItemContext &context, bool applyOnOutbound) const
 
SearchRule::RequiredPart requiredPart () const
 
void setParamWidgetValue (QWidget *paramWidget) const
 
- Public Member Functions inherited from MailCommon::FilterActionWithAddress
 FilterActionWithAddress (const QString &name, const QString &label, QObject *parent=0)
 
- Public Member Functions inherited from MailCommon::FilterActionWithString
 FilterActionWithString (const QString &name, const QString &label, QObject *parent=0)
 
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::FilterActionWithString
QString mParameter
 

Detailed Description

Definition at line 31 of file filteractionforward.h.

Constructor & Destructor Documentation

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

Definition at line 46 of file filteractionforward.cpp.

Member Function Documentation

void FilterActionForward::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::FilterActionWithAddress.

Definition at line 132 of file filteractionforward.cpp.

QString FilterActionForward::argsAsString ( ) const
virtual

Return extra arguments as string.

Must not contain newlines.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 229 of file filteractionforward.cpp.

void FilterActionForward::argsFromString ( const QString &  argsStr)
virtual

Read extra arguments from given string.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 186 of file filteractionforward.cpp.

bool FilterActionForward::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 200 of file filteractionforward.cpp.

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

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

Reimplemented from MailCommon::FilterActionWithAddress.

Definition at line 170 of file filteractionforward.cpp.

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

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterActionWithAddress.

Definition at line 87 of file filteractionforward.cpp.

QString FilterActionForward::displayString ( ) const
virtual

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

in the filter log.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 234 of file filteractionforward.cpp.

FilterAction * FilterActionForward::newAction ( )
static

Definition at line 41 of file filteractionforward.cpp.

FilterAction::ReturnCode FilterActionForward::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 51 of file filteractionforward.cpp.

SearchRule::RequiredPart FilterActionForward::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 82 of file filteractionforward.cpp.

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

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

Reimplemented from MailCommon::FilterActionWithAddress.

Definition at line 149 of file filteractionforward.cpp.


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