|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 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 \preliminary |
|
47 \brief The QMessageFolder class provides an interface for folders containing messages in the |
|
48 messaging store. |
|
49 |
|
50 \ingroup messaging |
|
51 |
|
52 QMessageFolder represents a folder of messages, either fully or partially stored in the |
|
53 messaging store. A QMessageFolder object has an optional parent of the same type, allowing |
|
54 folders to be arranged in tree structures. Messages may be associated with folders, allowing |
|
55 for simple classification and access by their parentFolderId property. |
|
56 |
|
57 \sa QMessage, QMessageStore::folder() |
|
58 */ |
|
59 |
|
60 /*! |
|
61 \fn QMessageFolder::QMessageFolder() |
|
62 |
|
63 Constructor that creates an empty and invalid QMessageFolder. An empty folder is one which |
|
64 has no path, no parent folder and no parent account. An invalid folder does not exist in |
|
65 the database and has an invalid id. |
|
66 */ |
|
67 |
|
68 /*! |
|
69 \fn QMessageFolder::QMessageFolder(const QMessageFolderId &id) |
|
70 |
|
71 Constructor that creates a QMessageFolder by loading the data from the messaging store as |
|
72 specified by the QMessageFolderId \a id. If the folder does not exist in the messaging |
|
73 store, then this constructor will create an empty and invalid QMessageFolder. |
|
74 */ |
|
75 |
|
76 /*! |
|
77 \fn QMessageFolder::QMessageFolder(const QMessageFolder &other) |
|
78 |
|
79 Constructs a copy of \a other. |
|
80 */ |
|
81 |
|
82 /*! |
|
83 \internal |
|
84 \fn QMessageFolder::operator=(const QMessageFolder& other) |
|
85 */ |
|
86 |
|
87 /*! |
|
88 \fn QMessageFolder::~QMessageFolder() |
|
89 |
|
90 Destroys the QMessageFolder object. |
|
91 */ |
|
92 |
|
93 /*! |
|
94 \fn QMessageFolder::id() const |
|
95 |
|
96 Returns the identifier of the QMessageFolder object. A QMessageFolder with an invalid |
|
97 identifier does not yet exist in the messaging store. |
|
98 */ |
|
99 |
|
100 /*! |
|
101 \fn QMessageFolder::parentAccountId() const |
|
102 |
|
103 Returns the identifier of the parent account of the folder. If the folder is not linked to |
|
104 an account an invalid identifier is returned. |
|
105 */ |
|
106 |
|
107 /*! |
|
108 \fn QMessageFolder::parentFolderId() const |
|
109 |
|
110 Returns the identifier of the parent folder. This folder is a root folder if the parent |
|
111 identifier is invalid. |
|
112 */ |
|
113 |
|
114 /*! |
|
115 \fn QMessageFolder::name() const |
|
116 |
|
117 Returns the display name of the folder suitable for viewing in a user interface. This is |
|
118 typically the same as, or a simplification of the path() for the folder. |
|
119 */ |
|
120 |
|
121 /*! |
|
122 \fn QMessageFolder::path() const |
|
123 |
|
124 Returns the path of the folder. |
|
125 */ |