kde-playground/kdepimlibs/akonadi/collectionrightsattribute_p.h

85 lines
2.2 KiB
C
Raw Normal View History

/*
Copyright (c) 2007 Tobias Koenig <tokoe@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_COLLECTIONRIGHTSATTRIBUTE_P_H
#define AKONADI_COLLECTIONRIGHTSATTRIBUTE_P_H
#include "akonadi_export.h"
#include <akonadi/collection.h>
#include <akonadi/attribute.h>
namespace Akonadi {
/**
* @internal
*
* @short Attribute that stores the rights of a collection.
*
* Every collection can have rights set which describes whether
* the collection is readable or writable. That information is stored
* in this custom attribute.
*
* @note You shouldn't use this class directly but the convenience methods
* Collection::rights() and Collection::setRights() instead.
*
* @author Tobias Koenig <tokoe@kde.org>
*/
class AKONADI_EXPORT CollectionRightsAttribute : public Attribute
{
public:
/**
* Creates a new collection rights attribute.
*/
CollectionRightsAttribute();
/**
* Destroys the collection rights attribute.
*/
~CollectionRightsAttribute();
/**
* Sets the @p rights of the collection.
*/
void setRights(Collection::Rights rights);
/**
* Returns the rights of the collection.
*/
Collection::Rights rights() const;
virtual QByteArray type() const;
virtual CollectionRightsAttribute *clone() const;
virtual QByteArray serialized() const;
virtual void deserialize(const QByteArray &);
private:
//@cond PRIVATE
class Private;
Private *const d;
//@endcond
};
}
#endif