summaryrefslogtreecommitdiffstats
path: root/src/gallery/qgalleryproperty.qdoc
blob: 6bf6cad9ae26f90f1d289546f0ef430800ed64e0 (plain)
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
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \class QGalleryProperty

    \inmodule QtGallery

    \brief The QGalleryProperty class provides a string constant identifying a
    gallery property.

    QAbstractGallery implementations use to QGalleryProperty to define the
    names of properties in their schemas.  In addition to providing the name of
    a property QGalleryProperty also contains a number of operator overloads and
    functions for constructing meta-data filters.

    \sa QGalleryType, QGalleryMetaDataFilter
*/

/*!
    \enum QGalleryProperty::Attribute

    This enumeration describes the attributes of a property.

    \value CanRead The value of this property can be read.
    \value CanWrite The value of this property can be written.
    \value CanSort The value of this property can be used to sort items.
    \value CanFilter The value of this property can be used in a filter.
*/

/*!
    \fn QGalleryProperty::name() const

    Returns the name of a property.
*/

/*!
    \fn QGalleryProperty::operator QString() const

    Returns the name of a property.
*/

/*!
    \fn QGalleryProperty::operator <(const QVariant &value) const

    Returns a gallery filter which tests if  a property is less than a
    \a value.
*/

/*!
    \fn QGalleryProperty::operator <=(const QVariant &value) const

    Returns a gallery filter which tests if a property is less than or equal to
    a \a value.
*/

/*!
    \fn QGalleryProperty::operator ==(const QVariant &value) const
    Returns a gallery filter which tests if a property is equal to a \a value.
*/

/*!
    \fn QGalleryProperty::operator >=(const QVariant &value) const

    Returns a gallery filter which tests if a property is greater than or equal
    to a \a value.
*/

/*!
    \fn QGalleryProperty::operator >(const QVariant &value) const

    Returns a gallery filter which tests if a property is greater than a
    \a value.
*/

/*!
    \fn QGalleryProperty::contains(const QString &string) const

    Returns a gallery filter which tests if a property value contains contains
    a \a string literal.
*/

/*!
    \fn QGalleryProperty::startsWith(const QString &string) const

    Returns a gallery filter which tests if a property value starts with a
    \a string literal.
*/

/*!
    \fn QGalleryProperty::endsWith(const QString &string) const

    Returns a gallery filter which tests if a property value ends with a
    \a string literal.
*/

/*!
    \fn QGalleryProperty::wildcard(const QString &string) const

    Returns a gallery filter which tests if a property value matches a
    \a string literal using wildcard matching.
*/

/*!
    \fn QGalleryProperty::regExp(const QString &regExp) const

    Returns a gallery filter which tests if a property value matches a
    \a regExp.
*/

/*!
    \fn QGalleryProperty::regExp(const QRegExp &regExp) const

    Returns a gallery filter which tests if a property value matches a
    \a regExp.
*/

/*!
    \fn QGalleryProperty::ascending() const

    Returns a sort key which indicating items should be sorted a property in
    ascending order.
*/

/*!
    \fn QString QGalleryProperty::descending() const

    Returns a sort key which indicating items should be sorted a property in
    descending order.
*/


/*!
    \macro Q_DEFINE_GALLERY_PROPERTY(scope, name)

    Macro for defining the \a name of a gallery property within the \a scope of
    a class or namespace.

    \relates QGalleryProperty
*/