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
|
/******************************************************************************
*
* Copyright (c) 2009 Szymon Stefanek <s.stefanek at gmail dot 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_ENTITYHIDDENATTRIBUTE_H
#define AKONADI_ENTITYHIDDENATTRIBUTE_H
#include <akonadi/attribute.h>
namespace Akonadi {
/**
* @short An Attribute that marks that an entity should be hidden in the UI.
*
* This class represents the attribute of all hidden items. The hidden
* items shouldn't be displayed in UI applications (unless in some kind
* of "debug" mode).
*
* Example:
*
* @code
*
* using namespace Akonadi;
*
* ...
* // hide a collection by setting the hidden attribute
* Collection collection = collectionFetchJob->collections().first();
* collection.attribute<EntityHiddenAttribute>( Entity::AddIfMissing );
* new CollectionModifyJob( collection, this ); // save back to storage
*
* // check if the collection is hidden
* if ( collection.hasAttribute<EntityHiddenAttribute>() )
* qDebug() << "collection is hidden";
* else
* qDebug() << "collection is visible";
*
* @endcode
*
* @author Szymon Stefanek <s.stefanek@gmail.com>
* @see Akonadi::Attribute
* @since 4.4
*/
class AKONADI_EXPORT EntityHiddenAttribute : public Attribute
{
public:
/**
* Creates a new entity hidden attribute.
*/
EntityHiddenAttribute();
/**
* Destroys the entity hidden attribute.
*/
~EntityHiddenAttribute();
/**
* Reimplemented from Attribute
*/
QByteArray type() const;
/**
* Reimplemented from Attribute
*/
EntityHiddenAttribute* clone() const;
/**
* Reimplemented from Attribute
*/
QByteArray serialized() const;
/**
* Reimplemented from Attribute
*/
void deserialize( const QByteArray &data );
private:
//@cond PRIVATE
class Private;
Private* const d;
//@endcond
};
}
#endif
|