/usr/lib/x86_64-linux-gnu/qt5/qml/Ubuntu/Components/1.3/ComboButton.qml is in qml-module-ubuntu-components-gles 1.3.1918+16.04.20160404-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 | /*
* Copyright 2015 Canonical Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import QtQuick 2.4
import Ubuntu.Components 1.3
import Ubuntu.Components.Popups 1.3
/*!
\qmltype ComboButton
\inqmlmodule Ubuntu.Components 1.1
\ingroup ubuntu
\brief Ubuntu button providing a drop-down panel visualizing custom options.
The component is composed of three main blocks: \b {main button}, \b {dropdown}
and \b {combo list}.
The \a {main button} holds the main functionailty of the component, and it is
located at the left-top side of the expanded button. The \a clicked() signal
is triggered only when this button is pressed.
The \a {dropdown} is a button located on the right of the main button. Its
functionality is to drive the component's expanded state.
The \a {combo list} is a panel showing the content specified in \l comboList
property when expanded. The content is stretched horizontally to the component's
width, and its height is controlled by the \l expandedHeight property as follows:
\list
\li If the content height is smaller than the value of \l expandedHeight, the combo
list will be expanded only to the height of the content.
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
ComboButton {
text: "smaller content"
Rectangle {
height: units.gu(5) // smaller than the default expandedHeight
color: "blue"
}
}
\endqml
\li If the content height is greater than \l expandedHeight, the combo list will
expand till the height specified by the property and the content will be
scrolled; in case the combo list content is one single Flickable, ListView,
GridView or PathView, the content scrolling will be provided by the content
itself.
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
ComboButton {
text: "long scrolled content"
Column {
Repeater {
model: 5
spacing: units.gu(1)
Rectangle {
height: units.gu(5)
color: "blue"
}
}
}
}
\endqml
\li In case the content is a single Flickable, ListView, GridView or PathView,
the content will be filling the entire combo list area defined.
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
import Ubuntu.Components.ListItems 1.3
ComboButton {
text: "listview"
ListView {
model: 10
delegate: Standard {
text: "Item #" + modelData
}
}
}
\endqml
\li Vertical anchoring of combo list content to its parent is not possible
as the expansion calculation is done based on the combo list content height.
If the content wants to take the size of the entire combo list, it should
bind its height to the \l comboListHeight property.
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
ComboButton {
id: combo
text: "smaller content"
Rectangle {
height: combo.comboListHeight
color: "blue"
}
}
\endqml
\li In case the expansion needs to be the size of the combo list content, the \l
expandedHeight should be set to -1.
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
ComboButton {
text: "auto-sized content"
expandedHeight: -1
Column {
Repeater {
model: 5
spacing: units.gu(1)
Button {
text: "Button #" + modelData
}
}
}
}
\endqml
\endlist
The combo list can be expanded/collapsed either through the \l expanded property
or by clicking on the dropdown button. It is not collapsed when pressing the main
button or clicking on the combo list. In order to do an auto-collapsing button
you must reset the expanded property (set it to false) when the main button is
clicked or when a selection is taken from the combo list content. The following
example illustrates a possible implementation.
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
ComboButton {
id: combo
text: "Auto closing"
expanded: true
expandedHeight: units.gu(30)
onClicked: expanded = false
UbuntuListView {
width: parent.width
height: combo.comboListHeight
model: 20
delegate: Standard {
text: "Action #" + modelData
onClicked: {
combo.text = text;
combo.expanded = false;
}
}
}
}
\endqml
\section2 Styling
The style of the component is defined in \l ComboButtonStyle.
*/
AbstractButton {
id: combo
/*!
\deprecated
If set to a color, the button has a stroke border instead of a filled
shape.
*/
property color strokeColor
onStrokeColorChanged: console.warn(
"WARNING: ComboButton.strokeColor is deprecated."
)
/*!
\deprecated
The background color of the button.
*/
property color color
onColorChanged: console.warn("WARNING: ComboButton.color is deprecated.")
/*!
\deprecated
The gradient used to fill the background of the button.
Standard Ubuntu gradients are defined in \l UbuntuColors.
If both a gradient and a color are specified, the gradient will be used.
*/
property Gradient gradient
onGradientChanged: console.warn(
"WARNING: ComboButton.gradient is deprecated."
)
/*!
\deprecated
The property specifies the color of the dropdown button and the combo
list for both collapsed and expanded states. You can use \l expanded to
define different colors for expanded or collapsed states.
*/
property color dropdownColor
onDropdownColorChanged: console.warn(
"WARNING: ComboButton.dropdownColor is deprecated."
)
/*!
The font used for the button's text.
*/
property font font: __styleInstance.defaultFont
/*!
The position of the icon relative to the text. Options
are "left" and "right". The default value is "left".
If only text or only an icon is defined, this
property is ignored and the text or icon is
centered horizontally and vertically in the button.
Currently this is a string value. We are waiting for
support for enums:
https://bugreports.qt-project.org/browse/QTBUG-14861
*/
property string iconPosition: "left"
/*!
Specifies whether the combo list is expanded or not. The default falue is
false.
*/
property bool expanded: false
/*!
The property holds the height of the component when collapsed. By default
the value is the implicit height of the component.
*/
property real collapsedHeight: implicitHeight
/*!
The property holds the maximum height value the component should expand.
When setting the property, remember to take into account the \l collapsedHeight
value. The best practice is to use bind it with collapsedHeight.
\qml
ComboButton {
text: "altered expandedHeight"
expandedHeight: collapsedHeight + units.gu(25)
}
\endqml
A value of -1 will instruct the component to expand the combo list as
much as its content height is.
The default value is \l collapsedHeight + 19.5 GU, so at least 3 ListItems
can fit in the combo list.
\sa collapsedHeight
*/
property real expandedHeight: collapsedHeight + units.gu(19.5)
/*!
The property holds the maximum combo list height allowed based on the
\l expandedHeight and \l collapsedHeight values. It is a convenience property
that can be used to size the combo list content.
\qml
import QtQuick 2.4
import Ubuntu.Components 1.3
import Ubuntu.Components.ListItems 1.3
ComboButton {
id: combo
text: "Full comboList size"
ListView {
anchors {
left: parent.left
right: parent.right
}
height: combo.comboListHeight
model: 20
delegate: Standard {
text: "Action #" + modelData
}
}
}
\endqml
\sa collapsedHeight, expandedHeight
*/
readonly property real comboListHeight: (expandedHeight < 0) ?
comboListHolder.height :
(expandedHeight - collapsedHeight -
(combo.__styleInstance ? combo.__styleInstance.comboListMargin : 0))
/*!
\qmlproperty list<Item> comboList
\default
Property holding the list of items to be shown in the combo list. Being
a default property children items declared will land in the combo list.
\note The component is not responsible for layouting the content. It only
provides scrolling abilities for the case the content exceeds the defined
expanded height.
*/
default property alias comboList: comboListHolder.data
styleName: "ComboButtonStyle"
// update sensing area to report clicks only on the main button area
// area excluding dropDown button and combo list
sensingMargins {
bottom: -(combo.height - combo.collapsedHeight)
right: -combo.__styleInstance.dropDownWidth
}
__mouseArea.objectName: "combobutton_mainbutton"
height: collapsedHeight + __styleInstance.comboListPanel.height
// dropdown button
AbstractButton {
id: dropDown
objectName: "combobutton_dropdown"
anchors {
right: parent.right
top: parent.top
}
width: combo.__styleInstance ? combo.__styleInstance.dropDownWidth : 0
height: combo.collapsedHeight
// open dropdown when pressed, not when clicked
onClicked: {
// toggle expanded
combo.expanded = !combo.expanded;
}
}
// expansion list
Flickable {
id: comboHolder
objectName: "combobutton_contentflicker"
parent: combo.__styleInstance ? combo.__styleInstance.comboListHolder : combo
anchors.fill: parent
interactive: combo.expanded && !contentIsFlickable() && (combo.expandedHeight > 0)
flickableDirection: Flickable.VerticalFlick
contentHeight: comboListHolder.height
// consider PathView as Flickable in this case as well!
function contentIsFlickable() {
return (comboListHolder.children.length === 1) &&
comboListHolder.children[0].hasOwnProperty("flicking");
}
Item {
id: comboListHolder
objectName: "combobutton_combolist"
anchors {
left: parent.left
right: parent.right
}
// stretch children width to holder's width
// must do binding to height manually to avoid binding loops caused
// by the vertical stretching when the component is a single flickable
property bool stretch: (combo.expandedHeight > 0 && comboHolder.contentIsFlickable())
onStretchChanged: stretchChildren()
onChildrenChanged: stretchChildren()
function stretchChildren() {
for (var i in comboListHolder.children) {
var child = comboListHolder.children[i];
if (comboListHolder.stretch) {
child.anchors.left = undefined;
child.anchors.right = undefined;
child.anchors.fill = comboListHolder;
comboListHolder.height = Qt.binding(function() {
return combo.comboListHeight;
});
} else {
child.anchors.left = comboListHolder.left;
child.anchors.right = comboListHolder.right;
comboListHolder.height = Qt.binding(function() {
return comboListHolder.childrenRect.height;
});
}
}
}
}
}
Scrollbar {
flickableItem: comboHolder
}
/*
Drive the expansion height of the combo list holder
This is a common functionaity in all combo buttons, therefore we can have it
in the main component.
*/
Binding {
target: combo.__styleInstance.comboListPanel
property: "height"
value: {
if (!expanded) {
return 0;
}
if (comboListHolder.stretch) {
return combo.comboListHeight + combo.__styleInstance.comboListMargin;
}
var h = comboListHolder.height;
var max = combo.comboListHeight + combo.__styleInstance.comboListMargin;
if (combo.expandedHeight < 0) {
return max;
}
return MathUtils.clamp(h, 0, max);
}
}
}
|