QtQuickPlayground Example v1.2.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 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

src/debian/

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

install/

- The compiled binaries for each platforms.


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

- The performance could be better (mostly in Symbian) due to the fact that the
  each demo holds lots of grapchic elements hidden (code editor)
  
- The WebContent demo does not work on N8, because the Qt 4.7 is missing
  the WebKit QML module.

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 and Symbian^3)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

0. The Qt 4.7.0 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 Ovi 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 or higher libraries must be installed, see COMPATIBILITY
   chapter for more information about the install.

1. Copy the install/qtquickplayground_1.2.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.2.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 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 window is loaded showing the
set of six (on Symbian only five) 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 see 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 and Symbian^3 with Qt version 4.7.0 or higher.

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

     
- Maemo with PR1.3 which includes Qt 4.7

  1. Use Nokia Ovi Suite for updating the devices firmware to PR1.3

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

- Nokia N97
- Nokia N8
- Nokia N900
- Windows XP

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

