QOrbiter

qOrbiter is a new LinuxMCE orbiter designed to run on a multitude of devices as well as provide flexible skinning options to make it truly one's own. The purpose of this document now is for documentation of the app moving forward, followed by it being a reference for creating ones own skin

Concept

The concept of this document is to provide those wishing to create new skins the needed access to LinuxMCE data through properties and context objects. While I will not be discussing what they are here, they are discussed in the scope of QML documentation which is a pre-requisite to skinning and working with Qorbiter.

So, for example lets take the context property "deviceid". This property is added to the QML engine at runtime so that it can be used to provide the current device id of the orbiter. So in effect, this is a macro or keyword if you will that enables access to the underlying LinuxMCE data. As is one of the goals, no programming is required. One of the goals of this document is to outline all of these properties for easy reference in making a new skin.

Context Properties

The format is PropertyName: the type of data it provides.

General

srouterip  : string of the router ip. Default is "dcerouter" deviceid  : string representation of device number style  : reference the the current style that is set

User

• currentUser: the current orbiter user - Text name
• userList: listmodel of all users

There is also a component: UserListComponent.qml This component is totally skinnable and at its core contains a listmodel of all the users. In addition, it sets the current user whenever clicked.

Location

• currentroom: the current room / ea
• roomList: list of ea's rooms
• component: RoomSelector.qml

Selects and set the current room and changes listmodels accordingly

Home Screen

List Models

These are prepared in c++ and provided to the QML. If you are creating a skin, you will use these variables to call certain arrays of objects like scenarios, or userlists. This makes it easier for the designer, as they information will be populated and they only need to fill in the variable.

• currentRoomLights: provides by room scenario list for lights. you will need to use your own delegate. a default is provided
• currentRoomMedia: provides by room scenario list for media. you will need to use your own delegate
• currentRoomClimate: provides by room scenario list for climate. you will need to use your own delegate
• currentRoomTelecom: provides by room scenario list for telecom. you will need to use your own delegate
• currentRoomSecurity: provides by room scenario list for security. you will need to use your own delegate

Data Grids

Datagrids will encompass these specific views and more to come. Currently, they are very basic and dont accept any styling but this will change over time.

• File List
• Device Arrays
• Lists

Media Grids

gmediatype  : current grid mediatype (to show context based images or who knows ) fileformatmodel  : fileformat listmodel connected to grid filtering mechanism mediatypefilter  : mediatype list model connected to grid filtering mechanims

Colors

Colors such as background and button colors should be set in the style file of the qml skin. See 'Style1.qml' for reference on setting up property aliases.

Examples include:

property color stageBG: "slategray"

Qualified color references include:

• SVG named colors Reference
• Web color notation #112233

Skins

skinsList: listmodel of skins found for the build One should always check the official doc's to see what methods are supported for setting properties.

Images

Images can be loaded in multiple ways and will be discussed here in the future.