Changes: Rename functions on phoneutils.h to qctFunctionName
[qtcontacts-tracker:hasselmms-qtcontacts-tracker.git] / src / lib / phoneutils.h
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
42 #ifndef QCTSETTINGS_PHONEUTILS_H
43 #define QCTSETTINGS_PHONEUTILS_H
44
45 #include <QString>
46
47 #include "libqtcontacts_extensions_tracker_global.h"
48
49 /*!
50  * \brief Returns the normalized version of a phone number
51  *
52  * The normalization removes all the formatting elements of a phone number,
53  * that is spaces, braces, dot and hyphen.
54  */
55 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT QString qctNormalizePhoneNumber(const QString& value);
56
57 /*!
58  * \brief Returns the "lookup value" of a phone number
59  *
60  * This function returns the version of a phone number suitable to be stored
61  * in the maemo:localPhoneNumber property of a nco:PhoneNumber. It is basically
62  * the normalized version, additionally trimmed to the local phone number
63  * length.
64  *
65  * \sa QctSettings::localPhoneNumberLength
66  */
67 LIBQTCONTACTS_EXTENSIONS_TRACKER_EXPORT QString qctMakeLocalPhoneNumber(const QString& value);
68
69 #endif // QCTSETTINGS_PHONEUTILS_H