Changes: Add Cubi::ResourceValue qctMakePhoneNumberResource(QString, QStringList)
[qtcontacts-tracker:hasselmms-qtcontacts-tracker.git] / src / lib / phoneutils.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 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
42 #ifndef QCTSETTINGS_PHONEUTILS_H
43 #define QCTSETTINGS_PHONEUTILS_H
44
45 #include <QContactPhoneNumber>
46
47 #include <cubi.h>
48
49 #include "libqtcontacts_extensions_tracker_global.h"
50
51 QTM_USE_NAMESPACE
52
53 /*!
54  * \brief Returns a regexp to match DTMF codes in a phone number
55  */
56 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT const QRegExp qctPhoneNumberDTMFChars();
57
58 /*!
59  * \brief Returns the normalized version of a phone number
60  *
61  * The normalization removes all the formatting elements of a phone number,
62  * that is spaces, braces, dot and hyphen.
63  */
64 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT QString qctNormalizePhoneNumber(const QString& value);
65
66 /*!
67  * \brief Returns the "lookup value" of a phone number
68  *
69  * This function returns the version of a phone number suitable to be stored
70  * in the maemo:localPhoneNumber property of a nco:PhoneNumber. It is basically
71  * the normalized version, additionally trimmed to the local phone number
72  * length.
73  *
74  * \sa QctSettings::localPhoneNumberLength
75  */
76 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT QString qctMakeLocalPhoneNumber(const QString& value);
77
78 /*!
79  * \brief Generates a normalized IRI from a phone number and its subtypes
80  *
81  * Returned IRI is of the form urn:x-maemo-phone:escapedNumber, or
82  * urn:x-maemo-phone:subtype1,subtype2:escapedNumber
83  */
84 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT QString qctMakePhoneNumberIri(const QString &number,
85                                                                       const QStringList &subtypes = QStringList(),
86                                                                       bool escape = true);
87
88 /*!
89  * \brief Generates a normalized IRI for a QContactPhoneNumber detail
90  *
91  * \sa qctMakePhoneNumberIri(const QString &number)
92  */
93 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT QString qctMakePhoneNumberIri(const QContactPhoneNumber &number,
94                                                                       bool escape = true);
95
96 /*!
97  * \brief Generates a Cubi::Resource with a normalized IRI for a QContactPhoneNumber detail
98  *
99  * \sa qctMakePhoneNumberIri(const QString &number)
100  */
101 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT Cubi::ResourceValue qctMakePhoneNumberResource(const QContactPhoneNumber &number);
102
103 /*!
104  * \brief Generates a Cubi::Resource with a normalized IRI from a phone number and its subtypes
105  *
106  * \sa qctMakePhoneNumberIri(const QString &number)
107  */
108 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT Cubi::ResourceValue qctMakePhoneNumberResource(const QString &number,
109                                                                                        const QStringList &subtypes = QStringList());
110
111 #endif // QCTSETTINGS_PHONEUTILS_H