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

mailcommon

  • sources
  • kde-4.12
  • kdepim
  • mailcommon
  • filter
filteractionaddtag.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  */
19 
20 #ifndef MAILCOMMON_FILTERACTIONADDTAG_H
21 #define MAILCOMMON_FILTERACTIONADDTAG_H
22 
23 #include "filteractionwithstringlist.h"
24 
25 namespace MailCommon {
26 
27 //=============================================================================
28 // FilterActionAddTag - append tag to message
29 // Appends a tag to messages
30 //=============================================================================
31 class FilterActionAddTag: public FilterAction
32 {
33  Q_OBJECT
34 public:
35  explicit FilterActionAddTag( QObject *parent = 0 );
36  ReturnCode process( ItemContext &context, bool applyOnOutbound ) const;
37  SearchRule::RequiredPart requiredPart() const;
38 
39  static FilterAction* newAction();
40 
41  bool isEmpty() const;
42 
43  void argsFromString( const QString &argsStr );
44  QString argsAsString() const;
45  QString displayString() const;
46  bool argsFromStringInteractive( const QString &argsStr, const QString& filterName );
47 
48  QWidget *createParamWidget( QWidget *parent ) const;
49  void applyParamWidgetValue( QWidget *paramWidget );
50  void setParamWidgetValue( QWidget *paramWidget ) const;
51  void clearParamWidget( QWidget *paramWidget ) const;
52 
53 
54 private Q_SLOTS:
55  void slotTagListingFinished();
56 
57 private:
58  void initializeTagList();
59  mutable QMap<QUrl, QString> mList;
60  QString mParameter;
61 };
62 
63 }
64 
65 #endif
MailCommon::FilterActionAddTag::applyParamWidgetValue
void applyParamWidgetValue(QWidget *paramWidget)
The filter action shall set it's parameter from the widget's contents.
Definition: filteractionaddtag.cpp:64
MailCommon::FilterActionAddTag::argsFromString
void argsFromString(const QString &argsStr)
Read extra arguments from given string.
Definition: filteractionaddtag.cpp:130
QWidget
MailCommon::FilterActionAddTag::argsFromStringInteractive
bool argsFromStringInteractive(const QString &argsStr, const QString &filterName)
Read extra arguments from given string.
Definition: filteractionaddtag.cpp:93
MailCommon::FilterActionAddTag::newAction
static FilterAction * newAction()
Definition: filteractionaddtag.cpp:34
MailCommon::FilterActionAddTag::FilterActionAddTag
FilterActionAddTag(QObject *parent=0)
Definition: filteractionaddtag.cpp:39
MailCommon::FilterActionAddTag::isEmpty
bool isEmpty() const
Determines whether this action is valid.
Definition: filteractionaddtag.cpp:83
QObject
MailCommon::FilterAction
Abstract base class for mail filter actions.
Definition: filteraction.h:52
MailCommon::FilterActionAddTag::requiredPart
SearchRule::RequiredPart requiredPart() const
Returns the required part from the item that is needed for the action to operate. ...
Definition: filteractionaddtag.cpp:125
MailCommon::FilterActionAddTag::argsAsString
QString argsAsString() const
Return extra arguments as string.
Definition: filteractionaddtag.cpp:144
MailCommon::FilterActionAddTag
Definition: filteractionaddtag.h:31
MailCommon::FilterActionAddTag::process
ReturnCode process(ItemContext &context, bool applyOnOutbound) const
Execute action on given message (inside the item context).
Definition: filteractionaddtag.cpp:114
filteractionwithstringlist.h
MailCommon::SearchRule::RequiredPart
RequiredPart
Definition: searchpattern.h:104
MailCommon::FilterActionAddTag::displayString
QString displayString() const
Returns a translated string describing this filter for visualization purposes, e.g.
Definition: filteractionaddtag.cpp:153
MailCommon::FilterActionAddTag::clearParamWidget
void clearParamWidget(QWidget *paramWidget) const
The filter action shall clear it's parameter widget's contents.
Definition: filteractionaddtag.cpp:77
MailCommon::FilterAction::ReturnCode
ReturnCode
Describes the possible return codes of filter processing:
Definition: filteraction.h:60
MailCommon::FilterActionAddTag::createParamWidget
QWidget * createParamWidget(QWidget *parent) const
Creates a widget for setting the filter action parameter.
Definition: filteractionaddtag.cpp:46
MailCommon::FilterActionAddTag::setParamWidgetValue
void setParamWidgetValue(QWidget *paramWidget) const
The filter action shall set it's widget's contents from it's parameter.
Definition: filteractionaddtag.cpp:70
context
const char * context
Definition: searchpatternedit.cpp:54
MailCommon::ItemContext
A helper class for the filtering process.
Definition: itemcontext.h:39
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:55:14 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