summaryrefslogtreecommitdiffstats
path: root/qtcollator.h
blob: 46739aceafbd59f21bc67d0cd1bd923ad9b478c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/** This file is part of QtCollator **

Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).*

Contact:  Nokia Corporation (info@qt.nokia.com)**

GNU Lesser General Public License Usage
This file may be used under the terms of the GNU Lesser General Public License
version 2.1 as published by the Free Software Foundation and appearing in the
file LICENSE.LGPL included in the packaging of this file. Please review the
following information to ensure the GNU Lesser General Public License version
2.1 requirements will be met:
http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

In addition, as a special exception, Nokia gives you certain additional rights.
These rights are described in the Nokia Qt LGPL Exception version 1.1, included
in the file LGPL_EXCEPTION.txt in this package.

GNU General Public License Usage
Alternatively, this file may be used under the terms of the GNU General Public
License version 3.0 as published by the Free Software Foundation and appearing
in the file LICENSE.GPL included in the packaging of this file. Please review
the following information to ensure the GNU General Public License version 3.0
requirements will be met: http://www.gnu.org/copyleft/gpl.html.

Other Usage
Alternatively, this file may be used in accordance with the terms and
conditions contained in a signed written agreement between you and Nokia.

*/

#ifndef QTCOLLATOR_H
#define QTCOLLATOR_H

#include "qstring.h"
#include "qlocale.h"

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

class QtCollatorPrivate;
class QtCollator
{
public:
    enum Strength {
        PrimaryStrength = 1,
        BaseLetterStrength = PrimaryStrength,

        SecondaryStrength = 2,
        AccentsStrength = SecondaryStrength,

        TertiaryStrength = 3,
        CaseStrength = TertiaryStrength,

        QuaternaryStrength = 4,
        PunctuationStrength = QuaternaryStrength,

        IdenticalStrength = 5,
        CodepointStrength = IdenticalStrength
    };

    enum Option {
        PreferUpperCase        = 0x01,
        PreferLowerCase        = 0x02,
        FrenchCollation        = 0x04,
        DisableNormalization   = 0x08,
        IgnorePunctuation      = 0x10,
        ExtraCaseLevel         = 0x20,
        HiraganaQuaternaryMode = 0x40,
        NumericMode            = 0x80
    };
    Q_DECLARE_FLAGS(Options, Option)

    QtCollator(const QLocale &locale = QLocale());
    QtCollator(const QtCollator &);
    ~QtCollator();
    QtCollator &operator=(const QtCollator &);

    void setLocale(const QLocale &locale);
    QLocale locale() const;

    void setStrength(Strength);
    Strength strength() const;

    void setOptions(Options);
    Options options() const;

    enum CasePreference {
        IgnoreCase = 0x0,
        UpperCase  = 0x1,
        LowerCase  = 0x2
    };

    bool isCaseSensitive() const
    { return options() & (PreferUpperCase | PreferLowerCase); }
    CasePreference casePreference() const
    {
        int value = options() & 0x3;
        if (value == 3)
            return UpperCase;
        return CasePreference(value);
    }
    void setCasePreference(CasePreference c)
    {
        Options o = options() & ~(PreferUpperCase | PreferLowerCase);
        if (c == UpperCase)
            o |= PreferUpperCase;
        else if (c == LowerCase)
            o |= PreferLowerCase;
        setOptions(o);
    }

    void setNumericMode(bool on)
    { setOptions(on ? options() | NumericMode : options() & ~NumericMode); }
    bool numericMode() const
    { return options() & NumericMode; }

    int compare(const QString &s1, const QString &s2) const;
    int compare(const QStringRef &s1, const QStringRef &s2) const;
    bool operator()(const QString &s1, const QString &s2) const
    { return compare(s1, s2) < 0; }

    QByteArray sortKey(const QString &string) const;

private:
    QtCollatorPrivate *d;

    void detach();
};

QT_END_NAMESPACE

QT_END_HEADER

#endif // QTCOLLATOR_H