summaryrefslogtreecommitdiff
path: root/src/controls/ComboBox.qml
blob: 47efb700e8f7a3bfab15496259f244034b6df1f8 (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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Quick Controls module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
**   * Redistributions of source code must retain the above copyright
**     notice, this list of conditions and the following disclaimer.
**   * Redistributions in binary form must reproduce the above copyright
**     notice, this list of conditions and the following disclaimer in
**     the documentation and/or other materials provided with the
**     distribution.
**   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
**     of its contributors may be used to endorse or promote products derived
**     from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/

import QtQuick 2.1
import QtQuick.Controls 1.0
import QtQuick.Controls.Private 1.0
import "Styles/Settings.js" as Settings

/*!
    \qmltype ComboBox
    \inqmlmodule QtQuick.Controls 1.0
    \ingroup controls
    \brief ComboBox is a combined button and popup or drop-down list.

    Add items to the comboBox by assigning it a ListModel, or a list of strings to the \l model property.

    \qml
       ComboBox {
           width: 200
           model: [ "Banana", "Apple", "Coconut" ]
       }
    \endqml

    Example 2:

    \qml
       ComboBox {
           model: ListModel {
               id: cbItems
               ListElement { text: "Banana"; color: "Yellow" }
               ListElement { text: "Apple"; color: "Green" }
               ListElement { text: "Coconut"; color: "Brown" }
           }
           width: 200
           onCurrentIndexChanged: console.debug(currentText + ", " + cbItems.get(currentIndex).color)
       }
    \endqml
*/

Control {
    id: comboBox

    /*! The model to populate the ComboBox from. */
    property alias model: popup.model
    property alias textRole: popup.textRole

    /*! The index of the currently selected item in the ComboBox. */
    property alias currentIndex: popup.__selectedIndex
    /*! The text of the currently selected item in the ComboBox. */
    readonly property alias currentText: popup.selectedText

    /* \internal */
    readonly property bool __pressed: mouseArea.pressed && mouseArea.containsMouse || popup.__popupVisible
    /* \internal */
    property alias __containsMouse: mouseArea.containsMouse

    style: Qt.createComponent(Settings.THEME_PATH + "/ComboBoxStyle.qml", comboBox)

    activeFocusOnTab: true

    Accessible.role: Accessible.ComboBox

    MouseArea {
        id: mouseArea
        anchors.fill: parent
        hoverEnabled: true
        onPressedChanged: if (pressed) popup.show()
    }

    StyleItem { id: styleItem }

    Component.onCompleted: {
        if (currentIndex === -1)
            currentIndex = 0
        if (styleItem.style == "mac") {
            popup.x -= 10
            popup.y += 4
            popup.__font.pointSize = 13
        }
    }

    Menu {
        id: popup

        style: isPopup ? __style.popupStyle : __style.dropDownStyle

        readonly property string selectedText: items[__selectedIndex] ? items[__selectedIndex].text : ""
        property string textRole: ""
        property var model
        property int modelSize: 0
        property bool ready: false
        property bool isPopup: comboBox.__panel.popup

        property int x: 0
        property int y: isPopup ? 0 : comboBox.height
        __minimumWidth: comboBox.width
        __visualItem: comboBox

        property ExclusiveGroup eg: ExclusiveGroup { id: eg }

        onModelChanged: rebuildMenu()
        onTextRoleChanged: rebuildMenu()

        Component.onCompleted: { ready = true; rebuildMenu() }

        function rebuildMenu() {
            if (!ready) return;
            clear()
            if (!model) {
                __selectedIndexChanged();
                return;
            }

            var isNumberModel = typeof(model) === "number"
            var modelMayHaveRoles = model.count !== undefined
            modelSize = isNumberModel ? model :
                        modelMayHaveRoles ? model.count : model.length
            var effectiveTextRole = textRole
            if (effectiveTextRole === ""
                && modelMayHaveRoles
                && model.get && model.get(0)) {
                // No text role set, check whether model has a suitable role
                // If 'text' is found, or there's only one role, pick that.
                var listElement = model.get(0)
                var roleName = ""
                var roleCount = 0
                for (var role in listElement) {
                    if (role === "text") {
                        roleName = role
                        break
                    } else if (!roleName) {
                        roleName = role
                    }
                    ++roleCount
                }
                if (roleCount > 1 && roleName !== "text") {
                    console.warn("No suitable 'textRole' found for ComboBox.")
                } else {
                    effectiveTextRole = roleName
                }
            }
            for (var i = 0; i < modelSize; ++i) {
                var textValue
                if (isNumberModel)
                    textValue = i + ""
                else if (effectiveTextRole !== "")
                    textValue = model.get(i)[effectiveTextRole]
                else
                    textValue = model[i]

                var item = addItem(textValue)
                item.checkable = true
                item.exclusiveGroup = eg
            }
            __selectedIndexChanged();
        }

        function show() {
            if (items[__selectedIndex])
                items[__selectedIndex].checked = true
            __currentIndex = comboBox.currentIndex
            __popup(x, y, isPopup ? __selectedIndex : 0)
        }
    }

    // The key bindings below will only be in use when popup is
    // not visible. Otherwise, native popup key handling will take place:
    Keys.onSpacePressed: {
        if (!popup.popupVisible)
            popup.show()
    }
    Keys.onUpPressed: { if (currentIndex > 0) currentIndex-- }
    Keys.onDownPressed: { if (currentIndex < popup.modelSize - 1) currentIndex++ }
}