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

console/kabcclient

  • sources
  • kde-4.14
  • kdepim
  • console
  • kabcclient
  • src
outputformatimpls.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2005 - 2011 Kevin Krammer <kevin.krammer@gmx.at>
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 #ifndef OUTPUTFORMATIMPLS_H
20 #define OUTPUTFORMATIMPLS_H
21 
22 // local includes
23 #include "outputformat.h"
24 
25 // forward declarations
26 class CSVTemplate;
27 class CSVTemplateFactory;
28 class QTextCodec;
29 
30 namespace KABC
31 {
32  class VCardConverter;
33 }
34 
46 class UIDOutput : public OutputFormat
47 {
48 public:
49  virtual QString description() const;
50 
51  virtual bool setOptions(const QByteArray& options);
52 
53  virtual bool setCodec(QTextCodec* codec);
54 
55  virtual bool writeAddressee(const KABC::Addressee& addressee, std::ostream& stream);
56  virtual bool writeAddresseeList(const KABC::AddresseeList& addresseeList,
57  std::ostream& stream);
58 
59 private:
65  QTextCodec* m_codec;
66 };
67 
80 class VCardOutput : public OutputFormat
81 {
82 public:
83  VCardOutput();
84  virtual ~VCardOutput();
85 
86  virtual QString description() const;
87 
88  virtual bool setOptions(const QByteArray& options);
89  virtual QString optionUsage() const;
90 
91  virtual bool setCodec(QTextCodec* codec);
92 
93  virtual bool writeAddressee(const KABC::Addressee& addressee, std::ostream& stream);
94  virtual bool writeAddresseeList(const KABC::AddresseeList& addresseeList,
95  std::ostream& stream);
96 
97 private:
98  KABC::VCardConverter* m_converter;
99  int m_vCardVersion;
105  QTextCodec* m_codec;
106 };
107 
120 class EmailOutput : public OutputFormat
121 {
122 public:
123  EmailOutput();
124 
125  virtual QString description() const;
126 
127  virtual bool setOptions(const QByteArray& options);
128  virtual QString optionUsage() const;
129 
130  virtual bool setCodec(QTextCodec* codec);
131 
132  virtual bool writeAddressee(const KABC::Addressee& addressee, std::ostream& stream);
133  virtual bool writeAddresseeList(const KABC::AddresseeList& addresseeList,
134  std::ostream& stream);
135 
136 private:
141  bool m_allEmails;
142 
147  bool m_includeName;
153  QTextCodec* m_codec;
154 
155 private:
166  QString decorateEmail(const KABC::Addressee& addressee, const QString& email) const;
167 };
168 
182 class MuttOutput : public OutputFormat
183 {
184 public:
185  MuttOutput();
186 
187  virtual QString description() const;
188 
189  virtual bool setOptions(const QByteArray& options);
190  virtual QString optionUsage() const;
191 
192  virtual bool setCodec(QTextCodec* codec);
193 
194  virtual bool writeAddressee(const KABC::Addressee& addressee, std::ostream& stream);
195  virtual bool writeAddresseeList(const KABC::AddresseeList& addresseeList,
196  std::ostream& stream);
197 
198 private:
203  bool m_allEmails;
204 
217  bool m_queryFormat;
218 
235  bool m_altKeyFormat;
236 
237 
248  bool m_preferNickNameKey;
249 
258  bool m_alsoNickNameKey;
259 
265  QTextCodec* m_codec;
266 
267 private:
278  QString key(const KABC::Addressee& addressee) const;
279 
290  QString nickNameKey(const KABC::Addressee& addressee) const;
291 };
292 
309 class CSVOutput : public OutputFormat
310 {
311 public:
312  explicit CSVOutput(CSVTemplateFactory* templateFactory);
313  virtual ~CSVOutput();
314 
315  virtual QString description() const;
316 
317  virtual bool setOptions(const QByteArray& options);
318  virtual QString optionUsage() const;
319 
320  virtual bool setCodec(QTextCodec* codec);
321 
322  virtual bool writeAddressee(const KABC::Addressee& addressee, std::ostream& stream);
323  virtual bool writeAddresseeList(const KABC::AddresseeList& addresseeList,
324  std::ostream& stream);
325 
326 private:
332  QTextCodec* m_codec;
333 
338  CSVTemplate* m_template;
339 
343  CSVTemplateFactory* m_templateFactory;
344 };
345 
346 #endif
347 
348 // End of file
EmailOutput::setCodec
virtual bool setCodec(QTextCodec *codec)
Sets the text codec to use.
Definition: outputformatimpls.cpp:308
CSVOutput::CSVOutput
CSVOutput(CSVTemplateFactory *templateFactory)
Definition: outputformatimpls.cpp:683
CSVOutput::optionUsage
virtual QString optionUsage() const
Returns a translate message about the available format options.
Definition: outputformatimpls.cpp:715
QByteArray
UIDOutput::setCodec
virtual bool setCodec(QTextCodec *codec)
Sets the text codec to use.
Definition: outputformatimpls.cpp:68
UIDOutput::writeAddresseeList
virtual bool writeAddresseeList(const KABC::AddresseeList &addresseeList, std::ostream &stream)
Writes the data from each addressee in the given list to the given output stream. ...
Definition: outputformatimpls.cpp:90
EmailOutput::description
virtual QString description() const
Returns a translate description of the output format.
Definition: outputformatimpls.cpp:261
MuttOutput::setCodec
virtual bool setCodec(QTextCodec *codec)
Sets the text codec to use.
Definition: outputformatimpls.cpp:493
EmailOutput::optionUsage
virtual QString optionUsage() const
Returns a translate message about the available format options.
Definition: outputformatimpls.cpp:289
CSVOutput::description
virtual QString description() const
Returns a translate description of the output format.
Definition: outputformatimpls.cpp:696
EmailOutput
Output formatter for email addresses.
Definition: outputformatimpls.h:120
OutputFormat
Interface for output formatters.
Definition: outputformat.h:53
CSVOutput::writeAddressee
virtual bool writeAddressee(const KABC::Addressee &addressee, std::ostream &stream)
Writes the data of a given addressee to the given output stream.
Definition: outputformatimpls.cpp:756
UIDOutput::writeAddressee
virtual bool writeAddressee(const KABC::Addressee &addressee, std::ostream &stream)
Writes the data of a given addressee to the given output stream.
Definition: outputformatimpls.cpp:79
VCardOutput::writeAddressee
virtual bool writeAddressee(const KABC::Addressee &addressee, std::ostream &stream)
Writes the data of a given addressee to the given output stream.
Definition: outputformatimpls.cpp:181
EmailOutput::setOptions
virtual bool setOptions(const QByteArray &options)
Configures the output format.
Definition: outputformatimpls.cpp:268
MuttOutput
Output formatter for use as input of the email client "mutt".
Definition: outputformatimpls.h:182
EmailOutput::writeAddresseeList
virtual bool writeAddresseeList(const KABC::AddresseeList &addresseeList, std::ostream &stream)
Writes the data from each addressee in the given list to the given output stream. ...
Definition: outputformatimpls.cpp:362
VCardOutput::setOptions
virtual bool setOptions(const QByteArray &options)
Configures the output format.
Definition: outputformatimpls.cpp:131
UIDOutput::setOptions
virtual bool setOptions(const QByteArray &options)
Configures the output format.
Definition: outputformatimpls.cpp:60
CSVOutput
Output formatter for CSV (comma separated values)
Definition: outputformatimpls.h:309
UIDOutput
Output formatter for KABC UIDs.
Definition: outputformatimpls.h:46
MuttOutput::description
virtual QString description() const
Returns a translate description of the output format.
Definition: outputformatimpls.cpp:402
MuttOutput::MuttOutput
MuttOutput()
Definition: outputformatimpls.cpp:394
VCardOutput::writeAddresseeList
virtual bool writeAddresseeList(const KABC::AddresseeList &addresseeList, std::ostream &stream)
Writes the data from each addressee in the given list to the given output stream. ...
Definition: outputformatimpls.cpp:217
CSVOutput::setCodec
virtual bool setCodec(QTextCodec *codec)
Sets the text codec to use.
Definition: outputformatimpls.cpp:745
CSVTemplate
Class for handling KAddressBook's CSV templates.
Definition: csvtemplate.h:88
MuttOutput::setOptions
virtual bool setOptions(const QByteArray &options)
Configures the output format.
Definition: outputformatimpls.cpp:409
VCardOutput
Output formatter for VCard data.
Definition: outputformatimpls.h:80
MuttOutput::optionUsage
virtual QString optionUsage() const
Returns a translate message about the available format options.
Definition: outputformatimpls.cpp:444
outputformat.h
QString
QTextCodec
EmailOutput::EmailOutput
EmailOutput()
Definition: outputformatimpls.cpp:255
MuttOutput::writeAddresseeList
virtual bool writeAddresseeList(const KABC::AddresseeList &addresseeList, std::ostream &stream)
Writes the data from each addressee in the given list to the given output stream. ...
Definition: outputformatimpls.cpp:630
VCardOutput::VCardOutput
VCardOutput()
Definition: outputformatimpls.cpp:110
VCardOutput::description
virtual QString description() const
Returns a translate description of the output format.
Definition: outputformatimpls.cpp:124
VCardOutput::optionUsage
virtual QString optionUsage() const
Returns a translate message about the available format options.
Definition: outputformatimpls.cpp:143
CSVOutput::setOptions
virtual bool setOptions(const QByteArray &options)
Configures the output format.
Definition: outputformatimpls.cpp:703
MuttOutput::writeAddressee
virtual bool writeAddressee(const KABC::Addressee &addressee, std::ostream &stream)
Writes the data of a given addressee to the given output stream.
Definition: outputformatimpls.cpp:504
UIDOutput::description
virtual QString description() const
Returns a translate description of the output format.
Definition: outputformatimpls.cpp:53
VCardOutput::setCodec
virtual bool setCodec(QTextCodec *codec)
Sets the text codec to use.
Definition: outputformatimpls.cpp:159
CSVOutput::writeAddresseeList
virtual bool writeAddresseeList(const KABC::AddresseeList &addresseeList, std::ostream &stream)
Writes the data from each addressee in the given list to the given output stream. ...
Definition: outputformatimpls.cpp:778
CSVOutput::~CSVOutput
virtual ~CSVOutput()
Definition: outputformatimpls.cpp:690
CSVTemplateFactory
Factory for creation CSV template handlers.
Definition: csvtemplatefactory.h:44
VCardOutput::~VCardOutput
virtual ~VCardOutput()
Definition: outputformatimpls.cpp:117
EmailOutput::writeAddressee
virtual bool writeAddressee(const KABC::Addressee &addressee, std::ostream &stream)
Writes the data of a given addressee to the given output stream.
Definition: outputformatimpls.cpp:319
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:31:23 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

console/kabcclient

Skip menu "console/kabcclient"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • 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