Difference between revisions of "Qml Ui"

From LinuxMCE
Jump to: navigation, search
(→‎Initial Findings)
m (→‎Setting it up)
 
(31 intermediate revisions by 5 users not shown)
Line 11: Line 11:
 
Stay tuned to this development space
 
Stay tuned to this development space
 
==Downloads & Initial setup==
 
==Downloads & Initial setup==
−
*http://qt.nokia.com/downloads The SDK you will need. Previous releases will NOT work
+
Working with QOrbiter requires pre-requisites depending on platform and what you intend to do. To work on just the design aspect, please  follow the 'Design Work' instructions To compile it yourself, check 'compiling from source'
 +
To get up and running, you need the following:
 +
 
 +
===Compiling from source===
 +
*Qt libraries for the version you are targeting
 +
**'''QtSDK''' http://qt-project.org/downloads
 +
***KDE 10.04
 +
***and KDE 11.04 / 11.10 - '''Recommended'''
 +
***KDE 12.04 is currently unsupported by the SDK
 +
OR
 +
*Build the Qt libraries from source on platforms not supported by the SDK, to build without the SDK, or for Android
 +
**Latest Qt Creator http://origin.releases.qt-project.org/qtcreator/
 +
**Source Availible Here - ftp://ftp.qt.nokia.com/qt/source/
 +
*Android requires Necessitas - Please read the appropriate instructions there to get it installed.
 +
**http://necessitas.kde.org/
 +
 
 +
 
 +
===Design Work===
 +
If you are looking to do design work on skins only, please use one of the pre-built binary packages to make your life easier.
 +
*KDE 12.04 - Unavailable at this time
 +
*KDE 11.04 - Working
 +
**https://www.dropbox.com/sh/6ucnrflo6w7ry8m/i-0Zjw0dB9/QOrbiter-Desktop-OpenGL/qorbiter-4.8.2-core-gl.tar.gz
 +
*KDE 10.04 - Requires build and install of qt 4.7.4 libraries first
 +
**http://dl.dropbox.com/u/33136233/QOrbiter-Desktop-OpenGL/qorbiter-4.7.4-core-gl.tar.gz
 +
*Windows  - Unavailable at this time
 +
*OSX - Unavailible at this time
 +
*Android Pre ICS
 +
** https://play.google.com/store/apps/details?id=org.linuxmce.qorbiter
 +
*Android ICS
 +
**http://dl.dropbox.com/u/33136233/Android-ICS-apk/QOrbiter-release.apk
  
 
=Setting it up=
 
=Setting it up=
 
I installed qt creator into home, although the default location is opt. Installing it into home will allow you get up and running right away but if installed into opt you will need to export some paths as described below.
 
I installed qt creator into home, although the default location is opt. Installing it into home will allow you get up and running right away but if installed into opt you will need to export some paths as described below.
  
