summaryrefslogtreecommitdiffstats
path: root/src/gallery/qgallerytype.qdoc
blob: 00b7a7d195a07ad6a1e98980594bf0694da1a44c (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
/****************************************************************************
**
** 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$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** 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.  Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \class QGalleryType

    \ingroup gallery

    \inmodule QtDocGallery

    \brief The QGalleryType class provides a string constant identifying a
    gallery item type.

    QAbstractGallery implementations use to QGalleryType to define the
    names of item types in their schemas.

    \sa QGalleryProperty
*/

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

    Returns the name of an item type.
*/

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

    Returns the string name of an item type.
*/

/*!
    \macro Q_DEFINE_GALLERY_TYPE(scope, name)

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

    \relates QGalleryType
*/