GCComboBox Class Reference

Inherits Item.

Signals
void	close ()
void	start ()
void	stop ()

Properties
Item	background
int	currentIndex
string	currentText
bool	isModelArray
string	label
alias	model

Detailed Description

A QML component unifying comboboxes in GCompris.

GCComboBox contains a combobox and a label. When the combobox isn't active, it is displayed as a button containing the current value and the combobox label (its description). Once the button is clicked, the list of all available choices is displayed. Also, above the list is the combobox label.

Navigation can be done with keys and mouse/gestures. As Qt comboboxes, you can either have a js Array or a Qml model as model.

GCComboBox should now be used wherever you'd use a QtQuick combobox. It has been decided to implement comboboxes ourselves in GCompris because of some integration problems on some OSes (native dialogs unavailable).

Definition at line 41 of file GCComboBox.qml.

Property Documentation

Item GCComboBox::background

Where the list containing all choices will be displayed.

Should be the dialogActivityConfig item if used on config.

Definition at line 48 of file GCComboBox.qml.

int GCComboBox::currentIndex

Current index of the combobox.

Definition at line 53 of file GCComboBox.qml.

string GCComboBox::currentText

Current text displayed in the combobox when inactive.

Definition at line 58 of file GCComboBox.qml.

bool GCComboBox::isModelArray

Internal value.

If model is an js Array, we access data using modelData and [] else qml Model, we need to use model and get().

Remarks

This property is read-only

Definition at line 75 of file GCComboBox.qml.

string GCComboBox::label

Text besides the combobox, used to describe what the combobox is for.

Definition at line 68 of file GCComboBox.qml.

alias GCComboBox::model

Model for the list (user has to specify one).

Definition at line 63 of file GCComboBox.qml.

---

The documentation for this class was generated from the following file:

• GCComboBox.qml