−
via irc and TSCHAKeee
+
*SVN Checkout of the current /src tree from the svn
−
i literally just copy -ax /opt/QtSDK/Desktop/* to the core
+
*you need to install subversion
−
  either tarballing it up or otherwise
+
  sudo apt-get install subversion
−
then export '''PATH=/opt/QtSDK/Desktop/Qt/473/gcc/bin:$PATH'''
+
*you then check out the source tree by entering this:
−
  then export '''LD_LIBRARY_PATH=/opt/QtSDK/Desktop/Qt/473/gcc/lib:$PATH'''
+
svn co http://svn.linuxmce.org/svn/branches/LinuxMCE-1004/src
−
this can be placed in your .bash_profile
+
and the web part like this
−
and you can then run qOrbiter
+
  svn co http://svn.linuxmce.org/svn/branches/LinuxMCE-1004/web
  
−
You should then be able to compile / run / hack on qOrbiter
+
If you downloaded the SDK, please run  
 +
sudo apt-get install build-essential
 +
before installing Qt SDK. It includes many packages needed
  
−
=Initial Findings=
+
*Install QT SDK as outlined
−
All research is being done against the current branch of code in the svn. The Big Idea(tm) is do the following:
+
*If building Qt libraries from source, you may run into dependency issues, but they are easily resolved.
−
Create a new orbiter using qml as our ui both for its portability and skinning ease of use.
+
 
 +
After you've started QT SDK, some configuration is required to load the orbiter. First, you need to load the project itself. Navigate through your source tree to QOrbiter/Qorbiter_src. In this directory, you will find a .pro file named QOrbiter_src.pro. Open this and it will load the project into qt Creator. It should go without saying, but read the README!
 +
 
 +
 
 +
Next, open the qOrbiter project and setup the Build Settings.  Do this by clicking the "Projects" button from the left side menu.  You need to add to the "Additional arguments:" line for qmake under Build Steps.  Do this by clicking the "Details" button to the right of <b>qmake:</b> and additional arguments.  These are the current options:
 +
"CONFIG+=opengl"        :: enables opengl
 +
"CONFIG+=ANDROID"        :: android
 +
 
 +
Please ensure you include the quotes for the "CONFIG+= whatever"
 +
 
 +
For example, after adding the above arguments, my "Effective qmake call:" box looks like this, where [username] is my ubuntu login name:
 +
 
 +
  qmake /home/[username]/src/qOrbiter/qObiter_src/qObiter_src.pro -r -spec linux-g++ "CONFIG+=opengl"
 +
 
 +
Next, ensure 'shadow build' is checked in this same menu. Then you need to set the path to '../build-output'
 +
 
 +
== Setting up for android development ==
 +
 
 +
Install necessitas as well as some java specific packages that it will ask you to install if not already installed. Once, done, open the project just like a normal Qt creator project and run it. '''NOTE''' you need to pay attention to the instructions in the necessitas installation guide on running your Qt project, specifically who and what Ministro is and does, and two how to configure the run options.
 +
 
 +
== Notes From The Trenches ==
 +
While trying to get qOrbiter to build for Qt 4.7.4 I had two problems.
 +
 
 +
qOrbiter started, selection of qOrbiter device worked, but after the following errors were thrown out:
 +
(file:///usr/src/lmce-1004/qOrbiter/QOrbiter-build-4.7.4/qml/desktop/default/main.qml:2:1: plugin cannot be loaded for module
 +
"Qt.labs.shaders": The plugin '/usr/src/lmce-1004/qOrbiter/QOrbiter-build-4.7.4/imports/Qt/labs/shaders/libqmlshadersplugin.so'
 +
uses incompatible Qt library. (4.8.2) [release]
 +
    import Qt.labs.shaders 1.0
 +
    ^)
 +
 
 +
and/or there was a problem with libAudioVisual.so
 +
 
 +
Both problems had the same reason. The svn contained shared object libraries which were build using 4.8.2 and automatically copied into the build output. '''MORE TO FOLLOW'''
 +
 
 +
=API Development=
 +
Currently we are developing (actively) the api for the QML engine to utilize to communicate with the DCERouter backend. The purpose of this API is simply to abstract away the c++ from the user interface code, allowing for easily customized visual styles and user experiences.  
  
 
Initial experiments
 
Initial experiments
 
http://wiki.linuxmce.org/index.php/Qml
 
http://wiki.linuxmce.org/index.php/Qml
 
http://forum.linuxmce.org/index.php?topic=11722.0
 
http://forum.linuxmce.org/index.php?topic=11722.0
−
 
+
==QML==
 
If you are interested in playing with skinning only you can find the skinning document [http://wiki.linuxmce.org/index.php/QOrbiter QOrbiter Development Page].
 
If you are interested in playing with skinning only you can find the skinning document [http://wiki.linuxmce.org/index.php/QOrbiter QOrbiter Development Page].
  
−
==UI==
+
==DCE==
−
*Determine to what level we want QML to control the UI vs the c++ code.
+
Part of this process is finding the deficiencies in the DCE code / api itself and going back to the source so to speak to refine how data structures are passed. This is an involved process involving the LinuxMCE database, server code, and many other variables. The entire api for QOrbiter is generated by the DCEGen tool that is part of LinuxMCE. it literally reads device definitions from the LinuxMCE database and creates C++ stub code to be expanded later as the software device is completed. Part of the task of creating QOrbiter was talking to that api in an efficient manner.
−
*Provide a set of constant objects for UI designers to connect to for data
+
−
*Provide basic qml elements for some design objects. Think buttons specifically. These would be referred to as custom qml 'components'
+
−
*Develop a base template for styles to follow. This would allow changes to be made globally that would affect all qml objects loaded.
+
−
*determine animations sets for our custom qml objects
+
−
 
+
−
Following this idea further, its been decided to attempt to define the orbiter varables and data as a complex Data model. While the disadvantage is the complexity of the model, it will expose essentially a simple api to skin designers to access linuxMCE data in their skin, further removing programmatic responsibilities from the ui.
+
−
 
+
−
The initial work in this area includes
+
−
*creating the needed subclassed models from QAbstractListModel
+
−
*creating a purpose specific orbiter generator as the current orbiter gen does more than is needed and is too tightly coupled to the concept of deign_obj's something we wish to get away from.
+
  
 
==C++==
 
==C++==
−
There will need be be considerable time invested into understanding and picking apart certain functions of the existing orbiter to determine relevance in any new orbiter. These include not just the orbiter itself, but datagrids and how it interacts with other plugins. We will need to translate the functionality to new methods because of the inherent difference in the two ui toolkits. Things such as screen handlers and the callback system will be replaced with the signal and slots mechanisms of Qt and so must be understood to be replaced.  
+
In addition to the UI development, there is also an active effort to utilize c++ as much as possible to extend the functionality of QOrbiter. With this in mind, it should be understood that this is also something under active development.
 
*Datagrids - Custom DataModel has been implemented.  
 
*Datagrids - Custom DataModel has been implemented.  
 
*Screen Handlers - Handled by native qt functions
 
*Screen Handlers - Handled by native qt functions
 
*Mouse Handlers - Not needed as of yet
 
*Mouse Handlers - Not needed as of yet
  
 +
==Current Architecture==
 +
A very high level overview is as follows:
 +
*QOrbiter is a c++ / QML based application capable of communicating with the DCERouter (server) over network sockets to control various aspects of the LinuxMCE home automation system.
 +
*It consists of
 +
** Statically compiled, threaded DCE code, normally produced as standalone libraries, but made static in this case for portability, comprised mainly of STL C++
 +
** Qt C++ serving as the 'translator' or bridge from the DCE code to the Qt Gui
 +
** QML Skinning engine that allows for dynamic changing of visual styles and user created styles without need for re-compilation
 +
**Multimedia player limited only by its platforms media abilities based on Phonon / Gstreamer
  
−
[[Category:Programmer's Guide]][[Category:QML]]
+
[[Category:Programmer's Guide]][[Category:QML]][[category:QOrbiter]]

Latest revision as of 10:18, 27 October 2012

This page is intended to serve as an ongoing development guide in relation to using QML as the engine for LinuxMCE's user interface. We shall outline relevant documents relating to QML as well as specifics for designing a skin. Please note, if you are reading this, then this is in fact an ongoing guide and as such information is apt to change. Personal notes are to be kept in the discussion area of this page, please post only code, links, or other relevant data to UI development. This message will self-destruct in 10 seconds.

QML KnowledgeBase

An Overview of what QML is http://labs.qt.nokia.com/2009/05/13/qt-declarative-ui/ A document on styling and whats important, skinning - http://developer.qt.nokia.com/wiki/QmlStyling

Stay tuned to this development space

Downloads & Initial setup

Working with QOrbiter requires pre-requisites depending on platform and what you intend to do. To work on just the design aspect, please follow the 'Design Work' instructions To compile it yourself, check 'compiling from source' To get up and running, you need the following:

Compiling from source

  • Qt libraries for the version you are targeting

OR


Design Work

If you are looking to do design work on skins only, please use one of the pre-built binary packages to make your life easier.

Setting it up

I installed qt creator into home, although the default location is opt. Installing it into home will allow you get up and running right away but if installed into opt you will need to export some paths as described below.

  • SVN Checkout of the current /src tree from the svn
  • you need to install subversion 
sudo apt-get install subversion
  • you then check out the source tree by entering this:
svn co http://svn.linuxmce.org/svn/branches/LinuxMCE-1004/src

and the web part like this 

svn co http://svn.linuxmce.org/svn/branches/LinuxMCE-1004/web

If you downloaded the SDK, please run 

sudo apt-get install build-essential

before installing Qt SDK. It includes many packages needed

  • Install QT SDK as outlined
  • If building Qt libraries from source, you may run into dependency issues, but they are easily resolved.

After you've started QT SDK, some configuration is required to load the orbiter. First, you need to load the project itself. Navigate through your source tree to QOrbiter/Qorbiter_src. In this directory, you will find a .pro file named QOrbiter_src.pro. Open this and it will load the project into qt Creator. It should go without saying, but read the README!


Next, open the qOrbiter project and setup the Build Settings. Do this by clicking the "Projects" button from the left side menu. You need to add to the "Additional arguments:" line for qmake under Build Steps. Do this by clicking the "Details" button to the right of qmake: and additional arguments. These are the current options: 

"CONFIG+=opengl"         :: enables opengl
"CONFIG+=ANDROID"        :: android

Please ensure you include the quotes for the "CONFIG+= whatever"

For example, after adding the above arguments, my "Effective qmake call:" box looks like this, where [username] is my ubuntu login name: 

 qmake /home/[username]/src/qOrbiter/qObiter_src/qObiter_src.pro -r -spec linux-g++ "CONFIG+=opengl"

Next, ensure 'shadow build' is checked in this same menu. Then you need to set the path to '../build-output'

Setting up for android development

Install necessitas as well as some java specific packages that it will ask you to install if not already installed. Once, done, open the project just like a normal Qt creator project and run it. NOTE you need to pay attention to the instructions in the necessitas installation guide on running your Qt project, specifically who and what Ministro is and does, and two how to configure the run options.

Notes From The Trenches

While trying to get qOrbiter to build for Qt 4.7.4 I had two problems.

qOrbiter started, selection of qOrbiter device worked, but after the following errors were thrown out: 

(file:///usr/src/lmce-1004/qOrbiter/QOrbiter-build-4.7.4/qml/desktop/default/main.qml:2:1: plugin cannot be loaded for module
"Qt.labs.shaders": The plugin '/usr/src/lmce-1004/qOrbiter/QOrbiter-build-4.7.4/imports/Qt/labs/shaders/libqmlshadersplugin.so'
uses incompatible Qt library. (4.8.2) [release]
    import Qt.labs.shaders 1.0
    ^)

and/or there was a problem with libAudioVisual.so

Both problems had the same reason. The svn contained shared object libraries which were build using 4.8.2 and automatically copied into the build output. MORE TO FOLLOW

API Development

Currently we are developing (actively) the api for the QML engine to utilize to communicate with the DCERouter backend. The purpose of this API is simply to abstract away the c++ from the user interface code, allowing for easily customized visual styles and user experiences.

Initial experiments http://wiki.linuxmce.org/index.php/Qml http://forum.linuxmce.org/index.php?topic=11722.0

QML

If you are interested in playing with skinning only you can find the skinning document QOrbiter Development Page.

DCE

Part of this process is finding the deficiencies in the DCE code / api itself and going back to the source so to speak to refine how data structures are passed. This is an involved process involving the LinuxMCE database, server code, and many other variables. The entire api for QOrbiter is generated by the DCEGen tool that is part of LinuxMCE. it literally reads device definitions from the LinuxMCE database and creates C++ stub code to be expanded later as the software device is completed. Part of the task of creating QOrbiter was talking to that api in an efficient manner.

C++

In addition to the UI development, there is also an active effort to utilize c++ as much as possible to extend the functionality of QOrbiter. With this in mind, it should be understood that this is also something under active development.

  • Datagrids - Custom DataModel has been implemented.
  • Screen Handlers - Handled by native qt functions
  • Mouse Handlers - Not needed as of yet

Current Architecture

A very high level overview is as follows:

  • QOrbiter is a c++ / QML based application capable of communicating with the DCERouter (server) over network sockets to control various aspects of the LinuxMCE home automation system.
  • It consists of
    • Statically compiled, threaded DCE code, normally produced as standalone libraries, but made static in this case for portability, comprised mainly of STL C++
    • Qt C++ serving as the 'translator' or bridge from the DCE code to the Qt Gui
    • QML Skinning engine that allows for dynamic changing of visual styles and user created styles without need for re-compilation
    • Multimedia player limited only by its platforms media abilities based on Phonon / Gstreamer
Retrieved from "http://wiki.linuxmce.org/index.php?title=Qml_Ui&oldid=33321"