• 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.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->setShowOutbox( false );
46  setParamWidgetValue( requester );
47 
48  connect( requester, SIGNAL(folderChanged(Akonadi::Collection)),
49  this, SIGNAL(filterActionModified()) );
50 
51  return requester;
52 }
53 
54 void FilterActionWithFolder::applyParamWidgetValue( QWidget *paramWidget )
55 {
56  mFolder = static_cast<FolderRequester*>( paramWidget )->collection();
57 }
58 
59 void FilterActionWithFolder::setParamWidgetValue( QWidget *paramWidget ) const
60 {
61  static_cast<FolderRequester*>( paramWidget )->setCollection( mFolder );
62 }
63 
64 void FilterActionWithFolder::clearParamWidget( QWidget *paramWidget ) const
65 {
66  static_cast<FolderRequester*>( paramWidget )->setCollection( CommonKernel->draftsCollectionFolder() );
67 }
68 
69 bool FilterActionWithFolder::argsFromStringInteractive( const QString &argsStr , const QString& name)
70 {
71  bool needUpdate = false;
72  argsFromString( argsStr );
73  if ( !mFolder.isValid() ) {
74  bool exactPath = false;
75  Akonadi::Collection::List lst = FilterActionMissingCollectionDialog::potentialCorrectFolders( argsStr, exactPath );
76  if ( lst.count() == 1 && exactPath )
77  mFolder = lst.at( 0 );
78  else {
79  QPointer<FilterActionMissingCollectionDialog> dlg = new FilterActionMissingCollectionDialog( lst, name, argsStr );
80  if ( dlg->exec() ) {
81  mFolder = dlg->selectedCollection();
82  needUpdate = true;
83  }
84  delete dlg;
85  }
86  }
87  return needUpdate;
88 }
89 
90 QString FilterActionWithFolder::argsAsStringReal() const
91 {
92  if ( KernelIf->collectionModel() )
93  return MailCommon::Util::fullCollectionPath( mFolder );
94  return FilterActionWithFolder::argsAsString();
95 }
96 
97 void FilterActionWithFolder::argsFromString( const QString &argsStr )
98 {
99  bool ok = false;
100  const Akonadi::Collection::Id id = argsStr.toLongLong( &ok );
101  if ( ok ) {
102  mFolder = Akonadi::Collection( id );
103  } else {
104  mFolder = Akonadi::Collection();
105  }
106 }
107 
108 QString FilterActionWithFolder::argsAsString() const
109 {
110  QString result;
111  if ( mFolder.isValid() )
112  result = QString::number( mFolder.id() );
113 
114  return result;
115 }
116 
117 QString FilterActionWithFolder::displayString() const
118 {
119  QString result;
120  if ( mFolder.isValid() )
121  result = MailCommon::Util::fullCollectionPath(MailCommon::Util::updatedCollection( mFolder ));
122 
123  return label() + QLatin1String( " \"" ) + Qt::escape( result ) + QLatin1String( "\"" );
124 }
125 
126 bool FilterActionWithFolder::folderRemoved( const Akonadi::Collection &oldFolder, const Akonadi::Collection &newFolder )
127 {
128  if ( oldFolder == mFolder ) {
129  mFolder = newFolder;
130  return true;
131  } else
132  return false;
133 }
134 
135 
136 #include "filteractionwithfolder.moc"
MailCommon::FilterActionWithFolder::displayString
virtual QString displayString() const
Returns a translated string describing this filter for visualization purposes, e.g.
Definition: filteractionwithfolder.cpp:117
folderrequester.h
KernelIf
#define KernelIf
Definition: mailkernel.h:186
QWidget
filteractionmissingargumentdialog.h
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::FolderRequester::setShowOutbox
void setShowOutbox(bool show)
Definition: folderrequester.cpp:185
filteractionwithfolder.h
FilterActionMissingCollectionDialog
Definition: filteractionmissingargumentdialog.h:49
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:97
MailCommon::FilterActionWithFolder::argsAsStringReal
virtual QString argsAsStringReal() const
Definition: filteractionwithfolder.cpp:90
MailCommon::Util::updatedCollection
MAILCOMMON_EXPORT Akonadi::Collection updatedCollection(const Akonadi::Collection &col)
Definition: mailutil.cpp:609
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:69
CommonKernel
#define CommonKernel
Definition: mailkernel.h:189
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
mailkernel.h
MailCommon::Util::fullCollectionPath
MAILCOMMON_EXPORT QString fullCollectionPath(const Akonadi::Collection &collection)
Definition: mailutil.cpp:117
MailCommon::FilterAction::filterActionModified
void filterActionModified()
Called to notify that the current FilterAction has had some value modification.
mailutil.h
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
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-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