• 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
filteractionwithfolder.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_FILTERACTIONWITHFOLDER_H
21 #define MAILCOMMON_FILTERACTIONWITHFOLDER_H
22 
23 #include "filteraction.h"
24 
25 namespace MailCommon {
26 
41 class FilterActionWithFolder : public FilterAction
42 {
43  Q_OBJECT
44 
45 public:
49  FilterActionWithFolder(const QString &name, const QString &label, QObject *parent = 0 );
50 
54  virtual bool isEmpty() const;
55 
59  virtual QWidget *createParamWidget( QWidget *parent ) const;
60 
64  virtual void applyParamWidgetValue( QWidget *paramWidget );
65 
69  virtual void setParamWidgetValue( QWidget *paramWidget ) const;
70 
74  virtual void clearParamWidget( QWidget *paramWidget ) const;
75 
79  virtual void argsFromString( const QString &argsStr );
80 
84  virtual QString argsAsString() const;
85 
86  virtual bool argsFromStringInteractive( const QString &argsStr, const QString &filterName );
87 
88  virtual QString argsAsStringReal() const;
89 
93  virtual QString displayString() const;
94 
98  virtual bool folderRemoved( const Akonadi::Collection &aFolder,
99  const Akonadi::Collection &aNewFolder );
100 
101 protected:
102  Akonadi::Collection mFolder;
103 };
104 
105 }
106 
107 #endif
MailCommon::FilterActionWithFolder
Abstract base class for filter actions with a mail folder as parameter.
Definition: filteractionwithfolder.h:41
MailCommon::FilterActionWithFolder::displayString
virtual QString displayString() const
Returns a translated string describing this filter for visualization purposes, e.g.
Definition: filteractionwithfolder.cpp:117
QWidget
MailCommon::FilterActionWithFolder::argsAsString
virtual QString argsAsString() const
Return extra arguments as string.
Definition: filteractionwithfolder.cpp:108
MailCommon::FilterActionWithFolder::clearParamWidget
virtual void clearParamWidget(QWidget *paramWidget) const
The filter action shall clear it's parameter widget's contents.
Definition: filteractionwithfolder.cpp:64
QObject
MailCommon::FilterActionWithFolder::setParamWidgetValue
virtual void setParamWidgetValue(QWidget *paramWidget) const
The filter action shall set it's widget's contents from it's parameter.
Definition: filteractionwithfolder.cpp:59
MailCommon::FilterActionWithFolder::applyParamWidgetValue
virtual void applyParamWidgetValue(QWidget *paramWidget)
The filter action shall set it's parameter from the widget's contents.
Definition: filteractionwithfolder.cpp:54
MailCommon::FilterActionWithFolder::isEmpty
virtual bool isEmpty() const
Determines whether this action is valid.
Definition: filteractionwithfolder.cpp:37
MailCommon::FilterAction
Abstract base class for mail filter actions.
Definition: filteraction.h:52
MailCommon::FilterActionWithFolder::FilterActionWithFolder
FilterActionWithFolder(const QString &name, const QString &label, QObject *parent=0)
Creates a new filter action.
Definition: filteractionwithfolder.cpp:32
MailCommon::FilterActionWithFolder::argsFromString
virtual void argsFromString(const QString &argsStr)
Read extra arguments from given string.
Definition: filteractionwithfolder.cpp:97
MailCommon::FilterActionWithFolder::argsAsStringReal
virtual QString argsAsStringReal() const
Definition: filteractionwithfolder.cpp:90
MailCommon::FilterAction::label
QString label() const
Returns i18n'd label, ie.
Definition: filteraction.cpp:45
MailCommon::FilterAction::name
QString name() const
Returns identifier name, ie.
Definition: filteraction.cpp:50
MailCommon::FilterActionWithFolder::argsFromStringInteractive
virtual bool argsFromStringInteractive(const QString &argsStr, const QString &filterName)
Read extra arguments from given string.
Definition: filteractionwithfolder.cpp:69
MailCommon::FilterActionWithFolder::createParamWidget
virtual QWidget * createParamWidget(QWidget *parent) const
Creates a widget for setting the filter action parameter.
Definition: filteractionwithfolder.cpp:42
MailCommon::FilterActionWithFolder::mFolder
Akonadi::Collection mFolder
Definition: filteractionwithfolder.h:102
MailCommon::FilterActionWithFolder::folderRemoved
virtual bool folderRemoved(const Akonadi::Collection &aFolder, const Akonadi::Collection &aNewFolder)
Called from the filter when a folder is removed.
Definition: filteractionwithfolder.cpp:126
filteraction.h
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