/usr/include/akonadi/attribute.h is in kdepimlibs5-dev 4:4.14.10-7+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | /*
Copyright (c) 2006 - 2008 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_ATTRIBUTE_H
#define AKONADI_ATTRIBUTE_H
#include "akonadi_export.h"
#include <QtCore/QList>
namespace Akonadi {
/**
* @short Provides interface for custom attributes for Entity.
*
* This class is an interface for custom attributes, that can be stored
* in an entity. Attributes should be meta data, e.g. ACLs, quotas etc.
* that are not part of the entities' data itself.
*
* Note that attributes are per user, i.e. when an attribute is added to
* an entity, it only applies to the current user.
*
* To provide custom attributes, you have to subclass from this interface
* and reimplement the pure virtual methods.
*
* @code
*
* class SecrecyAttribute : public Akonadi::Attribute
* {
* public:
* enum Secrecy
* {
* Public,
* Private,
* Confidential
* };
*
* SecrecyAttribute( Secrecy secrecy = Public )
* : mSecrecy( secrecy )
* {
* }
*
* void setSecrecy( Secrecy secrecy )
* {
* mSecrecy = secrecy;
* }
*
* Secrecy secrecy() const
* {
* return mSecrecy;
* }
*
* virtual QByteArray type() const
* {
* return "secrecy";
* }
*
* virtual Attribute* clone() const
* {
* return new SecrecyAttribute( mSecrecy );
* }
*
* virtual QByteArray serialized() const
* {
* switch ( mSecrecy ) {
* case Public: return "public"; break;
* case Private: return "private"; break;
* case Confidential: return "confidential"; break;
* }
* }
*
* virtual void deserialize( const QByteArray &data )
* {
* if ( data == "public" )
* mSecrecy = Public;
* else if ( data == "private" )
* mSecrecy = Private;
* else if ( data == "confidential" )
* mSecrecy = Confidential;
* }
* }
*
* @endcode
*
* Additionally, you need to register your attribute with Akonadi::AttributeFactory
* for automatic deserialization during retrieving of collecitons or items:
*
* @code
* AttributeFactory::registerAttribute<SecrecyAttribute>();
* @endcode
*
* Third party attributes need to be registered once by each application that uses
* them. So the above snippet needs to be in the resource that adds the attribute,
* and each application that uses the resource. This may be simplified in the future.
*
* The custom attributes can be used in the following way:
*
* @code
*
* Akonadi::Item item( "text/directory" );
* SecrecyAttribute* attr = item.attribute<SecrecyAttribute>( Item::AddIfMissing );
* attr->setSecrecy( SecrecyAttribute::Confidential );
*
* @endcode
*
* and
*
* @code
*
* Akonadi::Item item = ...
*
* if ( item.hasAttribute<SecrecyAttribute>() ) {
* SecrecyAttribute *attr = item.attribute<SecrecyAttribute>();
*
* SecrecyAttribute::Secrecy secrecy = attr->secrecy();
* ...
* }
* @endcode
*
* @author Volker Krause <vkrause@kde.org>
*/
class AKONADI_EXPORT Attribute
{
public:
/**
* Describes a list of attributes.
*/
typedef QList<Attribute *> List;
/**
* Returns the type of the attribute.
*/
virtual QByteArray type() const = 0;
/**
* Destroys this attribute.
*/
virtual ~Attribute();
/**
* Creates a copy of this attribute.
*/
virtual Attribute *clone() const = 0;
/**
* Returns a QByteArray representation of the attribute which will be
* storaged. This can be raw binary data, no encoding needs to be applied.
*/
virtual QByteArray serialized() const = 0;
/**
* Sets the data of this attribute, using the same encoding
* as returned by toByteArray().
*
* @param data The encoded attribute data.
*/
virtual void deserialize(const QByteArray &data) = 0;
};
}
#endif
|