|
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 "qmessagefolderid.h" |
|
42 |
|
43 QTM_BEGIN_NAMESPACE |
|
44 |
|
45 /*! |
|
46 \class QMessageFolderId |
|
47 \ingroup messaging |
|
48 |
|
49 \brief The QMessageFolderId class provides a unique identifier for a QMessageFolder message |
|
50 folder, within the scope of the messaging store. |
|
51 |
|
52 A QMessageFolderId can be constructed from a string, or converted to a string with toString(). |
|
53 |
|
54 A QMessageFolderId instance can be tested for validity with isValid(), and compared to other |
|
55 instances for equality. |
|
56 |
|
57 If the message a QMessageFolderId identifies is removed from the messaging store then the |
|
58 identifier will not be reused. |
|
59 |
|
60 \sa QMessageFolder |
|
61 */ |
|
62 |
|
63 /*! |
|
64 \fn QMessageFolderId::QMessageFolderId() |
|
65 |
|
66 Creates an invalid identifier, toString() will return a null string. |
|
67 */ |
|
68 |
|
69 /*! |
|
70 \fn QMessageFolderId::QMessageFolderId(const QMessageFolderId& other) |
|
71 |
|
72 Constructs a copy of \a other. |
|
73 */ |
|
74 |
|
75 /*! |
|
76 \fn QMessageFolderId::QMessageFolderId(const QString& id) |
|
77 |
|
78 Constructs an identifier from \a id. |
|
79 |
|
80 \sa toString() |
|
81 */ |
|
82 |
|
83 /*! |
|
84 \fn QMessageFolderId::~QMessageFolderId() |
|
85 |
|
86 Destroys the identifier. |
|
87 */ |
|
88 |
|
89 /*! |
|
90 \internal |
|
91 \fn QMessageFolderId& QMessageFolderId::operator=(const QMessageFolderId &other) |
|
92 */ |
|
93 |
|
94 /*! |
|
95 \internal |
|
96 \fn bool QMessageFolderId::operator==(const QMessageFolderId &other) const |
|
97 */ |
|
98 |
|
99 /*! \internal */ |
|
100 bool QMessageFolderId::operator!=(const QMessageFolderId &other) const |
|
101 { |
|
102 return !operator==(other); |
|
103 } |
|
104 |
|
105 /*! |
|
106 \fn bool QMessageFolderId::operator<(const QMessageFolderId &other) const |
|
107 |
|
108 Returns true if this identifier is ordered before \a other using an implementation-defined ordering. |
|
109 */ |
|
110 |
|
111 /*! |
|
112 \fn bool QMessageFolderId::toString() const |
|
113 |
|
114 Returns the string representation of this identifier. |
|
115 |
|
116 A null string should be returned if and only if the identifier is invalid. |
|
117 |
|
118 String representations of identifiers should not be used to test for equality, instead |
|
119 the equality operator should be used. |
|
120 */ |
|
121 |
|
122 /*! |
|
123 \fn bool QMessageFolderId::isValid() const |
|
124 |
|
125 Returns true if this identifier is valid; otherwise returns false. |
|
126 */ |
|
127 |
|
128 /*! \typedef QMessageFolderIdList |
|
129 |
|
130 Qt-style synonym for QList<QMessageFolderId> |
|
131 */ |
|
132 |
|
133 QTM_END_NAMESPACE |