← Back to branch summary

~ubuntu-branches/ubuntu/trusty/kdepimlibs/trusty

« back to all changes in this revision

Viewing changes to akonadi/gid/gidextractor_p.h

  • Committer: Package Import Robot
  • Author(s): Rohan Garg, Rohan Garg, Philip Muškovac
  • Date: 2013-11-23 17:36:44 UTC
  • mfrom: (1.1.102)
  • Revision ID: package-import@ubuntu.com-20131123173644-p5ow94192ezsny8g
Tags: 4:4.11.80-0ubuntu1
[ Rohan Garg ]
* New upstream beta release
  - Bump akonadi requirement to 1.10.45
  - Update install files
  - Update symbols

[ Philip Muškovac ]
* kdepimlibs-dev/-dbg breaks/replaces kdepim-runtime/-dbg (<< 4:4.11.80)

Show diffs side-by-side

added added

removed removed

Lines of Context:
akonadi/gid/gidextractor_p.h
 
1
/*
 
2
    Author: (2013) Christian Mollekopf <mollekopf@kolabsys.com>
 
3
 
 
4
    This library is free software; you can redistribute it and/or modify it
 
5
    under the terms of the GNU Library General Public License as published by
 
6
    the Free Software Foundation; either version 2 of the License, or (at your
 
7
    option) any later version.
 
8
 
 
9
    This library is distributed in the hope that it will be useful, but WITHOUT
 
10
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 
11
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
 
12
    License for more details.
 
13
 
 
14
    You should have received a copy of the GNU Library General Public License
 
15
    along with this library; see the file COPYING.LIB.  If not, write to the
 
16
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 
17
    02110-1301, USA.
 
18
*/
 
19
 
 
20
#ifndef GIDEXTRACTOR_H
 
21
#define GIDEXTRACTOR_H
 
22
 
 
23
#include <QtCore/QString>
 
24
 
 
25
namespace Akonadi {
 
26
 
 
27
class Item;
 
28
 
 
29
/**
 
30
 * @internal
 
31
 * Extracts the GID of an object contained in an akonadi item using a plugin that implements the GidExtractorInterface.
 
32
 */
 
33
class GidExtractor
 
34
{
 
35
  public:
 
36
    /**
 
37
     * Extracts the GID from @p item. using an extractor plugin.
 
38
     */
 
39
    static QString extractGid( const Item &item );
 
40
 
 
41
    /**
 
42
     * Extracts the gid from @p item.
 
43
     *
 
44
     * If the item has a GID set, that GID will be returned.
 
45
     * If the item has no GID set, and the item has a payload, the GID is extracted using extractGid().
 
46
     * If the item has no GID set and no payload, a default constructed QString is returned.
 
47
     */
 
48
    static QString getGid( const Item &item );
 
49
};
 
50
 
 
51
}
 
52
 
 
53
#endif