Editing Qt4 Hildon Legacy

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

[[Image:MaemoQtPicture.png]]
 
== [[Image:Intro.png]] Intro ==

=== Maemo Platform ===

The Maemo Platform is the software stack for Nokia Internet Tablets, which includes the Maemo operating system and the Maemo SDK. The Maemo Platform is mostly based on open source code, and has been developed by the Maemo Software department within Nokia in collaboration with many open source projects such as the Linux kernel, Debian, and GNOME.<ref>[http://en.wikipedia.org/wiki/Maemo_Platform Maemo Platform on Wikipedia]</ref>

[http://maemo.org/intro/platform/ Read more...]

=== What is Hildon? ===

Hildon is an application framework for Linux operating system mobile devices (PDAs, mobile phones, etc), developed by Nokia for Maemo and now a part of GNOME, that focuses on providing a finger friendly interface.<ref>[http://en.wikipedia.org/wiki/Hildon Hildon on Wikipedia]</ref>

[http://live.gnome.org/Hildon Read more...]

=== Developing on Maemo ===

Developing applications for Maemo is done with the Maemo SDK. The process from creating the first prototype of your application to distributing to a wide audience consists basically of three steps:

* Share your application project in the [http://garage.maemo.org Garage].
* Make your application easy to install and put in the [[Extras]].
* Once your application has a high quality - be promoted to the [http://www.nokia.com/os2008 Nokia user site].

[http://maemo.org/intro/developer_overview/ Read more...]

=== Maemo SDK ===

The Maemo SDK is based around the Debian-oriented Scratchbox Cross Compilation Toolkit, which provides a sandbox environment in which development may take place. Scratchbox uses Qemu to emulate an ARMEL processor or sbrsh to remotely execute instructions. Scratchbox-compatible rootstraps are available for both x86 and ARMEL, so the majority of development and debugging takes place on x86, with final packaging being for ARMEL.<ref>[http://en.wikipedia.org/wiki/Maemo_Platform#Maemo_SDK Maemo SDK on Wikipedia]</ref>

[http://www.youtube.com/watch?v=c8myh_iBy8k Watch the Maemo SDK in action!]

=== What is Scratchbox? ===

Scratchbox is a cross compilation toolkit designed to make embedded Linux application development easier. It also provides a full set of tools to integrate and cross compile an entire Linux distribution.<ref>[http://en.wikipedia.org/wiki/Scratchbox Scratchbox on Wikipedia]</ref>

[http://www.scratchbox.org/ Read more...]

== [[Image:Rocket.png]] Getting started ==

To start to develop with Maemo Qt, we need to install the Maemo SDK on a Linux machine.

=== Hey, I don't have a Linux machine! ===
That's not a big problem. You can run Maemo SDK in a virtual machine;
You can download Maemo SDK virtual Image (Linux Ubuntu + Diablo and Fremantle SDK)
from [http://tablets-dev.nokia.com/maemo-dev-env-downloads.php tablets-dev.nokia.com].
You can get VMPlayer from [http://www.vmware.com/products/player/ here].

=== Installing the Maemo SDK ===
Maemo SDK can be installaed in any Linux environment.
However Debian based distros (eg: Ubuntu) are recommended.

Documentation you need to install Maemo SDK is [http://maemo.org/development/sdks/ here].

=== Installing Qt packages in Scratchbox ===
Maemo Qt developers offers a set of Qt packages for Diablo (Maemo4.1 - OS2008)
and Fremantle (Maemo5 - OS2009).

==== Diablo ====
Diablo Qt packages are into the official Extras repository.
In order to start to develop with those packages you need to add
extras repository to your repository list.

1. Open /etc/apt/source.list with a text editor (eg: kate, gedit...)
 2. Append the following line to that file: 
 deb http://repository.maemo.org/extras/ diablo free non-free
 3. Then update your APT cache with
 apt-get update
 4. Install Qt packages with
 apt-get install libqt4-dev

==== Fremantle ====
You don't need to add any extra repository for Fremantle since Qt packages are already available into the SDK.

Then you can install Qt with:
 fakeroot apt-get install libqt4-gui libqt4-dev

===How to compile a Qt application in scratchbox===

All the Qt tools you need are available in scratchbox. In order to compile a Qt application you need to follow the
standard Qt way:

qmake -project
 qmake file.pro
 make

===Running a Qt application in scratchbox===
You can run a Qt application in both the target supported by scratchbox (ARMEL, X86).
However using the X86 target is recommended.

Before running the application you have to start Xephyr outside Scratchbox with the following parameters:
 $ Xephyr :2 -host-cursor -screen 800x480x16 -dpi 96 -ac -kb

In the Scratchbox environment the DISPLAY variable has to be set so that it matches the display setting given above for the Xephyr server (parameter :2 in the above example).

[sbox-DIABLO_<target>:~] > export DISPLAY=:2

After the Xephyr server is running on the Linux host, you can start the Hildon Application Framework with the following command:

[sbox-DIABLO_<target>:~] > af-sb-init.sh start

This should start the Hildon Application Framework inside the Xephyr window.

Now we are ready to run an application in scratchbox:

[sbox-DIABLO_<target>:~] > run-standalone.sh ./qtapps

===Running a Qt application on the device===

To run a Qt application into the device, we need to copy it there.

====Installing OpenSSH server on the device====

To install and run applications on the device, we'll need to install an [[SSH]] server.

* Open the Application Manager.
* Make sure [[Extras]] is enabled.
* Install openssh-server from the list.

====Setting up a network connection====

We can connect to device to our working machine via WLAN or USB. Connecting the device to a WLAN is quite easy, but [[USB networking]] is more difficult to set up.

====Using scp to copy the excutable on the device====

[http://en.wikipedia.org/wiki/Secure_copy scp] or secure copy is a common Linux application. It can copy files or a directories over a secure connection. To copy our application on the device we just need to run it with a syntax like this:

PC_$> scp qtApplication root@DEVICE-IP:/home/user

====Executing the application====

Now that the application has been copied onto the device, we can run it. For that we need to open the terminal or we can use ssh from our PC.

PC_$> ssh root@DEVICE-IP
 N810_#> su - user
 N810_$> ./qtApplication

== [[Image:Hammer.png]] Porting a Qt application to Maemo ==

===Intro===

Porting a Qt desktop application to Maemo requires very little effort. This because the Maemo Qt libraries will take care of giving the Hildon look & Feel and enabling the virtual input methods for your application.

===Overriding the Qt Maemo changes===

====Maemo Style====

The Maemo style is the default style of Qt applications on Maemo. The other styles available in Qt 4.4 Maemo are [http://doc.trolltech.com/4.4/gallery-cleanlooks.html QCleanLooks], [http://doc.trolltech.com/4.4/gallery-windows.html Windows] and [http://doc.trolltech.com/4.4/gallery-plastique.html Plastique] (It will be available in the next release of Qt).

You can force your application to use another style in several ways:

* Running your application with the flag -style <style_name>
''HINT: You can put this flag in the Exec field of the desktop file that launch the application.''

$> ./qt-test-application -style windows

* If you want to change your code, you can use this static function:[http://doc.trolltech.com/4.4/qapplication.html#setStyle QApplication::setStyle( QStyle * style )]

* If you want to change the style only for a particular widget, you can call this function in the widget constructor: [http://doc.trolltech.com/4.4/qwidget.html#setStyle QWidget::setStyle( QStyle * style )]

====Showing the status bar====

Hildon applications don't have a status bar. Qt for Maemo hides the status bar by default.
You can show it again by modifying your code.

TODO

====Using the Kinetic Finger Scrolling (cf Gtk's PannableArea)====
See [[Qt/Finger Scrolling|Finger Scrolling]]

===Adding Maemo changes to a Qt Application===

Some methods of Qt for Maemo are not available in the "standard" Qt libs, so a Qt application with specific Maemo Qt code can't be built outside the Maemo SDK. To avoid this issue, the developer can use the preprocessor directives, for example:

#ifdef Q_WS_HILDON
    //Specific hildon code here 
 #endif

===Limitations===

Currently Qt Maemo lacks full support for Hildon widgets introduced in Maemo 5.

'''At the moment, creating a Qt application that follows Maemo 5 UI Style requires using custom Qt widgets, coded within the application itself'''.

There is work ongoing to provide Qt Hildon widgets for Maemo 5, see [http://wiki.maemo.org/Qt4_Hildon/Qt_Hildon_Widgets Qt Hildon Widgets]

To get the benefits of the ongoing Maemo 5 hildon integration work in Qt, you must get the latest Qt source code and compile it yourself. See [http://wiki.maemo.org/Qt4_Hildon#Building_Qt_from_GIT_rep Building Qt from GIT repository].

== [[Image:Bug.png]] Debugging a Qt application ==

===GDB ===

====Intro ====

The GNU Project Debugger, or gdb for short, is a general purpose debugger that can be used for various debugging purposes.

====Debugging a Qt application in Scratchbox====

TODO

====Debugging a Qt application on device====

<ol>
<li>Installing gdb on the device.<ol>
<li>Add the [http://maemo.org/development/tools/ SDK tools] repository to the catalogue list.</li>
<li>install gdb by using apt-get (require around 6 MB of space)</li>
</ol></li>
<li>Install the debug symbols files in scratchbox (ARMEL target)</li>
 apt-get install libqt4-dbg
<li>Run the application (device side)</li>
 $gdbserver 0.0.0.0:1234 ./qtApplication
<li>Run the gdb client on your host PC (scratchbox side)</li>
 [sbox-DIABLO_ARMEL: ~/TEST/svn/qt4-x11-4.4.0/examples/widgets/tablet] > gdb ./qtApplication
<li>Set the target of gdb</li>
 (gdb) target remote 172.21.37.117:1234
<li>Tell to gdb to continue to debug the application on the device</li>
 (gdb) continue
<li>Wait some moments...</li>
<li>If necessary you can put break points; eg: for void QWidget::setPalette ( const QPalette & )</li>
 (gdb) break QWidget::setPalette(QPalette const&)
 Breakpoint 1 at 0x4026ae68

<li>Your application will appear on the device screen. Happy debugging!</li></ol>

===Links===

* [http://www.gnu.org/software/gdb/documentation/ GDB documentation & tutorials]
* [http://maemo.org/development/documentation/man_pages/gdbserver/ GDBServer man page]
* [http://maemo.org/maemo_release_documentation/maemo4.1.x/node15.html Maemo debugging guide]
* [http://repository.maemo.org/pool/diablo/free/g/gdb/ gdb debian package for Diablo]

== [[Image:chart.png]] Profiling a Qt application ==

=== OProfile ===

OProfile is a low overhead system-wide profiler for Linux. It can be used to find CPU usage bottlenecks in the whole system and within processes. It works fine in the device, but viewing the reports can take quite a long time (10 minutes) when fired up on N800/N810 devices. Therefore, it often makes sense to run opreport in scratchbox.

If you want to know more about OProfile in Maemo see the [http://maemo.org/development/tools/doc/chinook/oprofile/ documentation].

=== Valgrind ===

TODO

== [[Image:chart.png]] Qt benchmarks ==
2D graphic benchmark tools:

* [[Qt/Benchmark/qgear|QGears]]
3D graphic benchmark tools:

* TODO

== [[Image:package.png]] Packaging a Qt application for Maemo ==

== [[Image:Helmet.png]] Maemo Qt API Reference ==

Maemo Qt is based on Qt for X11. It shares the same API avoiding API breaks. In this way every Qt application that runs in other platforms (Windows, Mac OS X, Linux, S60, etc.) can run also into the Maemo devices. To Develop a Qt application you can use the [http://doc.trolltech.com/4.5/index.html Official Qt 4.5 API documentation] and the list below to see what are the Maemo changes.

'''QString QDesktopServices::storageLocation(StandardLocation type)''' returns specific Maemo locations for these types:
  - DesktopLocation:   QDir::homePath() + QLatin1String("/MyDocs"),            instead of QDir::homePath() + QLatin1String("/Desktop")
  - DocumentsLocation: QDir::homePath() + QLatin1String("/MyDocs/.documents"), instead of QDir::homePath() + QLatin1String("/MyDocs/.documents")
  - PicturesLocation:  QDir::homePath() + QLatin1String("/MyDocs/.images"),    instead of QDir::homePath() + QLatin1String("/Pictures")
  - MusicLocation:     QDir::homePath() + QLatin1String("/MyDocs/.sounds"),    instead of QDir::homePath() + QLatin1String("/Music")
  - MoviesLocation:    QDir::homePath() + QLatin1String("/MyDocs/.videos"),    instead of QDir::homePath() + QLatin1String("/MyDocs/.videos")

'''QTabletEvents''' are able to get the pressure value from the touchscreen.
   - The eventdeviceType is for the touchscreen is set to QTabletEvent::Stylus.
   - QTabletEvents won't be used anymore in Fremantle
  
  '''Finger poke''' is emulated in scratchbox by the Middle Mouse button (NOTE: There is no Fullscreen VKB in scratchbox)
 
  '''QInputEvents''' don't move the cursor. 
  It's mandatory to get working the HIM moving the cursor via QInputMethodEvents.
  Why is it mandatory?  
  Because if the user select text with the finger from the right to the left, we are able to remove the highlighted text, but the
  cursor will be moved on the last char instead to stay on the first one.
   
  To do that some changes has been added to some widget function like: ''widget::inputMethodEvent(QInputMethodEvent *e)''.
  Modifing that function in some custom widgets may be necessary.
  Don't reimplementing that function will break some fullscreen virtual keyboard features.
  
  '''Hardcoded Keys:'''
  In the QMainWindow:
  - F6 - Toggle fullscreen the application
  - F4 - Shows/Hides the application context menu
  - Zoom in  - is a standard [http://doc.trolltech.com/4.4/qkeysequence.html#StandardKey-enum key sequence] QKeySequence::ZoomIn
  - Zoom out - is a standard [http://doc.trolltech.com/4.4/qkeysequence.html#StandardKey-enum key sequence] QKeySequence::ZoomOut

'''Input Method:'''
 Maemo Qt uses the Hildon IM as default Input method.
 Each kind of widget can set the IM mode. This allows the input method to focus on the type of input that the application is expecting.
 Eg: spinboxes can receive only numeric characters (1-9).
 
 NOTE: Qt widgets like QTextEdit, QLineEdit... set the right input method mode automatically. 
 
 A developer can change it by using:
 void QInputContext::setInputMode(int mode);
 It will update immediately the Hildon Input method to use the selected IM mode. 
 
 HIC Modes:
 HILDON_GTK_INPUT_MODE_ALPHA 	alphabetical characters and whitespace
 HILDON_GTK_INPUT_MODE_NUMERIC 	numbers 0-9 and the '-' character
 HILDON_GTK_INPUT_MODE_SPECIAL 	special characters
 HILDON_GTK_INPUT_MODE_HEXA 	hexadecimal characters; numbers 0-9, characters a-f, and A-F
 HILDON_GTK_INPUT_MODE_TELE 	telephone numbers; numbers 0-9, whitespace, and the characters "pwPW/().-+*#?,"
 HILDON_GTK_INPUT_MODE_FULL 	unrestricted entry mode, combination of the alpha, numeric and special modes.
 HILDON_GTK_INPUT_MODE_MULTILINE 	the client contains multiple lines of text or accepts linebreaks in the input.
 HILDON_GTK_INPUT_MODE_INVISIBLE 	do not echo or save the input in the IM when entering sensitive information such as passwords.
 HILDON_GTK_INPUT_MODE_AUTOCAP 	automatically capitalize the first letter at the start of a sentence.
 HILDON_GTK_INPUT_MODE_DICTIONARY 	enable predictive dictionaries and learning based on the input.
 
 Example:
 For a password field we need to set a specific IM mode:
 int mode = HILDON_GTK_INPUT_MODE_FULL | HILDON_GTK_INPUT_MODE_INVISIBLE
 QInputContext qic = widget->inputContext();
 qic->setInputMode(mode);
 
 If you are developing a Custom widget able to receive input text, you can instruct your widget to use the right IM Mode just returning
 the mode.
 
 - How does it work?
 The Hildon IM sends a XMessage to pop up the "Virtual Keyboard" (or better the Main HIM UI) when an input widget receive the focus.
 The IM before to raise the VKB, makes an inputMethodQuery to the widget retrieving the IM mode.
 If the developer of the custom widget doesn't set the mode property, the IM will use HILDON_GTK_INPUT_MODE_FULL (the default mode) for that widget.
 
 Setting the ImMode is quite easy. Check the code below for more understanding.
 
 #ifdef Q_WS_HILDON
 #include <QInputContext>
 #endif
 
 QVariant QAbstractSpinBox::inputMethodQuery(Qt::InputMethodQuery query) const
 { 
 Q_D(const QAbstractSpinBox);
 switch(query) {
 case Qt::ImMode:{
 int mode = HILDON_GTK_INPUT_MODE_NUMERIC;
 return QVariant(mode);
 }
 default:
 return d->edit->inputMethodQuery(query);
 }
 }

'''QDialogs in fremantle.'''
   The fremantle WM doesn't allow QDialogs without a parent (at least this is true for Qt apps).
   A dialog without a parent won't be shown by the WM.
   
   Eg:
   This is what you MUST avoid. 
   QColorDialog::getColor ( Qt::white, 0 )
   
   Remember to setup a parent
   QColorDialog::getColor ( Qt::white, this )

'''QPrinter and QPrintDialog'''
   Print support has been removed from Maemo Qt.
   Application compiled with old libs are still binary compatible with the new libs but they crash when a removed component is called.
 
   Nokia: /home/user# ./textedit 
./textedit: symbol lookup error: ./textedit: undefined symbol: _ZN8QPrinterC1ENS_11PrinterModeE

'''System tray support'''
   System tray is not available anymore in Fremantle. That support has been removed from Qt too.
   Hence QSystemTrayIcon class is not available anymore.

== [[Image:Helmet.png]] Contributing to the Maemo Qt Project ==

Maemo Qt is a community project. Contributing to the forum, sending us patches, give us feedbacks, tracking bugs are all activities that help us to improve the quality of our work.

Here there is a list of things that every person interested in helping us should read.

===Be updated===
Any Maemo Qt developer should be updated and should participate to the discussions, for that he must join the Mailing list.
BTW the mailing list is not for Maemo Qt Developers but it's open to Maemo Qt application developers too.

=== Introduction to Git ===
If you are a git newbie you maybe find interesting these links:
* http://www.sourcemage.org/Git_Guide
* http://www.gitcasts.com/
* http://www.gnome.org/~newren/eg/git-for-svn-users.html
* Using the git protocol through a HTTP CONNECT proxy: http://www.emilsit.net/blog/archives/how-to-use-the-git-protocol-through-a-http-connect-proxy/

===Understanding the structure of our Git repository===
These info are here:[[Qt Maemo Git Process]].

=== Preparation ===
Make sure each scratchbox target has

fakeroot apt-get build-dep libqt4-gui

(you may need to apt-get install libgl-dev too as it's not in the Build-Depends: yet)

===Building Qt from GIT rep===

* Clone the repository:
 git clone git://gitorious.org/+qt-maemo-developers/qt/qt-maemo.git 
or if you are a member of our team:
 git clone git@gitorious.org:+qt-maemo-developers/qt/qt-maemo.git

* Change dir
 cd qt-maemo

* Copy the remote 4.5 branch in your workingcopy
 git checkout -b 4.5 origin/4.5

* Checkout ONE of these branches: 
 git checkout -b qt-diablo    origin/qt-diablo
 git checkout -b qt-n900 origin/qt-n900
 git checkout -b qt-mer       origin/qt-mer

* Build the packages:
 dpkg-buildpackage -rfakeroot -b

===Checking out all the remote branches===
* Clone the repository:
 git clone git://gitorious.org/+qt-maemo-developers/qt/qt-maemo.git 
or if you are a member of our team:
 git clone git@gitorious.org:+qt-maemo-developers/qt/qt-maemo.git

* Change dir
 cd qt-maemo

* Check out our script branch 
 git checkout -b maemo-qt-scripts origin/maemo-qt-scripts

* Save a copy of the script outside the working directories
 cp maemo-qt-scripts/copy-all-remote-branches-locally/copy.sh ../

* Launch the copy.sh script
 ../copy.sh

===Commit changes in SVN [OLD]===

If you are a Maemo Qt developer and you want to save your changes in the Garage SVN but your project is not ready to go to the main line (trunk/qt-x11), you should create a private branch and then work there until the merging with the mainline.

For that you have to create a your directory in branches/ named ''developer_name-qt''. After that you can copy trunk/qt-x11 in your directory.
 svn copy --username developer_name https://garage.maemo.org/svn/qt4/trunk/qt-x11 https://garage.maemo.org/svn/qt4/branches/developer_name-qt -m "Creating private branch of trunk/qt-x11"

NOTE: Subversion uses cheap copy, so them don't increase the size of the repository. Then feel free to create your own branch.

===Merging branches changes in the mainline [OLD]===

Before to merge your changes in the mainline, the code must be full working, cleaned and tested. A review from another developer is also needed in order to reduce the possibility to add errors.

==[[Image:Help-contents.png]] F.A.Q.==

=== I'm trying to compile a Qt application for ARMEL, but I got the error below. What's wrong? ===

/targets/FREMANTLE_X86/usr/include/qt4/QtCore/qatomic_i386.h:127: error: impossible constraint in 'asm'

You are using x86 include files, then you have to update your Makefile. Running <code>qmake</code> before <code>make</code> will be solve this issue.

=== I'm trying to compile a Qt packcage for x86, but I got the error below. What's wrong? ===

In file included from maemo/gconfsymbols.cpp:41:
 maemo/gconfsymbols_p.h:49:25: gconf/gconf.h: No such file or directory

Your scratchbox does not have <code>/bin/sh</code>, so when calling <code>pkg-config</code> from <code>qmake</code>, <code>CFLAGS</code> and <code>LIBS</code> are not set correctly. Running <code>ln -s /scratchbox/tools/bin/sh /bin/sh</code> will be solve this issue.

=== I'm trying to compile a diablo Qt package, so I just created a symbolic link, debian, for debian.diablo, and then run dpkg-buildpackage command, but I got a build error because the symbolic link was deleted. ===

When running dpkg-buildpackage, all symbolic links will be deleted, so need to rename the folder from debian.diablo to debian to make a build of diablo Qt package.

=== I installed Qt (libqt4-dev) to scratchbox and tried to build a sample application, but I got the error because some header files such as qhildonstyle.h, and qvfbhdr.h etc. were missing. ===

libqt4-dev should copy all header files, but now, at least in 4.5.2-1maemo1, some files are missing. Please download file below and extract to your scratchbox system.

http://qt4.garage.maemo.org/patches/qt4-missing-header.tgz

===Installing Qt on N900===
If you have already a fremantle device then you can install new Qt packages from extras-devel.
The step to follow are:
* Free space
* echo "deb http://repository.maemo.org/extras-devel/ fremantle free non-free
" >> /etc/apt/sources.list.d/hildon-application-manager.list
* apt-get install libqt4-gui
The basic packages will be so installed.

Current known issues:
*  libqt4-opengl depends by libgles2, but it is not installable anymore.Has it been replaced with libgles2-sgx-img?

===Where are the Hildon Widgets for Qt===
Short answer : they've not been written.... yet.

Qt allows you to create your own widgets very easily. However, in order to provide as consistent an appearance as possible for the Maemo platform the community will be creating a set of [[/Qt Hildon Widgets|Qt Hildon Widgets]]

===Is it yet possible to create Fremantle desktop widgets using Qt?===
Since desktop applet are libraries (.so files) then it's not so simple making Qt desktop applet.

At moment I didn't investigate for a solution.. but it's possible (I tried it) to put Qt Widgets into the desktop just changing the Window Type of the widget (eg a QDialog) with the right Window Type.

Then a Qt application can put widgets in the hildon-desktop but the "applet manager" that loads the desktop widgets doesn't recognize them as applet, then it doesn't manage Qt home applets.

== How to minimize a Qt application? ==
 QDBusConnection c = QDBusConnection::sessionBus();
 QDBusMessage m = QDBusMessage::createSignal("/","com.nokia.hildon_desktop","exit_app_view");
 c.send(m);

== References ==

[[Category:Development]]
[[Category:Qt]]

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Templates used on this page:

Template:Main (view source) (protected)

Retrieved from "https://wiki.maemo.org/Qt4_Hildon_Legacy"

Personal tools

Navigation

Views

Editing Qt4 Hildon Legacy

@@ Line 1: / Line 1: @@
-== Introduction ==
+[[Image:MaemoQtPicture.png]]
+<br><br>
+== [[Image:Intro.png]] Intro ==
-To develop with [[Qt-Maemo|Qt for Maemo]], a working SDK installation is required. There are [[Documentation/Maemo_5_Final_SDK_Installation|instructions on how to install the Maemo SDK]], and you can [http://www.youtube.com/watch?v=c8myh_iBy8k watch the Maemo SDK in action]. Alternatively, you may want to try [[MADDE]], a cross-platform Maemo development tool, available as a technology preview.
+=== Maemo Platform ===
-== Maemo platform ==
+The Maemo Platform is the software stack for Nokia Internet Tablets, which includes the Maemo operating system and the Maemo SDK. The Maemo Platform is mostly based on open source code, and has been developed by the Maemo Software department within Nokia in collaboration with many open source projects such as the Linux kernel, Debian, and GNOME.<ref>[http://en.wikipedia.org/wiki/Maemo_Platform Maemo Platform on Wikipedia]</ref>
-The Maemo platform is the software stack for Nokia Internet Tablets, which includes the Maemo operating system and the Maemo SDK. The Maemo Platform is mostly based on open source code, and has been developed by the Maemo Software department within Nokia in collaboration with many open source projects such as the Linux kernel, Debian, [[Hildon]] and GNOME.
+[http://maemo.org/intro/platform/ Read more...]
-Read more about [http://maemo.org/intro/platform/ the Maemo platform] and a [http://maemo.org/intro/developer_overview/ developer overview].
+=== What is Hildon? ===
-== Getting started ==
+Hildon is an application framework for Linux operating system mobile devices (PDAs, mobile phones, etc), developed by Nokia for Maemo and now a part of GNOME, that focuses on providing a finger friendly interface.<ref>[http://en.wikipedia.org/wiki/Hildon Hildon on Wikipedia]</ref>
-To start to develop with Maemo Qt, we need to [[Documentation/Maemo_5_Final_SDK_Installation|install the Maemo SDK]].
+[http://live.gnome.org/Hildon Read more...]
-=== Installing Qt packages in Scratchbox ===
+=== Developing on Maemo ===
-Maemo Qt developers offers a set of Qt packages for [[Open development/Maemo roadmap/Fremantle|Fremantle]] (Maemo5 - OS2009) and [[Open development/Maemo roadmap/Diablo|Diablo]] (Maemo4.1 - OS2008).
-=== Fremantle ===
+Developing applications for Maemo is done with the Maemo SDK. The process from creating the first prototype of your application to distributing to a wide audience consists basically of three steps:
-You do not need to add any extra repository for Fremantle since Qt packages are already available in the SDK. You can install Qt with the command:
- fakeroot apt-get install libqt4-dev
-==== Using Qt 4.6 in Fremantle ====
+* Share your application project in the [http://garage.maemo.org Garage].
+* Make your application easy to install and put in the [[Extras]].
+* Once your application has a high quality - be promoted to the [http://www.nokia.com/os2008 Nokia user site].
-Since the [[Maemo 5/PR1.2|PR1.2]] release Qt 4.6 is available in public Fremantle repository. To upgrade older Scratchbox targets to use the latest packages execute the following commands:
+[http://maemo.org/intro/developer_overview/ Read more...]
- fakeroot apt-get update
- fakeroot apt-get dist-upgrade
-=== Diablo ===
+=== Maemo SDK ===
-Diablo Qt packages are into the official [[Extras]] repository. In order to start to develop with those packages you need to [[Extras#Diablo|add extras repository to your repository list]], and then install Qt packages in the terminal:
- apt-get install libqt4-dev
-==How to compile a Qt application in scratchbox==
+The Maemo SDK is based around the Debian-oriented Scratchbox Cross Compilation Toolkit, which provides a sandbox environment in which development may take place. Scratchbox uses Qemu to emulate an ARMEL processor or sbrsh to remotely execute instructions. Scratchbox-compatible rootstraps are available for both x86 and ARMEL, so the majority of development and debugging takes place on x86, with final packaging being for ARMEL.<ref>[http://en.wikipedia.org/wiki/Maemo_Platform#Maemo_SDK Maemo SDK on Wikipedia]</ref>
-Qt applications are usually built using QMake. Project like KDE instead replaced QMake with CMake for more flexibility.
-=== QMake ===
-[http://doc.trolltech.com/4.5/qmake-manual.html QMake] is a tool from Trolltech that helps simplify the build process for development project across different platforms
-You can build your Maemo Qt application in 3 simple steps:
+[http://www.youtube.com/watch?v=c8myh_iBy8k Watch the Maemo SDK in action!]
-# Generating project file (Required if there is no .pro file into the app source tree)<pre>qmake -project</pre>
-# Generating Makefile from the QMake project file:<pre>qmake file.pro</pre>
-# <pre>make</pre>
-=== CMake ===
+=== What is Scratchbox? ===
-Because of some issue with [http://www.cmake.org/ CMake], [[Open development/Maemo roadmap/Diablo|Diablo]] CMake packages are currently useless since CMake segfaults (on the device at least). This issue has been solved in [[Open development/Maemo roadmap/Fremantle|Fremantle]] and CMake packages that comes from Fremantle SDK work nicely.
+Scratchbox is a cross compilation toolkit designed to make embedded Linux application development easier. It also provides a full set of tools to integrate and cross compile an entire Linux distribution.<ref>[http://en.wikipedia.org/wiki/Scratchbox Scratchbox on Wikipedia]</ref>
-CMake projects usually have a <code>CMakeLists.txt</code> file instead of:
+[http://www.scratchbox.org/ Read more...]
-# .pro file used by QMake projects
-# <code>Makefile.am</code> used by Autotools projects (standard in Unix/Linux)
-Using CMake to build the project is extremely easy. In the directory containing CMakeLists.txt, supply the following two commands, where path is the path to the source code.
+<br>
- cmake path
- make
-Note: CMake is not installed by default in [[:Category:Scratchbox|scratchbox]]. You can install it with the command:
+== [[Image:Rocket.png]] Getting started ==
- fakeroot apt-get install cmake
-== Running a Qt application in: ==
+To start to develop with Maemo Qt, we need to install the Maemo SDK on a Linux machine.
-=== Scratchbox ===
-Diablo and Fremantle Qt applications can run on the device as in Scratchbox.
-First step to run a Qt application is starting the SDK UI:
+=== Hey, I don't have a Linux machine! ===
+That's not a big problem. You can run Maemo SDK in a virtual machine;
-# Run Xephyr. It is able to run a [[:wikipedia:X_Window_System| X Server]] inside another X Server.<pre>Xephyr :2 -host-cursor -screen 800x480x16 -dpi 96 -ac -kb</pre>
+You can download Maemo SDK virtual Image (Linux Ubuntu + Diablo and Fremantle SDK)
-# Set display for application that runs inside scratchbox:<pre>export DISPLAY=:2</pre>
+from [http://tablets-dev.nokia.com/maemo-dev-env-downloads.php tablets-dev.nokia.com].
-# You can now run the SDK UI. A Diablo or Fremantle desktop will appear in your Xephyr window:<pre>af-sb-init.sh start</pre>
+You can get VMPlayer from [http://www.vmware.com/products/player/ here].
-# Now you are ready to run any Maemo or Maemo Qt application with:<pre>run-standalone.sh ./qtapps</pre>
-Note: <code>run-standalone.sh</code> sets some variable needed by Qt to use the Hildon style.
+=== Installing the Maemo SDK ===
+Maemo SDK can be installaed in any Linux environment.
+However Debian based distros (eg: Ubuntu) are recommended.
-=== Device ===
+Documentation you need to install Maemo SDK is [http://maemo.org/development/sdks/ here].
-Maemo Qt applications are Linux binaries. They can run on the device without any problem if you copy them to "partitions" mounted with exec flag. (for example, <code>/home/user</code> or <code>/opt</code> in Fremantle).
-Fore example, if we want to run quassel (Qt IRC Client) we have to launch it with:
+=== Installing Qt packages in Scratchbox ===
- su -c ./quassel user
+Maemo Qt developers offers a set of Qt packages for Diablo (Maemo4.1 - OS2008)
+and Fremantle (Maemo5 - OS2009).
-== Porting Qt applications to Maemo ==
+==== Diablo ====
+Diablo Qt packages are into the official Extras repository.
+In order to start to develop with those packages you need to add
+extras repository to your repository list.
-Porting a Qt desktop application to Maemo requires very little effort. This is because the Maemo Qt libraries will take care of giving the Hildon look & Feel and enabling the virtual input methods for your application.
+. Open /etc/apt/source.list with a text editor (eg: kate, gedit...)
+. Append the following line to that file:
+     deb http://repository.maemo.org/extras/ diablo free non-free
+. Then update your APT cache with
+      <i>apt-get update</i>
+. Install Qt packages with
+      <i>apt-get install libqt4-dev</i>
-===Overriding the Qt Maemo changes===
+==== Fremantle ====
+You don't need to add any extra repository for Fremantle since Qt packages are already available into the SDK.
-====Maemo Style====
+Then you can install Qt with:
+ fakeroot apt-get install libqt4-gui libqt4-dev
-Hildon Style is the default Qt application style. Other style available are:
+===How to compile a Qt application in scratchbox===
-* [http://doc.trolltech.com/4.5/gallery-cleanlooks.html QCleanLooks]
-* [http://doc.trolltech.com/4.5/gallery-windows.html Windows]
-* [http://doc.trolltech.com/4.5/gallery-plastique.html Plastique]
-Qt application can use other Qt styles;
+All the Qt tools you need are available in scratchbox. In order to compile a Qt application you need to follow the
-* Running your application with the style flag:
+standard Qt way:
- ./qt-test-application -style windows
-* Using [http://doc.trolltech.com/4.5/qapplication.html#setStyle QApplication::setStyle( QStyle * style )]
+ qmake -project
+ qmake file.pro
+ make
-* If you want to change the style of a widget:[http://doc.trolltech.com/4.5/qwidget.html#setStyle QWidget::setStyle( QStyle * style )]
+===Running a Qt application in scratchbox===
+You can run a Qt application in both the target supported by scratchbox (ARMEL, X86).
+However using the X86 target is recommended.
-====Showing the status bar====
+Before running the application you have to start Xephyr outside Scratchbox with the following parameters:
+ $ Xephyr :2 -host-cursor -screen 800x480x16 -dpi 96 -ac -kb
-Hildon applications don't have a status bar. Qt for Maemo hides the status bar by default.
+In the Scratchbox environment the DISPLAY variable has to be set so that it matches the display setting given above for the Xephyr server (parameter :2 in the above example).
-You can show it again by using method ''statusBar()->show()'' in your class derived from QMainWindow.
+ [sbox-DIABLO_<target>:~] > export DISPLAY=:2
-====Using the Kinetic Finger Scrolling (cf Gtk's PannableArea)====
+After the Xephyr server is running on the Linux host, you can start the Hildon Application Framework with the following command:
-See [[Qt/Finger Scrolling|Finger Scrolling]]
+ [sbox-DIABLO_<target>:~] > af-sb-init.sh start
-===Adding Maemo changes to a Qt Application===
+This should start the Hildon Application Framework inside the Xephyr window.
-Some methods of Qt for Maemo are not available in the "standard" Qt libs, so a Qt application with specific Maemo Qt code can't be built outside the Maemo SDK. To avoid this issue, the developer can use the preprocessor directives, for example with Qt 4.5 on Diablo and Fremantle:
+Now we are ready to run an application in scratchbox:
-<source lang="cpp-qt">
+ [sbox-DIABLO_<target>:~] > run-standalone.sh ./qtapps
-#ifdef Q_WS_HILDON
-   //Specific hildon/Maemo5 code here
-#endif
-</source>
-Qt project files can load hildon files using: (check [http://doc.trolltech.com/4.5/qmake-function-reference.html qmake ref guide] for more info about qmake options)
+===Running a Qt application on the device===
- contains(QT_CONFIG, hildon): {
-    message("Hello Hildon")
-    SOURCE += hildon.cpp
-    HEADER += hildon.h
-    FORMS   += hildon.ui
-}
-=== Home widget interaction ===
+To run a Qt application into the device, we need to copy it there.
-{{main|Qt4 and Hildon home widget interaction}}
+====Installing OpenSSH server on the device====
-===Limitations===
+To install and run applications on the device, we'll need to install an [[SSH]] server.
-Currently Qt Maemo lacks full support for Hildon widgets introduced in Maemo 5.
+* Open the Application Manager.
+* Make sure [[Extras]] is enabled.
+* Install openssh-server from the list.
-'''At the moment, creating a Qt application that follows Maemo 5 UI Style requires using custom Qt widgets, coded within the application itself'''.
+====Setting up a network connection====
-There is work ongoing to provide Qt Hildon widgets for Maemo 5, see [[Qt4_Hildon/Qt_Hildon_Widgets|Qt Hildon Widgets]]
+We can connect to device to our working machine via WLAN or USB. Connecting the device to a WLAN is quite easy, but [[USB networking]] is more difficult to set up.
-To get the benefits of the ongoing Maemo 5 hildon integration work in Qt, you must get the latest Qt source code and compile it yourself. See [[Qt4_Hildon#Building_Qt_from_GIT_rep|Building Qt from GIT repository]].
+====Using scp to copy the excutable on the device====
-== Debugging a Qt application ==
+[http://en.wikipedia.org/wiki/Secure_copy scp] or secure copy is a common Linux application. It can copy files or a directories over a secure connection. To copy our application on the device we just need to run it with a syntax like this:
-{{main|Documentation/Maemo_5_Developer_Guide/Kernel_and_Debugging_Guide/Maemo_Debugging_Guide}}
+ PC_$> scp qtApplication root@DEVICE-IP:/home/user
-'''Note''': Fremantle Gdb 6.8 crashes in x86 and gives messed up backtraces on the device. Using gdb 7.0 is recommended. You can get gdb 7.0 sources from http://ftp.de.debian.org/debian/pool/main/g/gdb/gdb_7.0.orig.tar.gz, compile it (./configure && make) inside X86 and armel scratchbox targets.
+====Executing the application====
-[http://chaos.troll.no/~harald/gdb7/ Here you can find GDB7 for fremantle x86 and armel].
- /usr/local/bin/gdb7 ./myapp
-== Profiling a Qt application ==
+Now that the application has been copied onto the device, we can run it. For that we need to open the terminal or we can use ssh from our PC.
-=== OProfile ===
+ PC_$> ssh root@DEVICE-IP
+ N810_#> su - user
+ N810_$> ./qtApplication
-{{main|Documentation/devtools/maemo5/oprofile}}
+<br>
+<br>
-=== Valgrind ===
+== [[Image:Hammer.png]] Porting a Qt application to Maemo ==
-{{main|Documentation/devtools/maemo5/valgrind}}
+===Intro===
-== Packaging a Qt application for Maemo ==
+Porting a Qt desktop application to Maemo requires very little effort. This because the Maemo Qt libraries will take care of giving the Hildon look & Feel and enabling the virtual input methods for your application.
-{{main|Packaging a Qt application}}
+===Overriding the Qt Maemo changes===
-== Maemo Qt API Reference ==
+====Maemo Style====
-Maemo Qt is based on Qt for X11. It shares same APIs avoiding API breaks. In this way every Qt application that runs in other platforms (Windows, Mac OS X, Linux, S60, etc.) can run in Maemo devices as well. To Develop a Qt application you can use the [http://doc.trolltech.com/4.5/index.html Official Qt 4.5 API documentation] and the list below to see what are the Maemo changes.
+The Maemo style is the default style of Qt applications on Maemo. The other styles available in Qt 4.4 Maemo are [http://doc.trolltech.com/4.4/gallery-cleanlooks.html QCleanLooks], [http://doc.trolltech.com/4.4/gallery-windows.html Windows] and [http://doc.trolltech.com/4.4/gallery-plastique.html Plastique] (It will be available in the next release of Qt).
-===Diablo===
+You can force your application to use another style in several ways:
-'''QString QDesktopServices::storageLocation(StandardLocation type)''' returns specific Maemo locations for these types:
+* Running your application with the flag -style <style_name>
-* DesktopLocation:   QDir::homePath() + QLatin1String("/MyDocs"),            instead of QDir::homePath() + QLatin1String("/Desktop")
+<small>''HINT: You can put this flag in the Exec field of the desktop file that launch the application.''</small>
-* DocumentsLocation: QDir::homePath() + QLatin1String("/MyDocs/.documents"), instead of QDir::homePath() + QLatin1String("/MyDocs/.documents")
-* PicturesLocation:  QDir::homePath() + QLatin1String("/MyDocs/.images"),    instead of QDir::homePath() + QLatin1String("/Pictures")
-* MusicLocation:     QDir::homePath() + QLatin1String("/MyDocs/.sounds"),    instead of QDir::homePath() + QLatin1String("/Music")
-* MoviesLocation:    QDir::homePath() + QLatin1String("/MyDocs/.videos"),    instead of QDir::homePath() + QLatin1String("/MyDocs/.videos")
-'''QTabletEvents''' are able to get the pressure value from the touchscreen. The eventdeviceType is for the touchscreen is set to QTabletEvent::Stylus. QTabletEvents won't be used anymore in Fremantle
+ $> ./qt-test-application -style windows
-'''Finger poke''' is emulated in scratchbox by the Middle Mouse button (NOTE: There is no Fullscreen VKB in scratchbox)
+* If you want to change your code, you can use this static function:[http://doc.trolltech.com/4.4/qapplication.html#setStyle QApplication::setStyle( QStyle * style )]
-'''QInputEvents''' don't move the cursor.
+* If you want to change the style only for a particular widget, you can call this function in the widget constructor: [http://doc.trolltech.com/4.4/qwidget.html#setStyle QWidget::setStyle( QStyle * style )]
-It's mandatory to get working the HIM moving the cursor via QInputMethodEvents.
-Why is it mandatory?  Because if the user select text with the finger from the right to the left, we are able to remove the highlighted text, but the cursor will be moved on the last char instead to stay on the first one.
-To do that some changes has been added to some widget function like: ''widget::inputMethodEvent(QInputMethodEvent *e)''.
-Modifing that function in some custom widgets may be necessary. Don't reimplementing that function will break some fullscreen virtual keyboard features.
-'''Hardcoded Keys:'''
-In the QMainWindow:
-* F6 - Toggle fullscreen the application
-* F4 - Shows/Hides the application context menu
-* Zoom in  - is a standard [http://doc.trolltech.com/4.4/qkeysequence.html#StandardKey-enum key sequence] QKeySequence::ZoomIn
-* Zoom out - is a standard [http://doc.trolltech.com/4.4/qkeysequence.html#StandardKey-enum key sequence] QKeySequence::ZoomOut
-'''Input Method:'''
+====Showing the status bar====
-Maemo Qt uses the Hildon IM as default Input method. Each kind of widget can set the IM mode. This allows the input method to focus on the type of input that the application is expecting. Eg: spinboxes can receive only numeric characters (1-9).
-NOTE: Qt widgets like QTextEdit, QLineEdit... set the right input method mode automatically.
+Hildon applications don't have a status bar. Qt for Maemo hides the status bar by default.
+You can show it again by modifying your code.
-A developer can change it by using:
+TODO
-<source lang="cpp-qt">
-void QInputContext::setInputMode(int mode);
-</source>
-It will update immediately the Hildon Input method to use the selected IM mode.
-HIC Modes:
+====Using the Kinetic Finger Scrolling (cf Gtk's PannableArea)====
-* <code>HILDON_GTK_INPUT_MODE_ALPHA</code> 	alphabetical characters and whitespace
+See [[Qt/Finger Scrolling|Finger Scrolling]]
-* <code>HILDON_GTK_INPUT_MODE_NUMERIC</code> 	numbers 0-9 and the '-' character
-* <code>HILDON_GTK_INPUT_MODE_SPECIAL</code> 	special characters
-* <code>HILDON_GTK_INPUT_MODE_HEXA</code> 	hexadecimal characters; numbers 0-9, characters a-f, and A-F
-* <code>HILDON_GTK_INPUT_MODE_TELE</code> 	telephone numbers; numbers 0-9, whitespace, and the characters "pwPW/().-+*#?,"
-* <code>HILDON_GTK_INPUT_MODE_FULL</code> 	unrestricted entry mode, combination of the alpha, numeric and special modes.
-* <code>HILDON_GTK_INPUT_MODE_MULTILINE</code> 	the client contains multiple lines of text or accepts linebreaks in the input.
-* <code>HILDON_GTK_INPUT_MODE_INVISIBLE</code> 	do not echo or save the input in the IM when entering sensitive information such as passwords.
-* <code>HILDON_GTK_INPUT_MODE_AUTOCAP</code> 	automatically capitalize the first letter at the start of a sentence.
-* <code>HILDON_GTK_INPUT_MODE_DICTIONARY</code> 	enable predictive dictionaries and learning based on the input.
-Example:
+===Adding Maemo changes to a Qt Application===
-For a password field we need to set a specific IM mode:
-<source lang="cpp-qt">
-int mode = HILDON_GTK_INPUT_MODE_FULL | HILDON_GTK_INPUT_MODE_INVISIBLE
-QInputContext *qic = widget->inputContext();
-qic->setInputMode(mode);
-</source>
-If you are developing a Custom widget able to receive input text, you can instruct your widget to use the right IM Mode just returning the mode.
-- How does it work?
-The Hildon IM sends a XMessage to pop up the "Virtual Keyboard" (or better the Main HIM UI) when an input widget receive the focus. The IM before to raise the VKB, makes an inputMethodQuery to the widget retrieving the IM mode. If the developer of the custom widget doesn't set the mode property, the IM will use <code>HILDON_GTK_INPUT_MODE_FULL</code> (the default mode) for that widget.
-Setting the ImMode is quite easy. Check the code below for more understanding.
+Some methods of Qt for Maemo are not available in the "standard" Qt libs, so a Qt application with specific Maemo Qt code can't be built outside the Maemo SDK. To avoid this issue, the developer can use the preprocessor directives, for example:
-<source lang="cpp-qt">
-#ifdef Q_WS_HILDON
-#include <QInputContext>
-#endif
-QVariant QAbstractSpinBox::inputMethodQuery(Qt::InputMethodQuery query) const
+ #ifdef Q_WS_HILDON
-{
+    //Specific hildon code here
-  Q_D(const QAbstractSpinBox);
+ #endif
-  switch(query) {
-      case Qt::ImMode:{
-          int mode = HILDON_GTK_INPUT_MODE_NUMERIC;
-          return QVariant(mode);
-      }
-      default:
-          return d->edit->inputMethodQuery(query);
-  }
-}
-</source>
-==FREMANTLE (Qt 4.5)==
+===Limitations===
-===Kinetic scrolling===
+Currently Qt Maemo lacks full support for Hildon widgets introduced in Maemo 5.
-Kinetic scrolling is enabled by default in QListWidgets and is supported by any Qt widget that inherits QScrollArea.
+'''At the moment, creating a Qt application that follows Maemo 5 UI Style requires using custom Qt widgets, coded within the application itself'''.
-Any item view widgets (QTreeView/QTreeWidget, QListView, QTableView/QTableWidget...) can use fingerscroll if it has "FingerScrollable" dynamic property set to true.
-Eg:
-<source lang="cpp-qt">
-QTableWidget *table = new QTableWidget(this);
-table->setProperty("FingerScrollable", true);
-</source>
-NOTE: Available in Qt > 4.5.3-xxxxx-maemo4
-===Hildon-Desktop widgets===
+There is work ongoing to provide Qt Hildon widgets for Maemo 5, see [http://wiki.maemo.org/Qt4_Hildon/Qt_Hildon_Widgets Qt Hildon Widgets]
-{{main|Qt4 Hildon/Qt Hildon Widgets}}
+To get the benefits of the ongoing Maemo 5 hildon integration work in Qt, you must get the latest Qt source code and compile it yourself. See [http://wiki.maemo.org/Qt4_Hildon#Building_Qt_from_GIT_rep Building Qt from GIT repository].
-They are supported by Qt. An example (qt-example-hildondesktopwidget) is available in extras-devel.
+<br>
+<br>
-===Hildon menus===
+== [[Image:Bug.png]] Debugging a Qt application ==
-Maemo5 menus are created using QActions available in menu bar.
+===GDB ===
-Hidden, disabled, separators and widget actions won't shown. (Same in Qt 4.6)
-* qt-4.5.3-xxxx-maemo4 packages - needs QActions in a "fremantle" menu.
+====Intro ====
-* Pkgs > qt-4.5.3-xxxx-maemo4 shows Maemo5 menus automatically
-Note: Maemo5 policy doesn't allow application to have more than 10 items.
+The GNU Project Debugger, or gdb for short, is a general purpose debugger that can be used for various debugging purposes.
-===Stackable windows===
+====Debugging a Qt application in Scratchbox====
-http://maemomm.garage.maemo.org/docs/tutorial/figures/stackable-window.png
+TODO
-Are supported by Qt. To create them you need to create a MainWindow child of another Main window.
-<source lang="cpp-qt">
-QMainWindow *fistStackableWindow = new QMainWindow;
-QMainWindow *secondStackableWindow = new QMainWindow(fistStackableWindow);
-// you need the below line to see the back button on the top right hand corner of the stacked window instead of a cross
-secondStackableWindow->setAttribute(Qt::WA_Maemo5StackedWindow);
-</source>
-''Note: this is not entirely accurate, see''
-http://qt.nokia.com/doc/qt-maemo-4.6/maemo5-stackedwindows.html
+====Debugging a Qt application on device====
-===Raise a Qt application in background===
+<ol>
+<li>Installing gdb on the device.<ol>
+<li>Add the [http://maemo.org/development/tools/ SDK tools] repository to the catalogue list.</li>
+<li>install gdb by using apt-get (require around 6 MB of space)</li>
+</ol></li>
+<li>Install the debug symbols files in scratchbox (ARMEL target)</li>
+ apt-get install libqt4-dbg
+<li>Run the application (device side)</li>
+ $gdbserver 0.0.0.0:1234 ./qtApplication
+<li>Run the gdb client on your host PC (scratchbox side)</li>
+ [sbox-DIABLO_ARMEL: ~/TEST/svn/qt4-x11-4.4.0/examples/widgets/tablet] > gdb ./qtApplication
+<li>Set the target of gdb</li>
+ (gdb) target remote 172.21.37.117:1234
+<li>Tell to gdb to continue to debug the application on the device</li>
+ (gdb) continue
+<li>Wait some moments...</li>
+<li>If necessary you can put break points; eg: for void QWidget::setPalette ( const QPalette & )</li>
+ (gdb) break QWidget::setPalette(QPalette const&)
+ Breakpoint 1 at 0x4026ae68
-<code>QWidget::activateWindow()</code> does the job.
+<li>Your application will appear on the device screen. Happy debugging!</li></ol>
-Implemented in Qt packages >= qt-4.5.3-xxxx-maemo6
+===Links===
-=== How to minimize a Qt application? ===
+* [http://www.gnu.org/software/gdb/documentation/ GDB documentation & tutorials]
-<source lang="cpp-qt">
+* [http://maemo.org/development/documentation/man_pages/gdbserver/ GDBServer man page]
-QDBusConnection c = QDBusConnection::sessionBus();
+* [http://maemo.org/maemo_release_documentation/maemo4.1.x/node15.html Maemo debugging guide]
-QDBusMessage m = QDBusMessage::createSignal("/","com.nokia.hildon_desktop","exit_app_view");
+* [http://repository.maemo.org/pool/diablo/free/g/gdb/ gdb debian package for Diablo]
-c.send(m);
-</source>
-===Portrait mode and listening for orientation changes===
-If you want to run your application in portrait mode then you can add these lines to your application. The code goes in your main widget constructor.
+<br><br>
-<source lang="cpp-qt">
+== [[Image:chart.png]] Profiling a Qt application ==
-#ifdef Q_WS_HILDON
-//Includes for portrait mode support
-# include <X11/Xlib.h>
-# include <X11/Xatom.h>
-# include <QtGui/QX11Info>
-#endif
-#ifndef Q_WS_HILDON
+=== OProfile ===
-int value = 1;
-Atom portraitSupport = XInternAtom(QX11Info::display(), "_HILDON_PORTRAIT_MODE_SUPPORT", false);
-Atom portraitRequest = XInternAtom(QX11Info::display(), "_HILDON_PORTRAIT_MODE_REQUEST", false);
-XChangeProperty(QX11Info::display(), winId(), portraitSupport, XA_CARDINAL, 32, PropModeReplace, (uchar *)&value, 1);
-XChangeProperty(QX11Info::display(), winId(), portraitRequest, XA_CARDINAL, 32, PropModeReplace, (uchar *)&value, 1);
-#endif
-</source>
-If you want to listen for orientation changes and then switch the view to landscape or potrait mode automatically than take a look at [[Maemo Qt Extra Libraries]] for more information.
-=== QDockWidgets ===
+OProfile is a low overhead system-wide profiler for Linux. It can be used to find CPU usage bottlenecks in the whole system and within processes. It works fine in the device, but viewing the reports can take quite a long time (10 minutes) when fired up on N800/N810 devices. Therefore, it often makes sense to run opreport in scratchbox.
-QDockWidgets are not finger friendly widgets. They should not be used in Maemo.
+If you want to know more about OProfile in Maemo see the [http://maemo.org/development/tools/doc/chinook/oprofile/ documentation].
-In case you are porting an application to Maemo maybe you want to do
-few changes as possible into your UI. Then you could use QDockWidget::setFeatures(QDockWidget::NoDockWidgetFeatures); to hide float and close button and lock the position of the dock widget.
-=== QPrint* and QSystemTray support missing ===
+=== Valgrind ===
-Printing (QPrint*) and System tray support is missing in current Qt 4.5.3-xxxx-maemo4 packages. Since incompatibility with KDE and other Qt application, they will be enabled again in next Qt 4.5.3 packages.
+TODO
-=== QSplashScreen not fully compatible with Hildon-Desktop ===
+<br><br>
-QSplashScreen's window type is not supported in Fremantle. The splash screen is shown in full screen and the image is repeated to fill the splash screen's window. When splash screen is closed normal window closing animation is shown before showing the actual application window. For these reasons developers are disencouraged to use splash screens in their applications.
+== [[Image:chart.png]] Qt benchmarks ==
+D graphic benchmark tools:
-As a workaround for the problem you can set a window property that tells HD to skip the transitions:
+* [[Qt/Benchmark/qgear|QGears]]
-<source lang="cpp-qt">
+D graphic benchmark tools:
- static void set_no_transitions (Display *dpy, Window w)
- {
- Atom no_trans;
- int one = 1;
- no_trans = XInternAtom (dpy, "_HILDON_WM_ACTION_NO_TRANSITIONS", False);
- XChangeProperty (dpy, w, no_trans,
-                  XA_CARDINAL, 32, PropModeReplace,
-                  (unsigned char *)&one, 1);
- }
-</source>
-=== QToolBar limitations ===
+* TODO
+<br><br><br>
-Adding a QToolBar to a QMainWindow will always result in a toolbar at the bottom of the screen. (Justification/Workarounds?)
+== [[Image:package.png]] Packaging a Qt application for Maemo ==
-== Contributing to the Maemo Qt Project ==
+{{main|Packaging a Qt application}}
+<br><br>
+== [[Image:Helmet.png]] Maemo Qt API Reference ==
+Maemo Qt is based on Qt for X11. It shares the same API avoiding API breaks. In this way every Qt application that runs in other platforms (Windows, Mac OS X, Linux, S60, etc.) can run also into the Maemo devices. To Develop a Qt application you can use the [http://doc.trolltech.com/4.5/index.html Official Qt 4.5 API documentation] and the list below to see what are the Maemo changes.
+  '''QString QDesktopServices::storageLocation(StandardLocation type)''' returns specific Maemo locations for these types:
+  - DesktopLocation:   QDir::homePath() + QLatin1String("/MyDocs"),            instead of QDir::homePath() + QLatin1String("/Desktop")
+  - DocumentsLocation: QDir::homePath() + QLatin1String("/MyDocs/.documents"), instead of QDir::homePath() + QLatin1String("/MyDocs/.documents")
+  - PicturesLocation:  QDir::homePath() + QLatin1String("/MyDocs/.images"),    instead of QDir::homePath() + QLatin1String("/Pictures")
+  - MusicLocation:     QDir::homePath() + QLatin1String("/MyDocs/.sounds"),    instead of QDir::homePath() + QLatin1String("/Music")
+  - MoviesLocation:    QDir::homePath() + QLatin1String("/MyDocs/.videos"),    instead of QDir::homePath() + QLatin1String("/MyDocs/.videos")
+  '''QTabletEvents''' are able to get the pressure value from the touchscreen.
+   - The eventdeviceType is for the touchscreen is set to QTabletEvent::Stylus.
+   - QTabletEvents won't be used anymore in Fremantle
+  '''Finger poke''' is emulated in scratchbox by the Middle Mouse button (NOTE: There is no Fullscreen VKB in scratchbox)
+  '''QInputEvents''' don't move the cursor.
+  It's mandatory to get working the HIM moving the cursor via QInputMethodEvents.
+  Why is it mandatory?
+  Because if the user select text with the finger from the right to the left, we are able to remove the highlighted text, but the
+  cursor will be moved on the last char instead to stay on the first one.
+  To do that some changes has been added to some widget function like: ''widget::inputMethodEvent(QInputMethodEvent *e)''.
+  Modifing that function in some custom widgets may be necessary.
+  Don't reimplementing that function will break some fullscreen virtual keyboard features.
+  '''Hardcoded Keys:'''
+  In the QMainWindow:
+  - F6 - Toggle fullscreen the application
+  - F4 - Shows/Hides the application context menu
+  - Zoom in  - is a standard [http://doc.trolltech.com/4.4/qkeysequence.html#StandardKey-enum key sequence] QKeySequence::ZoomIn
+  - Zoom out - is a standard [http://doc.trolltech.com/4.4/qkeysequence.html#StandardKey-enum key sequence] QKeySequence::ZoomOut
+  '''Input Method:'''
+  Maemo Qt uses the Hildon IM as default Input method.
+  Each kind of widget can set the IM mode. This allows the input method to focus on the type of input that the application is expecting.
+  Eg: spinboxes can receive only numeric characters (1-9).
+  NOTE: Qt widgets like QTextEdit, QLineEdit... set the right input method mode automatically.
+  A developer can change it by using:
+    void QInputContext::setInputMode(int mode);
+  It will update immediately the Hildon Input method to use the selected IM mode.
+  HIC Modes:
+    HILDON_GTK_INPUT_MODE_ALPHA 	alphabetical characters and whitespace
+    HILDON_GTK_INPUT_MODE_NUMERIC 	numbers 0-9 and the '-' character
+    HILDON_GTK_INPUT_MODE_SPECIAL 	special characters
+    HILDON_GTK_INPUT_MODE_HEXA 	hexadecimal characters; numbers 0-9, characters a-f, and A-F
+    HILDON_GTK_INPUT_MODE_TELE 	telephone numbers; numbers 0-9, whitespace, and the characters "pwPW/().-+*#?,"
+    HILDON_GTK_INPUT_MODE_FULL 	unrestricted entry mode, combination of the alpha, numeric and special modes.
+    HILDON_GTK_INPUT_MODE_MULTILINE 	the client contains multiple lines of text or accepts linebreaks in the input.
+    HILDON_GTK_INPUT_MODE_INVISIBLE 	do not echo or save the input in the IM when entering sensitive information such as passwords.
+    HILDON_GTK_INPUT_MODE_AUTOCAP 	automatically capitalize the first letter at the start of a sentence.
+    HILDON_GTK_INPUT_MODE_DICTIONARY 	enable predictive dictionaries and learning based on the input.
+  Example:
+    For a password field we need to set a specific IM mode:
+    int mode = HILDON_GTK_INPUT_MODE_FULL | HILDON_GTK_INPUT_MODE_INVISIBLE
+    QInputContext qic = widget->inputContext();
+    qic->setInputMode(mode);
+  If you are developing a Custom widget able to receive input text, you can instruct your widget to use the right IM Mode just returning
+  the mode.
+  - How does it work?
+  The Hildon IM sends a XMessage to pop up the "Virtual Keyboard" (or better the Main HIM UI) when an input widget receive the focus.
+  The IM before to raise the VKB, makes an inputMethodQuery to the widget retrieving the IM mode.
+  If the developer of the custom widget doesn't set the mode property, the IM will use HILDON_GTK_INPUT_MODE_FULL (the default mode) for that widget.
+  Setting the ImMode is quite easy. Check the code below for more understanding.
+  #ifdef Q_WS_HILDON
+  #include <QInputContext>
+  #endif
+  QVariant QAbstractSpinBox::inputMethodQuery(Qt::InputMethodQuery query) const
+  {
+    Q_D(const QAbstractSpinBox);
+    switch(query) {
+        case Qt::ImMode:{
+            int mode = HILDON_GTK_INPUT_MODE_NUMERIC;
+            return QVariant(mode);
+        }
+        default:
+            return d->edit->inputMethodQuery(query);
+    }
+  }
+   '''QDialogs in fremantle.'''
+   The fremantle WM doesn't allow QDialogs without a parent (at least this is true for Qt apps).
+   A dialog without a parent won't be shown by the WM.
+   Eg:
+   This is what you MUST avoid.
+   QColorDialog::getColor ( Qt::white, 0 )
+   Remember to setup a parent
+   QColorDialog::getColor ( Qt::white, this )
+   '''QPrinter and QPrintDialog'''
+   Print support has been removed from Maemo Qt.
+   Application compiled with old libs are still binary compatible with the new libs but they crash when a removed component is called.
+   Nokia: /home/user# ./textedit
+./textedit: symbol lookup error: ./textedit: undefined symbol: _ZN8QPrinterC1ENS_11PrinterModeE
+   '''System tray support'''
+   System tray is not available anymore in Fremantle. That support has been removed from Qt too.
+   Hence QSystemTrayIcon class is not available anymore.
+<br><br>
+== [[Image:Helmet.png]] Contributing to the Maemo Qt Project ==
 Maemo Qt is a community project. Contributing to the forum, sending us patches, give us feedbacks, tracking bugs are all activities that help us to improve the quality of our work.
@@ Line 359: / Line 389: @@
 Here there is a list of things that every person interested in helping us should read.
-===Stay updated===
+===Be updated===
+Any Maemo Qt developer should be updated and should participate to the discussions, for that he must join the Mailing list.
-Any Maemo Qt developer should be updated and should participate to the discussions, for that he must join the Mailing list. BTW the mailing list is not for Maemo Qt Developers but it's open to Maemo Qt application developers too.
+BTW the mailing list is not for Maemo Qt Developers but it's open to Maemo Qt application developers too.
 === Introduction to Git ===
 If you are a git newbie you maybe find interesting these links:
 * http://www.sourcemage.org/Git_Guide
@@ Line 372: / Line 401: @@
 ===Understanding the structure of our Git repository===
+These info are here:[[Qt Maemo Git Process]].
-{{main|Qt Maemo Git Process}}
-=== Preparation ===
+=== Preparation ===
 Make sure each scratchbox target has
@@ Line 383: / Line 412: @@
 (you may need to apt-get install libgl-dev too as it's not in the Build-Depends: yet)
-===Building Qt from Git repository===
+===Building Qt from GIT rep===
-# Clone the repository:<pre>git clone git://gitorious.org/+qt-maemo-developers/qt/qt-maemo.git</pre>or if you are a member of our team:<pre>git clone git@gitorious.org:+qt-maemo-developers/qt/qt-maemo.git</pre>
+* Clone the repository:
-# Change dir:<pre>cd qt-maemo</pre>
+ git clone git://gitorious.org/+qt-maemo-developers/qt/qt-maemo.git
-# Copy the remote 4.5 branch in your working copy:<pre>git checkout -b 4.5 origin/4.5</pre>
+or if you are a member of our team:
-# Checkout ONE of these branches:<pre>git checkout -b qt-diablo origin/qt-diablo</pre><pre>git checkout -b qt-n900+w34 origin/qt-n900+w34</pre><pre>git checkout -b qt-mer origin/qt-mer</pre>
+ git clone git@gitorious.org:+qt-maemo-developers/qt/qt-maemo.git
-# Build the packages:<pre>dpkg-buildpackage -rfakeroot -b</pre>
+* Change dir
+ cd qt-maemo
+* Copy the remote 4.5 branch in your workingcopy
+ git checkout -b 4.5 origin/4.5
+* Checkout ONE of these branches:
+ git checkout -b qt-diablo    origin/qt-diablo
+ git checkout -b qt-n900 origin/qt-n900
+ git checkout -b qt-mer       origin/qt-mer
+* Build the packages:
+ dpkg-buildpackage -rfakeroot -b
+===Checking out all the remote branches===
+* Clone the repository:
+ git clone git://gitorious.org/+qt-maemo-developers/qt/qt-maemo.git
+or if you are a member of our team:
+ git clone git@gitorious.org:+qt-maemo-developers/qt/qt-maemo.git
+* Change dir
+ cd qt-maemo
+* Check out our script branch
+ git checkout -b maemo-qt-scripts origin/maemo-qt-scripts
+* Save a copy of the script outside the working directories
+ cp maemo-qt-scripts/copy-all-remote-branches-locally/copy.sh ../
+* Launch the copy.sh script
+ ../copy.sh
+===Commit changes in SVN [OLD]===
+If you are a Maemo Qt developer and you want to save your changes in the Garage SVN but your project is not ready to go to the main line (trunk/qt-x11), you should create a private branch and then work there until the merging with the mainline.
+For that you have to create a your directory in branches/ named ''developer_name-qt''. After that you can copy trunk/qt-x11 in your directory.
+ svn copy --username developer_name https://garage.maemo.org/svn/qt4/trunk/qt-x11 https://garage.maemo.org/svn/qt4/branches/developer_name-qt -m "Creating private branch of trunk/qt-x11"
+NOTE: Subversion uses cheap copy, so them don't increase the size of the repository. Then feel free to create your own branch.
 ===Merging branches changes in the mainline [OLD]===
 Before to merge your changes in the mainline, the code must be full working, cleaned and tested. A review from another developer is also needed in order to reduce the possibility to add errors.
+<br><br>
+==[[Image:Help-contents.png]] F.A.Q.==
+=== I'm trying to compile a Qt application for ARMEL, but I got the error below. What's wrong? ===
+ /targets/FREMANTLE_X86/usr/include/qt4/QtCore/qatomic_i386.h:127: error: impossible constraint in 'asm'
+You are using x86 include files, then you have to update your Makefile. Running <code>qmake</code> before <code>make</code> will be solve this issue.
+=== I'm trying to compile a Qt packcage for x86, but I got the error below. What's wrong? ===
+ In file included from maemo/gconfsymbols.cpp:41:
+ maemo/gconfsymbols_p.h:49:25: gconf/gconf.h: No such file or directory
+Your scratchbox does not have <code>/bin/sh</code>, so when calling <code>pkg-config</code> from <code>qmake</code>, <code>CFLAGS</code> and <code>LIBS</code> are not set correctly. Running <code>ln -s /scratchbox/tools/bin/sh /bin/sh</code> will be solve this issue.
+=== I'm trying to compile a diablo Qt package, so I just created a symbolic link, debian, for debian.diablo, and then run dpkg-buildpackage command, but I got a build error because the symbolic link was deleted. ===
+When running dpkg-buildpackage, all symbolic links will be deleted, so need to rename the folder from debian.diablo to debian to make a build of diablo Qt package.
+=== I installed Qt (libqt4-dev) to scratchbox and tried to build a sample application, but I got the error because some header files such as qhildonstyle.h, and qvfbhdr.h etc. were missing. ===
+libqt4-dev should copy all header files, but now, at least in 4.5.2-1maemo1, some files are missing. Please download file below and extract to your scratchbox system.
+http://qt4.garage.maemo.org/patches/qt4-missing-header.tgz
+===Installing Qt on N900===
+If you have already a fremantle device then you can install new Qt packages from extras-devel.
+The step to follow are:
+* Free space
+* echo "deb http://repository.maemo.org/extras-devel/ fremantle free non-free
+" >> /etc/apt/sources.list.d/hildon-application-manager.list
+* apt-get install libqt4-gui
+The basic packages will be so installed.
+Current known issues:
+*  libqt4-opengl depends by libgles2, but it is not installable anymore.Has it been replaced with libgles2-sgx-img?
+===Where are the Hildon Widgets for Qt===
+Short answer : they've not been written.... yet.
+Qt allows you to create your own widgets very easily. However, in order to provide as consistent an appearance as possible for the Maemo platform the community will be creating a set of [[/Qt Hildon Widgets|Qt Hildon Widgets]]
+===Is it yet possible to create Fremantle desktop widgets using Qt?===
+Since desktop applet are libraries (.so files) then it's not so simple making Qt desktop applet.
-===QML===
+At moment I didn't investigate for a solution.. but it's possible (I tried it) to put Qt Widgets into the desktop just changing the Window Type of the widget (eg a QDialog) with the right Window Type.
-[[QML]] is a GUI interface building scripting language for Qt. Check out the [[QML-EnhancedCalcExample | QML calculator example]].
-==F.A.Q.==
+Then a Qt application can put widgets in the hildon-desktop but the "applet manager" that loads the desktop widgets doesn't recognize them as applet, then it doesn't manage Qt home applets.
-; ''I'm trying to compile a Qt application for ARMEL, but I got the error below. What's wrong?''
-: <pre>/targets/FREMANTLE_X86/usr/include/qt4/QtCore/qatomic_i386.h:127: error: impossible constraint in 'asm'</pre>
-:You are using x86 include files, then you have to update your Makefile. Running <code>qmake</code> before <code>make</code> will be solve this issue.
-; I'm trying to compile a Qt packcage for x86, but I got the error below. What's wrong?
+== How to minimize a Qt application? ==
-: <pre>In file included from maemo/gconfsymbols.cpp:41:
+ QDBusConnection c = QDBusConnection::sessionBus();
-  maemo/gconfsymbols_p.h:49:25: gconf/gconf.h: No such file or directory</pre>
+  QDBusMessage m = QDBusMessage::createSignal("/","com.nokia.hildon_desktop","exit_app_view");
-: Your scratchbox does not have <code>/bin/sh</code>, so when calling <code>pkg-config</code> from <code>qmake</code>, <code>CFLAGS</code> and <code>LIBS</code> are not set correctly. Running <code>ln -s /scratchbox/tools/bin/sh /bin/sh</code> will be solve this issue.
+ c.send(m);
-; I'm trying to compile a diablo Qt package, so I just created a symbolic link, debian, for debian.diablo, and then run dpkg-buildpackage command, but I got a build error because the symbolic link was deleted
+== References ==
-: When running dpkg-buildpackage, all symbolic links will be deleted, so need to rename the folder from debian.diablo to debian to make a build of diablo Qt package.
-; I installed Qt (libqt4-dev) to scratchbox and tried to build a sample application, but I got the error because some header files such as qhildonstyle.h, and qvfbhdr.h etc. were missing
+<references/>
-: libqt4-dev should copy all header files, but now, at least in 4.5.2-1maemo1, some files are missing. Please download file below and extract to your scratchbox system.
-: <pre>http://qt4.garage.maemo.org/patches/qt4-missing-header.tgz</pre>
 [[Category:Development]]
 [[Category:Qt]]