QtQuickPlayground Example v1.1.0
==========================================

This QML application demonstrates the features of Qt Quick by a set of demos
and possibility to view the source code of the demos. Each demo shows different
areas of the Qt Quick features. Application is compatible with Maemo, S60
5th Edition devices and Windows desktop with Qt 4.7.0 RC or higher.


FILES
-------------------------------------------------------------------------------

src/main.cpp

- The main file of the application. In practise, creates QDeclarativeEngine
  and QDeclarativeView, sets view to landscape and starts the demochooser.qml

src/qmlcodeprovider.cpp

- Implementation of Qt class which purpose is to read / write a text file and
  provide content of text file to QML code

src/demochooser.qml

- The main screen of the QtQuickPlayground application, gives the parameters
  of each demo to the demoitem.qml

src/content/demoitem.qml

- Contains the graphic elements of demo, the skin, texteditor, buttons, handles
  the states and transitions when starting / closing / entering code editor.

src/content/demoitemcore.js

- The javascript file that contains code to dynamically load / unload the
  selected demo

src/content/texteditor.qml

- TextEditor component, implements the code editor

src/content/dialog.qml

- Dialog component which is used to show the error strings and to entering to the
  code editor to view the place of the code with error

src/content/sidepanel.qml

- Side panel component, mostly contains back and code editor buttons

src/content/fancypicker/*

- Implementation of FancyPicker demo

src/content/helloworld/*

- Implementation of HelloWorld demo

src/content/memorygame/*

- Implementation of MemoryGame demo

src/content/slideshow/*

- Implementation of SlideShow demo

src/content/webcontent/*

- Implementation of WebContent demo

debian/

- The directory which contains files related to Debian (Maemo) packaging.

install/

- The compiled binaries for different platforms.


KNOWN ISSUES
-------------------------------------------------------------------------------

- The performance is slow in Symbian due to the fact that the each demo holds
  lots of grapchic elements hidden (code editor)

DESIGN CONSIDERATIONS
-------------------------------------------------------------------------------

- There should be only one code editor in this application, at the moment every
  demo has their own code editor which consumes memory and resources.
  
INSTALLATION INSTRUCTIONS
-------------------------------------------------------------------------------

Mobile device (S60 5th Edition)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There are two ways to install the application in the device.

0. The Qt 4.7.0 RC or higher libraries must be installed, see COMPATIBILITY
   chapter for more information about the install.

1. a) Drag the install/qtquickplayground.sis file to the Nokia PC Suite when
      phone is connected with the USB cable.
   
   OR
   
   b) Send the application directly to the Messaging Inbox (for example,
      through Bluetooth).

2. After the installation is complete, return to the Application menu and
   select the Applications folder.
   
3. Locate the qtquickplayground icon and select it to launch the application.


Mobile device (Maemo)
~~~~~~~~~~~~~~~~~~~~~
0. The Qt 4.7.0 RC or higher libraries must be installed, see COMPATIBILITY
   chapter for more information about the install.

1. Copy the install/qtquickplayground_1.1.0_armel.deb file into a
   specific folder of the device (for example "MyDocs").

2. Start the XTerm. Type "sudo gainroot" to get root access.

3. "cd" into the directory to which you copied the package (e.g. "cd MyDocs").

4. As root, install the package:
   "dpkg -i qtquickplayground_1.1.0_armel.deb".

5. Launch the Applications menu.

6. Locate the qtquickplayground icon and select it to launch the application.


Windows desktop
~~~~~~~~~~~~~~~
0. The Qt 4.7.0 RC or higher libraries must be installed, see COMPATIBILITY
   chapter for more information about the install.
   
1. Copy the install/qtquickplayground.exe file into a folder into a
   specific folder of the desktop (for example "Desktop").
   
2. Locate the qtquickplayground.exe and launch the application.


RUNNING THE APPLICATION
-------------------------------------------------------------------------------

Launch QtQuickPlayground on your device. The main windows is loaded showing the
set of six (on Symbian only four) Qt Quick demos.

You may start each demo by tapping the demo on the screen. The demo will scale
to the full screen and the actual demo is dynamically loaded. All the demos has
a sidepanel on the right side which allows you to go back to the main screen or
to enter to the code editor of the demo. You may also enter to the code editor
by peeling the skin of the demo on main screen by moving finger diagonally from
the bottom right corner towards the top left corner.

In the code editor you can examine the code of the demo. You may scroll the
code editor by dragging finger on top of the code in the browse state. Browse
state can be changed to edit state with the button on the top reading browse.
In the edit state code can not be scrolled but you may edit the code with the
devices keyboard. To scroll the code, change the state back to browse state.
After editing the code you might want to try and see how the editing affected
the demo. The demo can be started from the Try Demo button on the bottom right
corner. If there are error(s) in the code, an error dialog is shown and by
clicking the dialog you can go back to editor to view whats wrong.

Each demo can be closed from the back button on the top right corner which 
leads you back to the main screen of the application. The application is
closed with the x-mark on the upper right corner of the main screen.

Note: Every time the QtQuickPlayground application is started the code of the
each demo will revert to the original state destroying all the code changes you
may have done.


COMPATIBILITY
-------------------------------------------------------------------------------

- S60 5th Edition with Qt for S60 version 4.7.0 RC or higher.

  1. Download the Qt 4.7.0 RC or higher for Symbian from qt.nokia.com
  
  2. Drag the qt_selfsigned.sis on top of the device in PC Suite while the
     device is connected. The sis package is found from the installation folder
     of the Qt 4.7.0 RC or higher for Symbian.

     
- Maemo with Qt version 4.7.0 RC or higher, use the following steps to
  install the required libraries:
  
  1. Add the Extras-devel repository, Application manager -> Application
     catalogues -> New:
     Catalogue name: Extras-devel
     Web address: http://reposiroty.maemo.org/extras-deve
     Distribution: fremantle
     Components: free non-free
  
  2. Start X Terminal.
  
  3. Type "sudo gainroot" to get root access.
  
  4. Type "apt-get install libqt4-experimental-declarative" to install 
     QtDeclarative module required by the application. All other necessary 
     modules will be also installed, eg. libqt4-experimental-core,
     libqt4-experimental-gui etc. These modules will not overwrite your
     Qt 4.6.x libraries because they are installed on different location and
     with different naming.

     
- Windows desktop with Qt version 4.7.0 RC or higher, use the following steps
  to install the required libraries:
  
  1. Download the Qt 4.7.0 RC or higher for Windows from qt.nokia.com
  
  2. Make sure that the Qt is defined on the path (for Qt 4.7.0 RC binaries 
     normally installs to c:\qt\4.7.0-rc1\bin).
     
Tested on:

- Nokia N97
- Nokia N900
- Windows XP

RELATED RESOURCES
-------------------------------------------------------------------------------

