/* GCompris - BarEnumContent.qml
 *
 * Copyright (C) 2014 Bruno Coudoin <bruno.coudoin@gcompris.net>
 *
 * Authors:
 *   Bruno Coudoin <bruno.coudoin@gcompris.net>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, see <http://www.gnu.org/licenses/>.
 */
import QtQuick 2.6

/**
 * QML container for defining all visible child elements of a Bar.
 * @ingroup components
 *
 * Used in the Bar.content property.
 *
 * The @p value property must be set to a logically OR-ed combination of
 * the other properties each representing one Bar element.
 */
QtObject {
    /**
     * type:int
     * Bitmask defininig all visible elements of a bar.
     */
    property int value: 0

    /**
     * type:int
     * Representation of the help button.
     *
     * Used for opening a help screen.
     */
    readonly property int help: 1

    /**
     * type:int
     * Representation of the about button.
     *
     * Used on the menu screen.
     */
    readonly property int about: 2

    /**
     * type:int
     * Representation of the exit button.
     *
     * Used for exiting the application or returning to the menu.
     */
    readonly property int exit: 4

    /**
     * type:int
     * Representation of the home button.
     *
     * Used for returning from an acitivity to the main menu.
     */
    readonly property int home: 8

    /**
     * type:int
     * Representation of the config button.
     *
     * Used for switching to a config screen.
     */
    readonly property int config: 16

    /**
     * type:int
     * Representation of the current level and next and previous buttons.
     */
    readonly property int level: 32

    /**
     * type:int
     * Representation of the reload button.
     *
     * Used for restarting the current level of an activity.
     */
    readonly property int reload: 64

    /**
     * type:int
     * Representation of the repeat button.
     *
     * Used for repeating audio voices.
     */
    readonly property int repeat: 128

    /**
     * type:int
     * Representation of a currently running download.
     *
     * Shown automatically during running download.
     */
    readonly property int download: 256

    /**
     * type:int
     * Representation of the hint button.
     *
     * Used for displaying a hint to the children to help.
     */
    readonly property int hint: 512
}