Qt4 Hildon Legacy

(Limitations)
(add Qt syntax highlighting, use <code>)
 
(128 intermediate revisions not shown)
Line 1: Line 1:
-
[[Image:MaemoQtPicture.png]]
+
== Introduction ==
-
<br><br>
+
-
== [[Image:Intro.png]] Intro ==
+
-
=== Maemo Platform ===
+
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.
-
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>
+
== Maemo platform ==
-
[http://maemo.org/intro/platform/ Read more...]
+
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.
-
=== What is Hildon? ===
+
Read more about [http://maemo.org/intro/platform/ the Maemo platform] and a [http://maemo.org/intro/developer_overview/ developer overview].
-
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>
+
== Getting started ==
-
[http://live.gnome.org/Hildon Read more...]
+
To start to develop with Maemo Qt, we need to [[Documentation/Maemo_5_Final_SDK_Installation|install the Maemo SDK]].
-
=== Developing on Maemo ===
+
=== 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).
-
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:
+
=== 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
-
* Share your application project in the [http://garage.maemo.org Garage].
+
==== Using Qt 4.6 in Fremantle ====
-
* 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...]
+
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
-
=== Maemo SDK ===
+
=== 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
-
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>
+
==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
-
[http://www.youtube.com/watch?v=c8myh_iBy8k Watch the Maemo SDK in action!]
+
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>
-
=== What is Scratchbox? ===
+
=== CMake ===
-
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>
+
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.
-
[http://www.scratchbox.org/ Read more...]
+
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)
-
<br>
+
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
-
== [[Image:Rocket.png]] Getting started ==
+
Note: CMake is not installed by default in [[:Category:Scratchbox|scratchbox]]. You can install it with the command:
 +
fakeroot apt-get install cmake
-
To start to develop with Maemo Qt, we need to install the Maemo SDK on a Linux machine.
+
== Running a Qt application in: ==
 +
=== Scratchbox ===
 +
Diablo and Fremantle Qt applications can run on the device as in Scratchbox.
-
=== Hey, I don't have a Linux machine! ===
+
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>
-
That's not a big problem. [http://maemovmware.garage.maemo.org/ Maemo SDK Virtual Image project] provides a virtual development image for the Maemo platform that can be used with [http://www.vmware.com/products/player/ VMPlayer].
+
Note: <code>run-standalone.sh</code> sets some variable needed by Qt to use the Hildon style.
-
=== Installing the Maemo SDK ===
+
=== 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).
-
See the [http://maemo.org/development/sdks/ SDK documentation] for details on installing the SDK.
+
Fore example, if we want to run quassel (Qt IRC Client) we have to launch it with:
 +
su -c ./quassel user
-
If you are on a non-debian system such as openSUSE you might need to perform the following command
+
== Porting Qt applications to Maemo ==
-
in another shell prior to logging in in order to get ARM CPU emulation working:
+
-
sudo /scratchbox/sbin/sbox_ctl start
+
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.
-
=== Installing the Qt packages in Scratchbox ===
+
===Overriding the Qt Maemo changes===
-
After Scratchbox and the SDK are installed and working, you need to login, add the [[Extras]] and [[Extras#Extras-devel|Extras-devel]] repositories to your apt-get sources and install the Qt libs. Paste this into your Scratchbox shell (without the ">" prompt):
+
====Maemo Style====
-
==== Diablo ====
+
Hildon Style is the default Qt application style. Other style available are:
-
> echo "# Maemo extras and extras-devel
+
* [http://doc.trolltech.com/4.5/gallery-cleanlooks.html QCleanLooks]
-
deb http://repository.maemo.org/extras/ diablo free non-free
+
* [http://doc.trolltech.com/4.5/gallery-windows.html Windows]
-
deb-src http://repository.maemo.org/extras/ diablo free
+
* [http://doc.trolltech.com/4.5/gallery-plastique.html Plastique]
-
deb http://repository.maemo.org/extras-devel/ diablo free non-free
+
-
deb-src http://repository.maemo.org/extras-devel/ diablo free" > /etc/apt/sources.list.d/qt.list
+
-
==== Fremantle ====
+
Qt application can use other Qt styles;
-
> echo "# Maemo extras and extras-devel
+
* Running your application with the style flag:
-
deb http://repository.maemo.org/extras/ fremantle free non-free
+
  ./qt-test-application -style windows
-
  deb-src http://repository.maemo.org/extras/ fremantle free
+
-
deb http://repository.maemo.org/extras-devel/ fremantle free non-free
+
-
deb-src http://repository.maemo.org/extras-devel/ fremantle free" > /etc/apt/sources.list.d/qt.list
+
 +
* Using [http://doc.trolltech.com/4.5/qapplication.html#setStyle QApplication::setStyle( QStyle * style )]
-
Then run these commands to update the catalog and install Qt libraries:
+
* If you want to change the style of a widget:[http://doc.trolltech.com/4.5/qwidget.html#setStyle QWidget::setStyle( QStyle * style )]
-
> apt-get update
+
====Showing the status bar====
-
> fakeroot apt-get install libqt4-gui libqt4-dev
+
-
Do these steps for each of the DIABLO_X86, FREMANTLE_X86, DIABLO_ARMEL, FREMANTLE_ARMEL targets that you plan to build on.
+
Hildon applications don't have a status bar. Qt for Maemo hides the status bar by default.
-
===How to compile a Qt application in scratchbox===
+
You can show it again by using method ''statusBar()->show()'' in your class derived from QMainWindow.
-
All the Qt tools you need are available in scratchbox. In order to compile a Qt application you need to follow the
+
====Using the Kinetic Finger Scrolling (cf Gtk's PannableArea)====
-
standard Qt way:
+
-
qmake -project
+
See [[Qt/Finger Scrolling|Finger Scrolling]]
-
qmake file.pro
+
-
make
+
-
===Running a Qt application in scratchbox===
+
===Adding Maemo changes to a Qt Application===
-
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:
+
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:
-
$ Xephyr :2 -host-cursor -screen 800x480x16 -dpi 96 -ac -extension Composite
+
-
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).
+
<source lang="cpp-qt">
 +
#ifdef Q_WS_HILDON
 +
  //Specific hildon/Maemo5 code here
 +
#endif
 +
</source>
-
[sbox-DIABLO_<target>:~] > export DISPLAY=:2
+
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
 +
}
-
After the Xephyr server is running on the Linux host, you can start the Hildon Application Framework with the following command:
+
=== Home widget interaction ===
-
[sbox-DIABLO_<target>:~] > af-sb-init.sh start
+
{{main|Qt4 and Hildon home widget interaction}}
-
This should start the Hildon Application Framework inside the Xephyr window.
+
===Limitations===
-
Now we are ready to run an application in scratchbox:
+
Currently Qt Maemo lacks full support for Hildon widgets introduced in Maemo 5.
-
[sbox-DIABLO_<target>:~] > run-standalone.sh ./qtapps
+
'''At the moment, creating a Qt application that follows Maemo 5 UI Style requires using custom Qt widgets, coded within the application itself'''.
-
===Running a Qt application on the device===
+
There is work ongoing to provide Qt Hildon widgets for Maemo 5, see [[Qt4_Hildon/Qt_Hildon_Widgets|Qt Hildon Widgets]]
-
To run a Qt application into the device, we need to copy it there.
+
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]].
-
====Installing OpenSSH server on the device====
+
== Debugging a Qt application ==
-
To install and run applications on the device, we'll need to install an [[SSH]] server.
+
{{main|Documentation/Maemo_5_Developer_Guide/Kernel_and_Debugging_Guide/Maemo_Debugging_Guide}}
-
* Open the Application Manager.
+
'''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.
-
* Make sure [[Extras]] is enabled.
+
[http://chaos.troll.no/~harald/gdb7/ Here you can find GDB7 for fremantle x86 and armel].  
-
* Install openssh-server from the list.
+
/usr/local/bin/gdb7 ./myapp
-
====Setting up a network connection====
+
== Profiling a Qt application ==
-
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.
+
=== OProfile ===
-
====Using scp to copy the excutable on the device====
+
{{main|Documentation/devtools/maemo5/oprofile}}
-
[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:
+
=== Valgrind ===
-
PC_$> scp qtApplication root@DEVICE-IP:/home/user
+
{{main|Documentation/devtools/maemo5/valgrind}}
-
====Executing the application====
+
== Packaging a Qt application for Maemo ==
-
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.
+
{{main|Packaging a Qt application}}
-
PC_$> ssh root@DEVICE-IP
+
== Maemo Qt API Reference ==
-
N810_#> su - user
+
-
N810_$> ./qtApplication
+
-
<br>
+
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.
-
<br>
+
-
== [[Image:Hammer.png]] Porting a Qt application to Maemo ==
+
===Diablo===
-
===Intro===
+
'''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")
-
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.
+
'''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
-
===Overriding the Qt Maemo changes===
+
'''Finger poke''' is emulated in scratchbox by the Middle Mouse button (NOTE: There is no Fullscreen VKB in scratchbox)
-
====Maemo Style====
+
'''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
-
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).
+
'''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).
-
You can force your application to use another style in several ways:
+
NOTE: Qt widgets like QTextEdit, QLineEdit... set the right input method mode automatically.
-
* Running your application with the flag -style <style_name>
+
A developer can change it by using:
-
<small>''HINT: You can put this flag in the Exec field of the desktop file that launch the application.''</small>
+
<source lang="cpp-qt">
 +
void QInputContext::setInputMode(int mode);
 +
</source>
 +
It will update immediately the Hildon Input method to use the selected IM mode.
-
$> ./qt-test-application -style windows
+
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.
-
* 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 )]
+
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.
-
* 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 )]
+
Setting the ImMode is quite easy. Check the code below for more understanding.
 +
<source lang="cpp-qt">
 +
#ifdef Q_WS_HILDON
 +
#include <QInputContext>
 +
#endif
-
====Showing the status bar====
+
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>
-
Hildon applications don't have a status bar. Qt for Maemo hides the status bar by default.
+
==FREMANTLE (Qt 4.5)==
-
You can show it again by modifying your code.
+
-
TODO
+
===Kinetic scrolling===
-
====Using the Kinetic Finger Scrolling (cf Gtk's PannableArea)====
+
Kinetic scrolling is enabled by default in QListWidgets and is supported by any Qt widget that inherits QScrollArea.
-
See [[Qt/Finger Scrolling|Finger Scrolling]]
+
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
-
===Adding Maemo changes to a Qt Application===
+
===Hildon-Desktop widgets===
-
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:
+
{{main|Qt4 Hildon/Qt Hildon Widgets}}
-
#ifdef Q_WS_HILDON
+
They are supported by Qt. An example (qt-example-hildondesktopwidget) is available in extras-devel.
-
    //Specific hildon code here
+
-
#endif
+
-
===Limitations===
+
===Hildon menus===
-
Currently Qt Maemo does not fully support following important, often used Hildon widgets introduced in Maemo 5:
+
Maemo5 menus are created using QActions available in menu bar.  
-
* Sub views ([http://wiki.maemo.org/Documentation/Maemo_5_Developer_Guide/Human_Interface_Guidelines/Windows description]) - [https://git.maemo.org/projects/hildon/gitweb?p=hildon;a=blob;f=hildon/hildon-stackable-window.h;hb=HEAD HildonStackableWindow] ([http://qt.gitorious.org/+qt-maemo-developers/qt/qt-maemo/commits/patch-hildon.stacked.windows-fremantle work in progress in QT])
+
Hidden, disabled, separators and widget actions won't shown. (Same in Qt 4.6)
-
* view menu ([http://wiki.maemo.org/Documentation/Maemo_5_Developer_Guide/Human_Interface_Guidelines/View_Menu description], filter buttons) - [https://git.maemo.org/projects/hildon/gitweb?p=hildon;a=blob;f=hildon/hildon-app-menu.h;hb=HEAD HildonAppMenu] (NOTE: this is not at all same widget as the legacy application menu in Gtk or Maemo 4)
+
-
* Edit mode toolbar ([http://wiki.maemo.org/Documentation/Maemo_5_Developer_Guide/Human_Interface_Guidelines/Controls#Edit_Toolbar description]) - [https://git.maemo.org/projects/hildon/gitweb?p=hildon;a=blob;f=hildon/hildon-edit-toolbar.h;hb=HEAD HildonEditToolbar]
+
-
* Picker buttons ([http://wiki.maemo.org/Documentation/Maemo_5_Developer_Guide/Human_Interface_Guidelines/Controls#Picker_Button description], see also HildonTouchSelector) - [https://git.maemo.org/projects/hildon/gitweb?p=hildon;a=blob;f=hildon/hildon-picker-button.h;hb=HEAD HildonPickerButton]
+
-
* list selectors ([http://wiki.maemo.org/Documentation/Maemo_5_Developer_Guide/Human_Interface_Guidelines/Controls#Touch_Selectors description], single column, multi column, single selection, multiselection, picker with entry, with images) - [https://git.maemo.org/projects/hildon/gitweb?p=hildon;a=blob;f=hildon/hildon-touch-selector.h;hb=HEAD HildonTouchSelector]
+
-
* Date picker ([http://wiki.maemo.org/Documentation/Maemo_5_Developer_Guide/Human_Interface_Guidelines/Controls#Date_Button description], including column re-layout based on locale data) - [https://git.maemo.org/projects/hildon/gitweb?p=hildon;a=blob;f=hildon/hildon-date-button.h;hb=HEAD HildonDateButton]
+
-
* Time picker ([http://wiki.maemo.org/Documentation/Maemo_5_Developer_Guide/Human_Interface_Guidelines/Controls#Time_Button description], including AM/PM support based on user setting) - [https://git.maemo.org/projects/hildon/gitweb?p=hildon;a=blob;f=hildon/hildon-time-button.h;hb=HEAD HildonTimeButton]
+
 +
* qt-4.5.3-xxxx-maemo4 packages - needs QActions in a "fremantle" menu.
 +
* Pkgs > qt-4.5.3-xxxx-maemo4 shows Maemo5 menus automatically
-
Additionally there are Maemo 5 theming/Maemo 5 UI Style related issues with following QT widgets:
+
Note: Maemo5 policy doesn't allow application to have more than 10 items.
-
* Toolbar does not have correct height
+
-
* Toolbar icons do not have correct size (HILDON_ICON_SIZE_FINGER)
+
-
* Dialogs do not have finger size buttons (HILDON_SIZE_FINGER_HEIGHT)
+
-
* Dialogs do not theme dialog buttons as such (different theme from normal buttons)
+
-
* Dialogs have type icons (e.g. warning) where has in Maemo 5 use of those icons is not allowed.
+
-
* Dialog buttons should stack on top of each other, but currently they layout themselves horizontally
+
-
* overall in many places margins/paddings are not the same as in Maemo 5 UI.
+
-
* keyboard accelerator hints (underscores) are being shown, while Maemo 5 UI Style requires them to be hidden
+
-
* Stock dialogs use button strings such as "OK" and "Cancel", which are forbidden in Maemo 5 UI Style. "OK" should be replaced with an action string or with "Done". The "Cancel" should be removed, as dialogs are cancelled by tapping outside of the dialog.
+
-
* stock "Exit" command should be removed from the menus. It is not allowed in Maemo 5 UI Style.
+
 +
===Stackable windows===
-
Following QT toolkit widgets are not optimized for mobile ui, and consequently are not finger usable on high DPI touchscreens like Nokia N900.
+
http://maemomm.garage.maemo.org/docs/tutorial/figures/stackable-window.png
-
* QColorDialog
+
Are supported by Qt. To create them you need to create a MainWindow child of another Main window.
-
* QFontDialog
+
<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''
-
<br>
+
http://qt.nokia.com/doc/qt-maemo-4.6/maemo5-stackedwindows.html
-
<br>
+
-
== [[Image:Bug.png]] Debugging a Qt application ==
+
===Raise a Qt application in background===
-
===GDB ===
+
<code>QWidget::activateWindow()</code> does the job.
-
====Intro ====
+
Implemented in Qt packages >= qt-4.5.3-xxxx-maemo6
-
The GNU Project Debugger, or gdb for short, is a general purpose debugger that can be used for various debugging purposes.
+
=== 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===
-
====Debugging a Qt application in Scratchbox====
+
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
-
TODO
+
#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.
-
====Debugging a Qt application on device====
+
=== QDockWidgets ===
-
<ol>
+
QDockWidgets are not finger friendly widgets. They should not be used in Maemo.
-
<li>Installing gdb on the device.<ol>
+
In case you are porting an application to Maemo maybe you want to do
-
<li>Add the [http://maemo.org/development/tools/ SDK tools] repository to the catalogue list.</li>
+
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.
-
<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>Your application will appear on the device screen. Happy debugging!</li></ol>
+
-
===Links===
+
=== QPrint* and QSystemTray support missing ===
-
* [http://www.gnu.org/software/gdb/documentation/ GDB documentation & tutorials]
+
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.
-
* [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]
+
-
<br><br>
+
=== QSplashScreen not fully compatible with Hildon-Desktop ===
-
== [[Image:chart.png]] Profiling a Qt application ==
+
-
=== OProfile ===
+
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.
-
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.
+
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>
-
If you want to know more about OProfile in Maemo see the [http://maemo.org/development/tools/doc/chinook/oprofile/ documentation].
+
=== QToolBar limitations ===
-
=== Valgrind ===
+
Adding a QToolBar to a QMainWindow will always result in a toolbar at the bottom of the screen. (Justification/Workarounds?)
-
TODO
+
== Contributing to the Maemo Qt Project ==
-
 
+
-
<br><br>
+
-
 
+
-
== [[Image:chart.png]] Qt benchmarks ==
+
-
2D graphic benchmark tools:
+
-
 
+
-
* [http://wiki.maemo.org/Qt/Benchmark/qgear QGears]
+
-
3D graphic benchmark tools:
+
-
 
+
-
* TODO
+
-
<br><br><br>
+
-
 
+
-
== [[Image:package.png]] Packaging a Qt application for Maemo ==
+
-
 
+
-
{{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.
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 409: Line 359:
Here there is a list of things that every person interested in helping us should read.
Here there is a list of things that every person interested in helping us should read.
-
===Be updated===
+
===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.
+
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 ===
=== Introduction to Git ===
 +
If you are a git newbie you maybe find interesting these links:
If you are a git newbie you maybe find interesting these links:
* http://www.sourcemage.org/Git_Guide
* http://www.sourcemage.org/Git_Guide
Line 421: Line 372:
===Understanding the structure of our Git repository===
===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
Make sure each scratchbox target has
Line 432: Line 383:
(you may need to apt-get install libgl-dev too as it's not in the Build-Depends: yet)
(you may need to apt-get install libgl-dev too as it's not in the Build-Depends: yet)
-
===Building Qt from GIT rep===
+
===Building Qt from Git repository===
-
* Clone the 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>
-
git clone git://gitorious.org/+qt-maemo-developers/qt/qt-maemo.git  
+
# Change dir:<pre>cd qt-maemo</pre>
-
or if you are a member of our team:
+
# Copy the remote 4.5 branch in your working copy:<pre>git checkout -b 4.5 origin/4.5</pre>
-
git clone git@gitorious.org:+qt-maemo-developers/qt/qt-maemo.git
+
# 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>
-
* 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-fremantle origin/qt-fremantle
+
-
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]===
===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.
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.
+
===QML===
 +
[[QML]] is a GUI interface building scripting language for Qt. Check out the [[QML-EnhancedCalcExample | QML calculator example]].
-
http://qt4.garage.maemo.org/patches/qt4-missing-header.tgz
+
==F.A.Q.==
-
===Installing Qt on NXXX===
+
; ''I'm trying to compile a Qt application for ARMEL, but I got the error below. What's wrong?''
-
If you have already a fremantle device then you can install new Qt packages from extras-devel.
+
: <pre>/targets/FREMANTLE_X86/usr/include/qt4/QtCore/qatomic_i386.h:127: error: impossible constraint in 'asm'</pre>
-
The step to follow are:
+
: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.
-
* 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:
+
; I'm trying to compile a Qt packcage for x86, but I got the error below. What's wrong?
-
* libqt4-opengl depends by libgles2, but it is not installable anymore.Has it been replaced with libgles2-sgx-img?
+
: <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.
-
== References ==
+
; 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.
-
<references/>
+
; 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:Development]]
[[Category:Qt]]
[[Category:Qt]]

Latest revision as of 12:08, 9 March 2011

Contents

[edit] Introduction

To develop with Qt for Maemo, a working SDK installation is required. There are instructions on how to install the Maemo SDK, and you can watch the Maemo SDK in action. Alternatively, you may want to try MADDE, a cross-platform Maemo development tool, available as a technology preview.

[edit] 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 the Maemo platform and a developer overview.

[edit] Getting started

To start to develop with Maemo Qt, we need to install the Maemo SDK.

[edit] Installing Qt packages in Scratchbox

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

[edit] 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

[edit] Using Qt 4.6 in Fremantle

Since the 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

[edit] 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, and then install Qt packages in the terminal:

apt-get install libqt4-dev

[edit] 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.

[edit] QMake

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:

  1. Generating project file (Required if there is no .pro file into the app source tree)
    qmake -project
  2. Generating Makefile from the QMake project file:
    qmake file.pro
  3. make

[edit] CMake

Because of some issue with CMake, Diablo CMake packages are currently useless since CMake segfaults (on the device at least). This issue has been solved in Fremantle and CMake packages that comes from Fremantle SDK work nicely.

CMake projects usually have a CMakeLists.txt file instead of:

  1. .pro file used by QMake projects
  2. Makefile.am 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 scratchbox. You can install it with the command:

fakeroot apt-get install cmake

[edit] Running a Qt application in:

[edit] 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:

  1. Run Xephyr. It is able to run a X Server inside another X Server.
    Xephyr :2 -host-cursor -screen 800x480x16 -dpi 96 -ac -kb
  2. Set display for application that runs inside scratchbox:
    export DISPLAY=:2
  3. You can now run the SDK UI. A Diablo or Fremantle desktop will appear in your Xephyr window:
    af-sb-init.sh start
  4. Now you are ready to run any Maemo or Maemo Qt application with:
    run-standalone.sh ./qtapps

Note: run-standalone.sh sets some variable needed by Qt to use the Hildon style.

[edit] 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, /home/user or /opt in Fremantle).

Fore example, if we want to run quassel (Qt IRC Client) we have to launch it with:

su -c ./quassel user

[edit] 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.

[edit] Overriding the Qt Maemo changes

[edit] Maemo Style

Hildon Style is the default Qt application style. Other style available are:

Qt application can use other Qt styles;

  • Running your application with the style flag:
./qt-test-application -style windows

[edit] 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.

[edit] Using the Kinetic Finger Scrolling (cf Gtk's PannableArea)

See Finger Scrolling

[edit] 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:

#ifdef Q_WS_HILDON
   //Specific hildon/Maemo5 code here 
#endif

Qt project files can load hildon files using: (check 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

}

[edit] Home widget interaction

Main article: Qt4 and Hildon home widget interaction


[edit] 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 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 Building Qt from GIT repository.

[edit] Debugging a Qt application

Main article: 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. Here you can find GDB7 for fremantle x86 and armel.

/usr/local/bin/gdb7 ./myapp

[edit] Profiling a Qt application

[edit] OProfile

Main article: Documentation/devtools/maemo5/oprofile


[edit] Valgrind

Main article: Documentation/devtools/maemo5/valgrind


[edit] Packaging a Qt application for Maemo

Main article: Packaging a Qt application


[edit] 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 Official Qt 4.5 API documentation and the list below to see what are the Maemo changes.

[edit] 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 key sequence QKeySequence::ZoomIn
  • Zoom out - is a standard 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);
  }
}

[edit] FREMANTLE (Qt 4.5)

[edit] 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:

QTableWidget *table = new QTableWidget(this);
table->setProperty("FingerScrollable", true);

NOTE: Available in Qt > 4.5.3-xxxxx-maemo4

[edit] Hildon-Desktop widgets

Main article: Qt4 Hildon/Qt Hildon Widgets


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

[edit] 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.

[edit] 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.

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);

Note: this is not entirely accurate, see

http://qt.nokia.com/doc/qt-maemo-4.6/maemo5-stackedwindows.html

[edit] Raise a Qt application in background

QWidget::activateWindow() does the job.

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

[edit] How to minimize a Qt application?

QDBusConnection c = QDBusConnection::sessionBus();
QDBusMessage m = QDBusMessage::createSignal("/","com.nokia.hildon_desktop","exit_app_view");
c.send(m);

[edit] 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.

#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

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.

[edit] 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.

[edit] 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.

[edit] 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:

 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);
 }

[edit] QToolBar limitations

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

[edit] 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.

[edit] 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.

[edit] Introduction to Git

If you are a git newbie you maybe find interesting these links:

[edit] Understanding the structure of our Git repository

Main article: Qt Maemo Git Process


[edit] 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)

[edit] Building Qt from Git repository

  1. 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
  2. Change dir:
    cd qt-maemo
  3. Copy the remote 4.5 branch in your working copy:
    git checkout -b 4.5 origin/4.5
  4. Checkout ONE of these branches:
    git checkout -b qt-diablo origin/qt-diablo
    git checkout -b qt-n900+w34 origin/qt-n900+w34
    git checkout -b qt-mer origin/qt-mer
  5. Build the packages:
    dpkg-buildpackage -rfakeroot -b

[edit] 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.

[edit] QML

QML is a GUI interface building scripting language for Qt. Check out the QML calculator example.

[edit] 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 qmake before make 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 /bin/sh, so when calling pkg-config from qmake, CFLAGS and LIBS are not set correctly. Running ln -s /scratchbox/tools/bin/sh /bin/sh 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