summaryrefslogtreecommitdiffstats
path: root/src/localesettings/localefiltermodel.cpp
blob: e3eecd45aad981d1fb0e4720f887797a3036c720 (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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Device Utilities module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "localemodel.h"
#include "localefiltermodel.h"

QT_BEGIN_NAMESPACE

/*!
    \module QtLocaleSettings
    \qtvariable localesettings
    \ingroup qtdevice-utilities-cpp-modules
    \ingroup modules
    \title Qt Locale Settings C++ Classes
    \brief Provides functionality for controlling locale settings.

    To use classes from this module, add this directive into the C++ files:

    \code
    #include <QtLocaleSettings>
    \endcode

    To link against the corresponding C++ libraries, add the following to your
    qmake project file:

    \code
    QT += localesettings
    \endcode
*/

/*!
    \class LocaleFilterModel
    \inmodule QtLocaleSettings

    \brief The LocaleFilterModel class provides a filtered model for the
    available locales.

    This class can be used as the model in a view that lists the available
    locales.

    \sa LocaleModel
*/

/*!
    \property LocaleFilterModel::filter
    \brief Holds a string that filters out the locales in the model.

    The filtering process is a case-insensitive matching for whether the region
    (country) name contains this string. The string can be taken from user
    input.

    \sa LocaleItem::country
*/

/*!
    Creates a locale filer model with the parent \a parent.
*/
LocaleFilterModel::LocaleFilterModel(QObject* parent)
    :QSortFilterProxyModel(parent)
{
    connect(this, &LocaleFilterModel::filterChanged, this, &LocaleFilterModel::invalidate);
    LocaleModel *localeModel = new LocaleModel(this);
    setSourceModel(localeModel);
}

/*!
    Deletes the locale filter model.
*/
LocaleFilterModel::~LocaleFilterModel()
{

}

/*!
    Returns the locale filter string.
*/
QString LocaleFilterModel::filter() const
{
    return m_filter;
}

/*!
    Sets the locale filter string to \a aFilter.
*/
void LocaleFilterModel::setFilter(const QString& aFilter)
{
    m_filter = aFilter;
    emit filterChanged();
}

/*!
    Returns whether the row \a source_row has the country role and whether it is
    found in the locale model \a source_parent.
*/
bool LocaleFilterModel::filterAcceptsRow( int source_row, const QModelIndex& source_parent ) const
{
    bool ret = false;
    if (this->sourceModel())
    {
       QModelIndex index = this->sourceModel()->index( source_row, 0, source_parent );
       if (index.isValid())
       {
           QVariant nameRole = index.data(LocaleModel::Country);
           if (nameRole.isValid())
           {
               QString name = nameRole.toString();
               if (name.contains(m_filter,  Qt::CaseInsensitive)) {
                   ret = true;
               }
           }
       }
    }
    return ret;
}

/*!
    Returns the locale item at \a row in the locale filter model.

    This item can be assigned to LocaleManager::locale(), when the user selects
    a locale from a list.

    \sa LocaleItem
*/
QVariant LocaleFilterModel::itemFromRow(const int row) const
{
    QModelIndex idx = index(row, 0);
    QModelIndex mapped = mapToSource(idx);
    if (mapped.isValid())
    {
        QVariant nameRole = mapped.data(LocaleModel::Code);
        if (nameRole.isValid())
        {
            return nameRole;
        }
    }
    return QVariant();
}

/*!
    Returns the index for the country \a country in the locale filter model.

    The index is used by item views, delegates, and selection models to locate
    an item in the model.
*/
int LocaleFilterModel::indexForCountry(const QString &country) const
{
    QAbstractItemModel *model = this->sourceModel();
    LocaleModel *localModel = qobject_cast<LocaleModel*>(model);
    QModelIndex i = localModel->indexForCountry(country);
    QModelIndex ret = mapFromSource(i);
    return ret.row();
}

QT_END_NAMESPACE