• 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
filteractionsettransport.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_FILTERACTIONSETTRANSPORT_H
21 #define MAILCOMMON_FILTERACTIONSETTRANSPORT_H
22 
23 #include "filteraction.h"
24 
25 namespace MailCommon {
26 
27 //=============================================================================
28 // FilterActionSetTransport - set transport to...
29 // Specify mail transport (smtp server) to be used when replying to a message
30 //=============================================================================
31 class FilterActionSetTransport: public FilterAction
32 {
33  Q_OBJECT
34 public:
35  explicit FilterActionSetTransport( QObject *parent = 0 );
36  ReturnCode process( ItemContext &context, bool applyOnOutbound ) const;
37  SearchRule::RequiredPart requiredPart() const;
38  static FilterAction *newAction();
39  QWidget *createParamWidget( QWidget *parent ) const;
43  void applyParamWidgetValue( QWidget *paramWidget );
44 
48  void setParamWidgetValue( QWidget *paramWidget ) const;
49 
53  void clearParamWidget( QWidget *paramWidget ) const;
54 
55  bool argsFromStringInteractive( const QString &argsStr, const QString &filterName );
56 
60  void argsFromString( const QString &argsStr );
64  bool isEmpty() const;
68  QString argsAsString() const;
69 
73  QString displayString() const;
74 
75 protected:
76  int mParameter;
77  mutable QString mTransportName;
78 };
79 
80 }
81 
82 #endif
MailCommon::FilterActionSetTransport::FilterActionSetTransport
FilterActionSetTransport(QObject *parent=0)
Definition: filteractionsettransport.cpp:50
MailCommon::FilterActionSetTransport::isEmpty
bool isEmpty() const
Determines whether this action is valid.
Definition: filteractionsettransport.cpp:126
QWidget
MailCommon::FilterActionSetTransport
Definition: filteractionsettransport.h:31
MailCommon::FilterActionSetTransport::clearParamWidget
void clearParamWidget(QWidget *paramWidget) const
The filter action shall clear it's parameter widget's contents.
Definition: filteractionsettransport.cpp:109
QObject
MailCommon::FilterActionSetTransport::mParameter
int mParameter
Definition: filteractionsettransport.h:76
MailCommon::FilterAction
Abstract base class for mail filter actions.
Definition: filteraction.h:52
MailCommon::FilterActionSetTransport::process
ReturnCode process(ItemContext &context, bool applyOnOutbound) const
Execute action on given message (inside the item context).
Definition: filteractionsettransport.cpp:74
MailCommon::FilterActionSetTransport::applyParamWidgetValue
void applyParamWidgetValue(QWidget *paramWidget)
The filter action shall set it's parameter from the widget's contents.
Definition: filteractionsettransport.cpp:100
MailCommon::FilterActionSetTransport::displayString
QString displayString() const
Returns a translated string describing this filter for visualization purposes, e.g.
Definition: filteractionsettransport.cpp:141
MailCommon::FilterActionSetTransport::argsFromString
void argsFromString(const QString &argsStr)
Read extra arguments from given string.
Definition: filteractionsettransport.cpp:131
MailCommon::FilterActionSetTransport::newAction
static FilterAction * newAction()
Definition: filteractionsettransport.cpp:34
MailCommon::FilterActionSetTransport::argsAsString
QString argsAsString() const
Return extra arguments as string.
Definition: filteractionsettransport.cpp:136
MailCommon::FilterActionSetTransport::setParamWidgetValue
void setParamWidgetValue(QWidget *paramWidget) const
The filter action shall set it's widget's contents from it's parameter.
Definition: filteractionsettransport.cpp:117
MailCommon::SearchRule::RequiredPart
RequiredPart
Definition: searchpattern.h:104
MailCommon::FilterActionSetTransport::requiredPart
SearchRule::RequiredPart requiredPart() const
Returns the required part from the item that is needed for the action to operate. ...
Definition: filteractionsettransport.cpp:94
MailCommon::FilterActionSetTransport::argsFromStringInteractive
bool argsFromStringInteractive(const QString &argsStr, const QString &filterName)
Read extra arguments from given string.
Definition: filteractionsettransport.cpp:55
MailCommon::FilterAction::ReturnCode
ReturnCode
Describes the possible return codes of filter processing:
Definition: filteraction.h:60
context
const char * context
Definition: searchpatternedit.cpp:54
MailCommon::ItemContext
A helper class for the filtering process.
Definition: itemcontext.h:39
filteraction.h
MailCommon::FilterActionSetTransport::mTransportName
QString mTransportName
Definition: filteractionsettransport.h:77
MailCommon::FilterActionSetTransport::createParamWidget
QWidget * createParamWidget(QWidget *parent) const
Creates a widget for setting the filter action parameter.
Definition: filteractionsettransport.cpp: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