|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 #include "qmessagefolder.h" |
|
42 |
|
43 /*! |
|
44 \class QMessageFolder |
|
45 |
|
46 \brief The QMessageFolder class provides an interface for folders containing messages in the |
|
47 messaging store. |
|
48 |
|
49 \ingroup messaging |
|
50 |
|
51 QMessageFolder represents a folder of messages, either fully or partially stored in the |
|
52 messaging store. A QMessageFolder object has an optional parent of the same type, allowing |
|
53 folders to be arranged in tree structures. Messages may be associated with folders, allowing |
|
54 for simple classification and access by their parentFolderId property. |
|
55 |
|
56 \sa QMessage, QMessageStore::folder() |
|
57 */ |
|
58 |
|
59 /*! |
|
60 \fn QMessageFolder::QMessageFolder() |
|
61 |
|
62 Constructor that creates an empty and invalid QMessageFolder. An empty folder is one which |
|
63 has no path, no parent folder and no parent account. An invalid folder does not exist in |
|
64 the database and has an invalid id. |
|
65 */ |
|
66 |
|
67 /*! |
|
68 \fn QMessageFolder::QMessageFolder(const QMessageFolderId &id) |
|
69 |
|
70 Constructor that creates a QMessageFolder by loading the data from the messaging store as |
|
71 specified by the QMessageFolderId \a id. If the folder does not exist in the messaging |
|
72 store, then this constructor will create an empty and invalid QMessageFolder. |
|
73 */ |
|
74 |
|
75 /*! |
|
76 \fn QMessageFolder::QMessageFolder(const QMessageFolder &other) |
|
77 |
|
78 Constructs a copy of \a other. |
|
79 */ |
|
80 |
|
81 /*! |
|
82 \internal |
|
83 \fn QMessageFolder::operator=(const QMessageFolder& other) |
|
84 */ |
|
85 |
|
86 /*! |
|
87 \fn QMessageFolder::~QMessageFolder() |
|
88 |
|
89 Destroys the QMessageFolder object. |
|
90 */ |
|
91 |
|
92 /*! |
|
93 \fn QMessageFolder::id() const |
|
94 |
|
95 Returns the identifier of the QMessageFolder object. A QMessageFolder with an invalid |
|
96 identifier does not yet exist in the messaging store. |
|
97 */ |
|
98 |
|
99 /*! |
|
100 \fn QMessageFolder::parentAccountId() const |
|
101 |
|
102 Returns the identifier of the parent account of the folder. If the folder is not linked to |
|
103 an account an invalid identifier is returned. |
|
104 */ |
|
105 |
|
106 /*! |
|
107 \fn QMessageFolder::parentFolderId() const |
|
108 |
|
109 Returns the identifier of the parent folder. This folder is a root folder if the parent |
|
110 identifier is invalid. |
|
111 */ |
|
112 |
|
113 /*! |
|
114 \fn QMessageFolder::name() const |
|
115 |
|
116 Returns the display name of the folder suitable for viewing in a user interface. This is |
|
117 typically the same as, or a simplification of the path() for the folder. |
|
118 */ |
|
119 |
|
120 /*! |
|
121 \fn QMessageFolder::path() const |
|
122 |
|
123 Returns the path of the folder. |
|
124 */ |