Bar Class Reference

Inherits QtQuick.Item, and Item.

Signals
void	aboutClicked ()
void	configClicked ()
void	helpClicked ()
void	homeClicked ()
void	nextLevelClicked ()
void	previousLevelClicked ()
void	reloadClicked ()
void	repeatClicked ()

Properties
real	barZoom
BarEnumContent	content
int	level

Detailed Description

A QML component for GCompris' navigation bar.

The Bar is visible in all activities and the main menu screen. It can be hidden by clicking on the 'toggle' region.

It can consist of a couple of child-elements, mostly buttons, defined in the BarEnumContent container. An activity can define which elements its bar should present using the content property. In most cases it contains at least BarEnumContent.help, BarEnumContent.home and BarEnumContent.level.

Cf. the BarEnumContent container for a full list of available Bar elements.

Cf. the Bar object used in Template.qml as an example of how a minimal Bar implementation should look like.

See also

BarButton, BarEnumContent

Definition at line 43 of file Bar.qml.

Member Function Documentation

void Bar::aboutClicked ( )

signal

Emitted when the about button was clicked.

void Bar::configClicked ( )

signal

Emitted when the config button was clicked.

Should be implemented if an activity provides per-activity configuration.

void Bar::helpClicked ( )

signal

Emitted when the help button was clicked.

Show help dialog upon this signal.

void Bar::homeClicked ( )

signal

Emitted when the home button was clicked.

Should always be connected to the ActivityBase.home signal and thus return to the home/main menu.

void Bar::nextLevelClicked ( )

signal

Emitted when the next level button was clicked.

Switch to the next level upon this signal.

void Bar::previousLevelClicked ( )

signal

Emitted when the previous level button was clicked.

Switch to the previous level upon this signal.

void Bar::reloadClicked ( )

signal

Emitted when the reload button was clicked.

Implement if you want to support repeating a level from the beginning.

void Bar::repeatClicked ( )

signal

Emitted when the repeat button was clicked.

Implement if your acitivity needs to repeat audio voices.

Property Documentation

real Bar::barZoom

Zoom factor of the bar and its children.

Definition at line 49 of file Bar.qml.

BarEnumContent Bar::content

Defines the content/children of the bar.

See also

BarEnumContent

Definition at line 56 of file Bar.qml.

int Bar::level

Current level to be shown in the level child.

Set this to the current level of your activity.

Definition at line 63 of file Bar.qml.

---

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

• Bar.qml