/usr/include/akonadi/attributeentity.h is in kdepimlibs5-dev 4:4.13.0-0ubuntu1.
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 | /*
Copyright (c) 2014 Christian Mollekopf <mollekopf@kolabsys.com>
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_ATTRIBUTEENTITY_H
#define AKONADI_ATTRIBUTEENTITY_H
#include <akonadi/job.h>
#include <QVector>
#include <qsharedpointer.h>
#include "attribute.h"
#include <kdebug.h>
namespace Akonadi {
/**
* Parent class for entities that can have attributes.
* This is supposed to eventually share the code between Akonadi::Tag and Akonadi::Entity.
*
* In the current form using this in Akonadi::Entity would break the implicit sharing of it's private class,
* so AttributeEntity::Private would need to become a parent class of EntityPrivate and use the same clone()
* calls etc.
* An even better solution is probably ot make AttributeEntity a private member of Entity, with all Attribute related member functions forwarding to this class.
*/
class AKONADI_EXPORT AttributeEntity {
public:
AttributeEntity();
AttributeEntity(const AttributeEntity &);
virtual ~AttributeEntity();
//Each subclass must override this to avoid slicing
virtual AttributeEntity &operator=(const AttributeEntity &);
/**
* Adds an attribute to the entity.
*
* If an attribute of the same type name already exists, it is deleted and
* replaced with the new one.
*
* @param attribute The new attribute.
*
* @note The entity takes the ownership of the attribute.
*/
void addAttribute( Attribute *attribute );
/**
* Removes and deletes the attribute of the given type @p name.
*/
void removeAttribute( const QByteArray &name );
/**
* Returns @c true if the entity has an attribute of the given type @p name,
* false otherwise.
*/
bool hasAttribute( const QByteArray &name ) const;
/**
* Returns a list of all attributes of the entity.
*/
Attribute::List attributes() const;
/**
* Removes and deletes all attributes of the entity.
*/
void clearAttributes();
/**
* Returns the attribute of the given type @p name if available, 0 otherwise.
*/
Attribute* attribute( const QByteArray &name ) const;
/**
* Describes the options that can be passed to access attributes.
*/
enum CreateOption {
AddIfMissing ///< Creates the attribute if it is missing
};
/**
* Returns the attribute of the requested type.
* If the entity has no attribute of that type yet, a new one
* is created and added to the entity.
*
* @param option The create options.
*/
template <typename T> inline T* attribute( CreateOption option )
{
Q_UNUSED( option );
const T dummy;
if ( hasAttribute( dummy.type() ) ) {
T* attr = dynamic_cast<T*>( attribute( dummy.type() ) );
if ( attr ) {
return attr;
}
kWarning( 5250 ) << "Found attribute of unknown type" << dummy.type()
<< ". Did you forget to call AttributeFactory::registerAttribute()?";
}
T* attr = new T();
addAttribute( attr );
return attr;
}
/**
* Returns the attribute of the requested type or 0 if it is not available.
*/
template <typename T> inline T* attribute() const
{
const T dummy;
if ( hasAttribute( dummy.type() ) ) {
T* attr = dynamic_cast<T*>( attribute( dummy.type() ) );
if ( attr )
return attr;
kWarning( 5250 ) << "Found attribute of unknown type" << dummy.type()
<< ". Did you forget to call AttributeFactory::registerAttribute()?";
}
return 0;
}
/**
* Removes and deletes the attribute of the requested type.
*/
template <typename T> inline void removeAttribute()
{
const T dummy;
removeAttribute( dummy.type() );
}
/**
* Returns whether the entity has an attribute of the requested type.
*/
template <typename T> inline bool hasAttribute() const
{
const T dummy;
return hasAttribute( dummy.type() );
}
private:
friend class TagModifyJob;
QSet<QByteArray> &removedAttributes() const;
class Private;
QSharedPointer<Private> d_ptr;
};
}
#endif
|