src/core/BarEnumContent.qml

0001 /* GCompris - BarEnumContent.qml
0002  *
0003  * SPDX-FileCopyrightText: 2014 Bruno Coudoin <bruno.coudoin@gcompris.net>
0004  *
0005  * Authors:
0006  *   Bruno Coudoin <bruno.coudoin@gcompris.net>
0007  *
0008  *   SPDX-License-Identifier: GPL-3.0-or-later
0009  */
0010 import QtQuick 2.12
0011
0012 /**
0013  * QML container for defining all visible child elements of a Bar.
0014  * @ingroup components
0015  *
0016  * Used in the Bar.content property.
0017  *
0018  * The @p value property must be set to a logically OR-ed combination of
0019  * the other properties each representing one Bar element.
0020  */
0021 QtObject {
0022     /**
0023      * type:int
0024      * Bitmask defininig all visible elements of a bar.
0025      */
0026     property int value: 0
0027
0028     /**
0029      * type:int
0030      * Representation of the help button.
0031      *
0032      * Used for opening a help screen.
0033      */
0034     readonly property int help: 1
0035
0036     /**
0037      * type:int
0038      * Representation of the about button.
0039      *
0040      * Used on the menu screen.
0041      */
0042     readonly property int about: 2
0043
0044     /**
0045      * type:int
0046      * Representation of the exit button.
0047      *
0048      * Used for exiting the application or returning to the menu.
0049      */
0050     readonly property int exit: 4
0051
0052     /**
0053      * type:int
0054      * Representation of the home button.
0055      *
0056      * Used for returning from an acitivity to the main menu.
0057      */
0058     readonly property int home: 8
0059
0060     /**
0061      * type:int
0062      * Representation of the config button.
0063      *
0064      * Used for switching to a config screen.
0065      */
0066     readonly property int config: 16
0067
0068     /**
0069      * type:int
0070      * Representation of the current level and next and previous buttons.
0071      */
0072     readonly property int level: 32
0073
0074     /**
0075      * type:int
0076      * Representation of the reload button.
0077      *
0078      * Used for restarting the current level of an activity.
0079      */
0080     readonly property int reload: 64
0081
0082     /**
0083      * type:int
0084      * Representation of the repeat button.
0085      *
0086      * Used for repeating audio voices.
0087      */
0088     readonly property int repeat: 128
0089
0090     /**
0091      * type:int
0092      * Representation of a currently running download.
0093      *
0094      * Shown automatically during running download.
0095      */
0096     readonly property int download: 256
0097
0098     /**
0099      * type:int
0100      * Representation of the hint button.
0101      *
0102      * Used for displaying a hint to the children to help.
0103      */
0104     readonly property int hint: 512
0105
0106     /**
0107      * type:int
0108      * Representation of the activity configuration button.
0109      *
0110      * Used for displaying the configuration of activities in the menu.
0111      */
0112     readonly property int activityConfig: 1024
0113 }