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

mailcommon

  • sources
  • kde-4.14
  • kdepim
  • mailcommon
  • filter
  • filteractions
filteractionwithfolder.cpp
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 #include "filteractionwithfolder.h"
21 
22 #include "folderrequester.h"
23 #include "kernel/mailkernel.h"
24 #include "util/mailutil.h"
25 #include "dialog/filteractionmissingargumentdialog.h"
26 
27 #include <QTextDocument>
28 #include <QPointer>
29 
30 using namespace MailCommon;
31 
32 FilterActionWithFolder::FilterActionWithFolder( const QString &name, const QString &label, QObject *parent )
33  : FilterAction( name, label, parent )
34 {
35 }
36 
37 bool FilterActionWithFolder::isEmpty() const
38 {
39  return !mFolder.isValid();
40 }
41 
42 QWidget* FilterActionWithFolder::createParamWidget( QWidget *parent ) const
43 {
44  FolderRequester *requester = new FolderRequester( parent );
45  requester->setObjectName(QLatin1String("folderrequester"));
46  requester->setShowOutbox( false );
47  setParamWidgetValue( requester );
48 
49  connect( requester, SIGNAL(folderChanged(Akonadi::Collection)),
50  this, SIGNAL(filterActionModified()) );
51 
52  return requester;
53 }
54 
55 void FilterActionWithFolder::applyParamWidgetValue( QWidget *paramWidget )
56 {
57  mFolder = static_cast<FolderRequester*>( paramWidget )->collection();
58 }
59 
60 void FilterActionWithFolder::setParamWidgetValue( QWidget *paramWidget ) const
61 {
62  static_cast<FolderRequester*>( paramWidget )->setCollection( mFolder );
63 }
64 
65 void FilterActionWithFolder::clearParamWidget( QWidget *paramWidget ) const
66 {
67  static_cast<FolderRequester*>( paramWidget )->setCollection( CommonKernel->draftsCollectionFolder() );
68 }
69 
70 bool FilterActionWithFolder::argsFromStringInteractive( const QString &argsStr , const QString& name)
71 {
72  bool needUpdate = false;
73  argsFromString( argsStr );
74  if ( !mFolder.isValid() ) {
75  bool exactPath = false;
76  Akonadi::Collection::List lst = FilterActionMissingCollectionDialog::potentialCorrectFolders( argsStr, exactPath );
77  if ( lst.count() == 1 && exactPath )
78  mFolder = lst.at( 0 );
79  else {
80  QPointer<FilterActionMissingCollectionDialog> dlg = new FilterActionMissingCollectionDialog( lst, name, argsStr );
81  if ( dlg->exec() ) {
82  mFolder = dlg->selectedCollection();
83  needUpdate = true;
84  }
85  delete dlg;
86  }
87  }
88  return needUpdate;
89 }
90 
91 QString FilterActionWithFolder::argsAsStringReal() const
92 {
93  if ( KernelIf->collectionModel() )
94  return MailCommon::Util::fullCollectionPath( mFolder );
95  return FilterActionWithFolder::argsAsString();
96 }
97 
98 void FilterActionWithFolder::argsFromString( const QString &argsStr )
99 {
100  bool ok = false;
101  const Akonadi::Collection::Id id = argsStr.toLongLong( &ok );
102  if ( ok ) {
103  mFolder = Akonadi::Collection( id );
104  } else {
105  mFolder = Akonadi::Collection();
106  }
107 }
108 
109 QString FilterActionWithFolder::argsAsString() const
110 {
111  QString result;
112  if ( mFolder.isValid() )
113  result = QString::number( mFolder.id() );
114 
115  return result;
116 }
117 
118 QString FilterActionWithFolder::displayString() const
119 {
120  QString result;
121  if ( mFolder.isValid() )
122  result = MailCommon::Util::fullCollectionPath(MailCommon::Util::updatedCollection( mFolder ));
123 
124  return label() + QLatin1String( " \"" ) + Qt::escape( result ) + QLatin1String( "\"" );
125 }
126 
127 bool FilterActionWithFolder::folderRemoved( const Akonadi::Collection &oldFolder, const Akonadi::Collection &newFolder )
128 {
129  if ( oldFolder == mFolder ) {
130  mFolder = newFolder;
131  return true;
132  } else
133  return false;
134 }
135 
136 
MailCommon::FilterActionWithFolder::displayString
virtual QString displayString() const
Returns a translated string describing this filter for visualization purposes, e.g.
Definition: filteractionwithfolder.cpp:118
folderrequester.h
QWidget
KernelIf
#define KernelIf
Definition: mailkernel.h:191
QPointer
filteractionmissingargumentdialog.h
MailCommon::FilterActionWithFolder::argsAsString
virtual QString argsAsString() const
Return extra arguments as string.
Definition: filteractionwithfolder.cpp:109
MailCommon::FilterActionWithFolder::clearParamWidget
virtual void clearParamWidget(QWidget *paramWidget) const
The filter action shall clear it's parameter widget's contents.
Definition: filteractionwithfolder.cpp:65
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:60
MailCommon::FilterActionWithFolder::applyParamWidgetValue
virtual void applyParamWidgetValue(QWidget *paramWidget)
The filter action shall set it's parameter from the widget's contents.
Definition: filteractionwithfolder.cpp:55
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
QString::number
QString number(int n, int base)
MailCommon::FolderRequester::setShowOutbox
void setShowOutbox(bool show)
Definition: folderrequester.cpp:185
QObject
filteractionwithfolder.h
FilterActionMissingCollectionDialog
Definition: filteractionmissingargumentdialog.h:49
QObject::setObjectName
void setObjectName(const QString &name)
MailCommon::FilterActionWithFolder::FilterActionWithFolder
FilterActionWithFolder(const QString &name, const QString &label, QObject *parent=0)
Creates a new filter action.
Definition: filteractionwithfolder.cpp:32
MailCommon::FolderRequester
A widget that contains a KLineEdit which shows the current folder and a button that fires a FolderSel...
Definition: folderrequester.h:59
MailCommon::FilterActionWithFolder::argsFromString
virtual void argsFromString(const QString &argsStr)
Read extra arguments from given string.
Definition: filteractionwithfolder.cpp:98
MailCommon::FilterActionWithFolder::argsAsStringReal
virtual QString argsAsStringReal() const
Definition: filteractionwithfolder.cpp:91
MailCommon::Util::updatedCollection
MAILCOMMON_EXPORT Akonadi::Collection updatedCollection(const Akonadi::Collection &col)
Definition: mailutil.cpp:403
QString
MailCommon::FilterAction::label
QString label() const
Returns i18n'd label, ie.
Definition: filteraction.cpp:45
MailCommon::FilterActionWithFolder::argsFromStringInteractive
virtual bool argsFromStringInteractive(const QString &argsStr, const QString &filterName)
Read extra arguments from given string.
Definition: filteractionwithfolder.cpp:70
CommonKernel
#define CommonKernel
Definition: mailkernel.h:194
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
QLatin1String
mailkernel.h
MailCommon::Util::fullCollectionPath
MAILCOMMON_EXPORT QString fullCollectionPath(const Akonadi::Collection &collection)
Definition: mailutil.cpp:115
Qt::escape
QString escape(const QString &plain)
MailCommon::FilterAction::filterActionModified
void filterActionModified()
Called to notify that the current FilterAction has had some value modification.
QObject::connect
bool connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
mailutil.h
QString::toLongLong
qlonglong toLongLong(bool *ok, int base) const
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:127
FilterActionMissingCollectionDialog::potentialCorrectFolders
static Akonadi::Collection::List potentialCorrectFolders(const QString &path, bool &exactPath)
Definition: filteractionmissingargumentdialog.cpp:166
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:31:40 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
  • pimprint

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