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.

== Introduction ==

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 ==

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.

Read more about [http://maemo.org/intro/platform/ the Maemo platform] and a [http://maemo.org/intro/developer_overview/ developer overview].

== Getting started ==

To start to develop with Maemo Qt, we need to [[Documentation/Maemo_5_Final_SDK_Installation|install the Maemo SDK]].

=== Installing Qt packages in Scratchbox ===
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 ===
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 ====

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:
 fakeroot apt-get update
 fakeroot apt-get dist-upgrade

=== Diablo ===
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==
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:
# 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 ===

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.

CMake projects usually have a <code>CMakeLists.txt</code> file instead of: 
# .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.
 cmake path
 make

Note: CMake is not installed by default in [[:Category:Scratchbox|scratchbox]]. You can install it with the command:
 fakeroot apt-get install cmake

== Running a Qt application in: ==
=== 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:
 
# 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>
# Set display for application that runs inside scratchbox:<pre>export DISPLAY=:2</pre>
# 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>
# 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.

=== Device ===
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:
 su -c ./quassel user

== Porting Qt applications to Maemo ==

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.

===Overriding the Qt Maemo changes===

====Maemo Style====

Hildon Style is the default Qt application style. Other style available are:
* [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;
* Running your application with the style flag:
 ./qt-test-application -style windows

* Using [http://doc.trolltech.com/4.5/qapplication.html#setStyle QApplication::setStyle( QStyle * style )]

* If you want to change the style of a widget:[http://doc.trolltech.com/4.5/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 using method ''statusBar()->show()'' in your class derived from QMainWindow.

====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 with Qt 4.5 on Diablo and Fremantle:

<source lang="cpp-qt">
#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)
 contains(QT_CONFIG, hildon): {
    message("Hello Hildon")
    SOURCE += hildon.cpp
    HEADER += hildon.h
    FORMS   += hildon.ui
}

=== Home widget interaction ===

===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 [[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 [[Qt4_Hildon#Building_Qt_from_GIT_rep|Building Qt from GIT repository]].

== Debugging a Qt application ==

{{main|Documentation/Maemo_5_Developer_Guide/Kernel_and_Debugging_Guide/Maemo_Debugging_Guide}}

'''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.
[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 ==

=== 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 ===

== Packaging a Qt application for Maemo ==

== Maemo Qt API Reference ==

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.

===Diablo===

'''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:
<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:
* <code>HILDON_GTK_INPUT_MODE_ALPHA</code> 	alphabetical characters and whitespace
* <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:
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.
<source lang="cpp-qt">
#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);
  }
}
</source>

==FREMANTLE (Qt 4.5)==

===Kinetic scrolling===

Kinetic scrolling is enabled by default in QListWidgets and is supported by any Qt widget that inherits QScrollArea.
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===

They are supported by Qt. An example (qt-example-hildondesktopwidget) is available in extras-devel.

===Hildon menus===

Maemo5 menus are created using QActions available in menu bar. 
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.
* Pkgs > qt-4.5.3-xxxx-maemo4 shows Maemo5 menus automatically

Note: Maemo5 policy doesn't allow application to have more than 10 items.

===Stackable windows===

http://maemomm.garage.maemo.org/docs/tutorial/figures/stackable-window.png
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

===Raise a Qt application in background===

<code>QWidget::activateWindow()</code> does the job.

Implemented in Qt packages >= qt-4.5.3-xxxx-maemo6

=== How to minimize a Qt application? ===
<source lang="cpp-qt">
QDBusConnection c = QDBusConnection::sessionBus();
QDBusMessage m = QDBusMessage::createSignal("/","com.nokia.hildon_desktop","exit_app_view");
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.
<source lang="cpp-qt">
#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
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 ===

QDockWidgets are not finger friendly widgets. They should not be used in Maemo.
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 ===

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.

=== QSplashScreen not fully compatible with Hildon-Desktop ===

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.

As a workaround for the problem you can set a window property that tells HD to skip the transitions:
<source lang="cpp-qt">
 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 ===

Adding a QToolBar to a QMainWindow will always result in a toolbar at the bottom of the screen. (Justification/Workarounds?)

== 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.

===Stay 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===

=== 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 repository===

# 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>
# Change dir:<pre>cd qt-maemo</pre>
# Copy the remote 4.5 branch in your working copy:<pre>git checkout -b 4.5 origin/4.5</pre>
# 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>
# Build the packages:<pre>dpkg-buildpackage -rfakeroot -b</pre>

===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.

===QML===
[[QML]] is a GUI interface building scripting language for Qt. Check out the [[QML-EnhancedCalcExample | QML calculator example]].

==F.A.Q.==

; ''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?
: <pre>In file included from maemo/gconfsymbols.cpp:41:
 maemo/gconfsymbols_p.h:49:25: gconf/gconf.h: No such file or directory</pre>
: 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.
: <pre>http://qt4.garage.maemo.org/patches/qt4-missing-header.tgz</pre>

[[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 150: / Line 150: @@
 === OProfile ===
-{{main|Documentation/devtools/maemo5/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 ===