← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/kdepim/oneiric-updates

« back to all changes in this revision

Viewing changes to libkleo/kleo/listallkeysjob.h

  • Committer: Package Import Robot
  • Author(s): Philip Muškovac
  • Date: 2011-06-28 19:33:24 UTC
  • mfrom: (0.2.13) (0.1.13 sid)
  • Revision ID: package-import@ubuntu.com-20110628193324-8yvjs8sdv9rdoo6c
Tags: 4:4.7.0-0ubuntu1
* New upstream release
  - update install files
  - add missing kdepim-doc package to control file
  - Fix Vcs lines
  - kontact breaks/replaces korganizer << 4:4.6.80
  - tighten the dependency of kdepim-dev on libkdepim4 to fix lintian error

Show diffs side-by-side

added added

removed removed

Lines of Context:
libkleo/kleo/listallkeysjob.h
 
1
/*
 
2
    listallkeysjob.h
 
3
 
 
4
    This file is part of libkleopatra, the KDE keymanagement library
 
5
    Copyright (c) 2004 Klarälvdalens Datakonsult AB
 
6
 
 
7
    Libkleopatra is free software; you can redistribute it and/or
 
8
    modify it under the terms of the GNU General Public License as
 
9
    published by the Free Software Foundation; either version 2 of the
 
10
    License, or (at your option) any later version.
 
11
 
 
12
    Libkleopatra is distributed in the hope that it will be useful,
 
13
    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
15
    General Public License for more details.
 
16
 
 
17
    You should have received a copy of the GNU General Public License
 
18
    along with this program; if not, write to the Free Software
 
19
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
20
 
 
21
    In addition, as a special exception, the copyright holders give
 
22
    permission to link the code of this program with any edition of
 
23
    the Qt library by Trolltech AS, Norway (or with modified versions
 
24
    of Qt that use the same license as Qt), and distribute linked
 
25
    combinations including the two.  You must obey the GNU General
 
26
    Public License in all respects for all of the code used other than
 
27
    Qt.  If you modify this file, you may extend this exception to
 
28
    your version of the file, but you are not obligated to do so.  If
 
29
    you do not wish to do so, delete this exception statement from
 
30
    your version.
 
31
*/
 
32
 
 
33
#ifndef __KLEO_LISTALLKEYSJOB_H__
 
34
#define __KLEO_LISTALLKEYSJOB_H__
 
35
 
 
36
#include "job.h"
 
37
 
 
38
#include <gpgme++/key.h>
 
39
 
 
40
#include <vector>
 
41
 
 
42
namespace GpgME {
 
43
  class Error;
 
44
  class KeyListResult;
 
45
}
 
46
 
 
47
class QStringList;
 
48
 
 
49
namespace Kleo {
 
50
 
 
51
  /**
 
52
     @short An abstract base class for asynchronously listing all keys
 
53
 
 
54
     To use a ListAllKeysJob, first obtain an instance from the
 
55
     CryptoBackend implementation, connect the progress()
 
56
     and result() signals to suitable slots and then start the key
 
57
     listing with a call to start(). This call might fail, in which
 
58
     case the ListAllKeysJob instance will have schedules it's own
 
59
     destruction with a call to QObject::deleteLater().
 
60
 
 
61
     After result() is emitted, the ListAllKeysJob will schedule it's
 
62
     own destruction by calling QObject::deleteLater().
 
63
 
 
64
     This is potentially much faster than a KeyListJob with empty
 
65
     pattern.
 
66
  */
 
67
  class ListAllKeysJob : public Job {
 
68
    Q_OBJECT
 
69
  protected:
 
70
    explicit ListAllKeysJob( QObject * parent );
 
71
 
 
72
  public:
 
73
    ~ListAllKeysJob();
 
74
 
 
75
     /**
 
76
       Starts the listallkeys operation.  In general, all keys are
 
77
       returned (however, the backend is free to truncate the result
 
78
       and should do so; when this happens, it will be reported by the
 
79
       result object).
 
80
 
 
81
       If \a mergeKeys is true, secret keys are merged into public
 
82
       keys.
 
83
    */
 
84
    virtual GpgME::Error start( bool mergeKeys=false ) = 0;
 
85
 
 
86
    /**
 
87
       Synchronous version of start().
 
88
    */
 
89
    virtual GpgME::KeyListResult exec( std::vector<GpgME::Key> & pub, std::vector<GpgME::Key> & sec, bool mergeKeys=false ) = 0;
 
90
 
 
91
  Q_SIGNALS:
 
92
    void result( const GpgME::KeyListResult & result, const std::vector<GpgME::Key> & pub=std::vector<GpgME::Key>(), const std::vector<GpgME::Key> & sec=std::vector<GpgME::Key>(), const QString & auditLogAsHtml=QString(), const GpgME::Error & auditLogError=GpgME::Error() );
 
93
  };
 
94
 
 
95
}
 
96
 
 
97
#endif // __KLEO_LISTALLKEYSJOB_H__