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
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** 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$
**
****************************************************************************/
#include "qmessagefolder.h"
/*!
\class QMessageFolder
\brief The QMessageFolder class provides an interface for folders containing messages in the
messaging store.
\inmodule QtMessaging
\ingroup messaging
\since 1.0
QMessageFolder represents a folder of messages, either fully or partially stored in the
messaging store. A QMessageFolder object has an optional parent of the same type, allowing
folders to be arranged in tree structures. Messages may be associated with folders, allowing
for simple classification and access by their parentFolderId property.
\sa QMessage, QMessageStore::folder()
*/
/*!
\fn QMessageFolder::QMessageFolder()
Constructor that creates an empty and invalid QMessageFolder. An empty folder is one which
has no path, no parent folder and no parent account. An invalid folder does not exist in
the database and has an invalid id.
*/
/*!
\fn QMessageFolder::QMessageFolder(const QMessageFolderId &id)
Constructor that creates a QMessageFolder by loading the data from the messaging store as
specified by the QMessageFolderId \a id. If the folder does not exist in the messaging
store, then this constructor will create an empty and invalid QMessageFolder.
\since 1.0
*/
/*!
\fn QMessageFolder::QMessageFolder(const QMessageFolder &other)
Constructs a copy of \a other.
\since 1.0
*/
/*!
\internal
\fn QMessageFolder::operator=(const QMessageFolder& other)
\since 1.0
*/
/*!
\fn QMessageFolder::~QMessageFolder()
Destroys the QMessageFolder object.
*/
/*!
\fn QMessageFolder::id() const
Returns the identifier of the QMessageFolder object. A QMessageFolder with an invalid
identifier does not yet exist in the messaging store.
\since 1.0
*/
/*!
\fn QMessageFolder::parentAccountId() const
Returns the identifier of the parent account of the folder. If the folder is not linked to
an account an invalid identifier is returned.
\since 1.0
*/
/*!
\fn QMessageFolder::parentFolderId() const
Returns the identifier of the parent folder. This folder is a root folder if the parent
identifier is invalid.
\since 1.0
*/
/*!
\fn QMessageFolder::name() const
Returns the display name of the folder suitable for viewing in a user interface. This is
typically the same as, or a simplification of the path() for the folder.
\since 1.0
*/
/*!
\fn QMessageFolder::path() const
Returns the path of the folder.
\since 1.0
*/
|
