Editing Documentation/Maemo 5 Developer Guide/Porting Software/Porting MaemoPad
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.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
This is a practical example of porting a [[Open development/Maemo roadmap/Diablo|Diablo]] (Maemo 4.1) application to [[Open development/Maemo roadmap/Fremantle|Fremantle]] (Maemo 5). The example application, MaemoPad, is a simple Notepad-like editor. | This is a practical example of porting a [[Open development/Maemo roadmap/Diablo|Diablo]] (Maemo 4.1) application to [[Open development/Maemo roadmap/Fremantle|Fremantle]] (Maemo 5). The example application, MaemoPad, is a simple Notepad-like editor. | ||
- | [[Image:maemopad.png| | + | <div align="CENTER"> |
- | + | {| summary="MaemoPad" | |
+ | |+ align="BOTTOM" |'''Figure:''' MaemoPad | ||
+ | |- | ||
+ | | | ||
+ | [[Image:maemopad.png|MaemoPad]] | ||
+ | |} | ||
+ | </div> | ||
== Porting MaemoPad from Diablo to Fremantle == | == Porting MaemoPad from Diablo to Fremantle == | ||
Line 10: | Line 16: | ||
=== Installing MaemoPad === | === Installing MaemoPad === | ||
- | MaemoPad can be installed and tested in the | + | MaemoPad can be installed and tested in the scratchbox environment. |
* If not already activated, activate the X86 target, go to the testing directory, and download the source package of maemopad application. | * If not already activated, activate the X86 target, go to the testing directory, and download the source package of maemopad application. | ||
Line 142: | Line 148: | ||
Hildon help library, libhildonhelp, was dropped from Fremantle so all dependencies to it had to be removed. | Hildon help library, libhildonhelp, was dropped from Fremantle so all dependencies to it had to be removed. | ||
- | libhildonhelp-dev needs to removed from build | + | libhildonhelp-dev needs to removed from build depencies: |
Diablo: debian/control: | Diablo: debian/control: | ||
- | + | Build-Depends: debhelper (>= 4.0.0), intltool, | |
- | Build-Depends: debhelper (>= 4.0.0), intltool, | + | libhildon1-dev, libgtk2.0-dev, libosso-gnomevfs2-dev, |
- | + | libglib2.0-dev, libdbus-glib-1-dev, libosso-dev, libmodest-dbus-client-dev, | |
- | + | conbtdialogs-dev,libhildonhelp-dev, libhildonfm2-dev, osso-af-settings | |
- | + | ||
- | + | ||
Fremantle: debian/control: | Fremantle: debian/control: | ||
- | + | Build-Depends: debhelper (>= 4.0.0), intltool, | |
- | Build-Depends: debhelper (>= 4.0.0), intltool, | + | libhildon1-dev, libgtk2.0-dev, libosso-gnomevfs2-dev, |
- | + | libglib2.0-dev, libdbus-glib-1-dev, libosso-dev, libmodest-dbus-client-dev, | |
- | + | conbtdialogs-dev, libhildonfm2-dev, osso-af-settings | |
- | + | ||
- | + | ||
Callback and all other help stuff removed: | Callback and all other help stuff removed: | ||
Line 166: | Line 168: | ||
Diablo callbacks.c | Diablo callbacks.c | ||
- | + | /* help */ | |
- | /* help */ | + | void callback_help( GtkAction * action, gpointer data ) |
- | void callback_help( GtkAction * action, gpointer data ) | + | { |
- | { | + | osso_return_t retval; |
- | + | /* connect pointer to our AppUIData struct */ | |
- | + | AppUIData *mainview = NULL; | |
- | + | mainview = ( AppUIData * ) data; | |
- | + | g_assert(mainview != NULL && mainview->data != NULL ); | |
- | + | retval = hildon_help_show( | |
- | + | mainview->data->osso, /* osso_context */ | |
- | + | HELP_TOPIC_ID, /* topic id */ | |
- | + | HILDON_HELP_SHOW_DIALOG); | |
- | + | } | |
- | } | + | |
- | + | ||
Diablo interface.c | Diablo interface.c | ||
- | + | GtkWidget *help = NULL; | |
- | GtkWidget *help = NULL; | + | help = gtk_menu_item_new_with_label( _("Help") ); |
- | help = gtk_menu_item_new_with_label( _("Help") ); | + | gtk_menu_append( main_menu, help ); |
- | gtk_menu_append( main_menu, help ); | + | g_signal_connect( G_OBJECT( help ), "activate", |
- | g_signal_connect( G_OBJECT( help ), "activate", | + | G_CALLBACK ( callback_help ), main ); |
- | + | ||
- | + | ||
Diablo callbacks.c | Diablo callbacks.c | ||
- | + | #include <hildon/hildon-help.h> | |
- | #include <hildon/hildon-help.h> | + | #define HELP_TOPIC_ID "Example_MaemoPad_Content" |
- | #define HELP_TOPIC_ID "Example_MaemoPad_Content" | + | |
- | + | ||
Diablo configure.ac: | Diablo configure.ac: | ||
- | + | PKG_CHECK_MODULES(HILDON, hildon-1 hildon-fm-2 hildon-help conbtdialogs) | |
- | PKG_CHECK_MODULES(HILDON, hildon-1 hildon-fm-2 hildon-help conbtdialogs) | + | |
- | + | ||
Fremantle configure.ac: | Fremantle configure.ac: | ||
- | + | ||
- | + | PKG_CHECK_MODULES(HILDON, hildon-1 hildon-fm-2 conbtdialogs) | |
- | PKG_CHECK_MODULES(HILDON, hildon-1 hildon-fm-2 conbtdialogs) | + | |
- | + | ||
Removed data/help directory which contained an example help file. | Removed data/help directory which contained an example help file. | ||
Line 216: | Line 208: | ||
Diablo data/Makefile.am: | Diablo data/Makefile.am: | ||
- | + | ||
- | + | helpfile_engb_DATA = help/en_GB/MaemoPad.xml | |
- | helpfile_engb_DATA = help/en_GB/MaemoPad.xml | + | -EXTRA_DIST = $(serviceentry_DATA) $(desktopentry_DATA) $(icon_26x26_DATA) $(icon_40x40_DATA) |
- | -EXTRA_DIST = $(serviceentry_DATA) $(desktopentry_DATA) $(icon_26x26_DATA) $(icon_40x40_DATA) | + | $(icon_scalable_DATA) *$(helpfile_engb_DATA)* |
- | $(icon_scalable_DATA) *$(helpfile_engb_DATA)* | + | |
- | + | ||
Diablo data/Makefile.am: | Diablo data/Makefile.am: | ||
- | + | # Help file install directory | |
- | # Help file install directory | + | helpfile_engbdir=$datadir/hildon-help/en_GB |
- | helpfile_engbdir=$datadir/hildon-help/en_GB | + | AC_SUBST(helpfile_engbdir) |
- | AC_SUBST(helpfile_engbdir) | + | |
- | + | ||
=== GUI design changes === | === GUI design changes === | ||
Line 237: | Line 226: | ||
Diablo interface.h | Diablo interface.h | ||
- | + | /* Toolbar */ | |
- | /* Toolbar */ | + | GtkWidget* toolbar; |
- | GtkWidget* toolbar; | + | GtkWidget* iconw; |
- | GtkWidget* iconw; | + | GtkToolItem* new_tb; |
- | GtkToolItem* new_tb; | + | GtkToolItem* open_tb; |
- | GtkToolItem* open_tb; | + | ... |
- | ... | + | GtkToolItem* fullscreen_tb; |
- | GtkToolItem* fullscreen_tb; | + | |
- | < | + | Also the menu system was changed. In Diablo, a GtkMenu was used, but it was replaced with a HildonAppMenu in Fremantle, as shown in Figure: |
+ | |||
+ | <div align="CENTER"> | ||
- | + | {| summary="MaemoPad Menu" | |
+ | |+ align="BOTTOM" |'''Figure:''' MaemoPad Menu | ||
+ | |- | ||
+ | | | ||
+ | <div align="CENTER">[[Image:maemopad_menu.png|MaemoPad menu]]</div> | ||
+ | |} | ||
- | + | </div> | |
Function <code>create_menu()</code> is responsible for creating the menus in both versions: | Function <code>create_menu()</code> is responsible for creating the menus in both versions: | ||
Line 255: | Line 251: | ||
Diablo interface.c | Diablo interface.c | ||
- | + | static void create_menu( AppUIData *main ) | |
- | static void create_menu( AppUIData *main ) | + | { |
- | { | + | /* Create needed handles */ |
- | + | GtkMenu *main_menu; | |
- | + | GtkWidget *file_menu, *edit_menu, *sendvia_menu; | |
- | + | GtkWidget *separator = NULL; | |
- | + | GtkWidget *close = NULL; | |
- | + | /* Create main menu and new menus for submenus in our drop down menu */ | |
- | + | main_menu = GTK_MENU( gtk_menu_new () ); | |
- | + | file_menu = gtk_menu_new (); | |
- | + | edit_menu = gtk_menu_new (); | |
- | + | sendvia_menu = gtk_menu_new (); | |
- | + | /* Create the menu items */ | |
- | + | main->file_item = gtk_menu_item_new_with_label ( _("File") ); | |
- | + | main->new_item = gtk_menu_item_new_with_label ( _("New") ); | |
- | + | main->open_item = gtk_menu_item_new_with_label ( _("Open") ); | |
- | + | ... | |
- | + | /* Add menu items to right menus */ | |
- | + | gtk_menu_append( main_menu, main->file_item ); | |
- | + | gtk_menu_append( file_menu, main->new_item ); | |
- | + | gtk_menu_append( file_menu, main->open_item ); | |
- | + | ... | |
- | + | gtk_menu_append( main_menu, close ); | |
- | + | /* Add submenus to the right items */ | |
- | + | gtk_menu_item_set_submenu( GTK_MENU_ITEM (main->file_item), file_menu ); | |
- | + | gtk_menu_item_set_submenu( GTK_MENU_ITEM (main->edit_item), edit_menu ); | |
- | + | gtk_menu_item_set_submenu( GTK_MENU_ITEM (main->sendvia_item), sendvia_menu ); | |
- | + | /* Attach the callback functions to the activate signal */ | |
- | + | g_signal_connect( G_OBJECT( main->new_item ), "activate", | |
- | + | G_CALLBACK ( callback_file_new), main ); | |
- | + | g_signal_connect( G_OBJECT( main->open_item ), "activate", | |
- | + | G_CALLBACK ( callback_file_open), main ); | |
- | + | ... | |
- | + | g_signal_connect( G_OBJECT( close ), "activate", gtk_main_quit, NULL ); | |
- | + | /* Add menu to HildonWindow */ | |
- | + | hildon_window_set_menu(main->data->window, main_menu); | |
- | + | /* We need to show menu items */ | |
- | + | gtk_widget_show_all( GTK_WIDGET( main_menu ) ); | |
- | + | } | |
- | } | + | |
- | + | ||
Fremantle maemopad-window.c | Fremantle maemopad-window.c | ||
- | + | static GtkWidget* add_menu_item (GtkWidget *main_menu, const gchar* title, | |
- | static GtkWidget* add_menu_item (GtkWidget *main_menu, const gchar* title, | + | GCallback clicked_callback, gpointer user_data) |
- | + | { | |
- | { | + | HildonAppMenu *app_menu = HILDON_APP_MENU (main_menu); |
- | + | /* Create a button, add it, and return it: */ | |
- | + | GtkWidget *button = hildon_button_new_with_text (HILDON_SIZE_AUTO, | |
- | + | HILDON_BUTTON_ARRANGEMENT_VERTICAL, title, NULL); | |
- | + | gtk_widget_show (button); | |
- | + | g_signal_connect_after (button, "clicked", | |
- | + | G_CALLBACK (clicked_callback), user_data); | |
- | + | hildon_app_menu_append (app_menu, GTK_BUTTON (button)); | |
- | + | return button; | |
- | + | } | |
- | } | + | /* Create the menu items needed: */ |
- | /* Create the menu items needed: */ | + | static void create_menu (MaemopadWindow *self) |
- | static void create_menu (MaemopadWindow *self) | + | { |
- | { | + | /* Create needed handles */ |
- | + | GtkWidget *main_menu = hildon_app_menu_new (); | |
- | + | /* Create the menu items */ | |
- | + | self->new_item = add_menu_item (main_menu, _("New"), | |
- | + | G_CALLBACK (&maemopad_window_on_menu_file_new), self); | |
- | + | self->open_item = add_menu_item (main_menu, _("Open"), | |
- | + | G_CALLBACK (&maemopad_window_on_menu_file_open), self); | |
- | + | ... | |
- | + | self->close_item = add_menu_item (main_menu, _("Close"), | |
- | + | G_CALLBACK (&maemopad_window_on_menu_close), self); | |
- | + | /* Add menu to HildonWindow */ | |
- | + | hildon_window_set_app_menu ( | |
- | + | HILDON_WINDOW (self), | |
- | + | HILDON_APP_MENU (main_menu)); | |
- | + | /* We need to show menu items */ | |
- | + | gtk_widget_show_all (GTK_WIDGET (main_menu)); | |
- | + | } | |
- | } | + | |
- | + | ||
As a result to changes in the .c file, the following menu widget declarations used in Diablo became unnecessary: | As a result to changes in the .c file, the following menu widget declarations used in Diablo became unnecessary: | ||
Line 339: | Line 333: | ||
Diablo interface.h | Diablo interface.h | ||
- | + | GtkWidget *file_item; | |
- | GtkWidget *file_item; | + | GtkWidget *edit_item; |
- | GtkWidget *edit_item; | + | GtkWidget *sendvia_item; |
- | GtkWidget *sendvia_item; | + | |
- | + | ||
- | Menu callbacks were also changed. There were some changes in the callbacks themselves as a result of code reorganizations, but the main change from the menu viewpoint was that the 1st arguments of the callbacks were changed from | + | |
+ | |||
+ | Menu callbacks were also changed. There were some changes in the callbacks themselves as a result of code reorganizations, but the main change from the menu viewpoint was that the 1st arguments of the callbacks were changed from GtkAction to GtkButton, like in the following example: | ||
Diablo callbacks.c | Diablo callbacks.c | ||
- | + | void callback_file_new(GtkAction * action, gpointer data) | |
- | void callback_file_new(GtkAction * action, gpointer data) | + | |
- | + | ||
Fremantle maemopad-window.c | Fremantle maemopad-window.c | ||
- | + | static void maemopad_window_on_menu_file_new (GtkButton *button, gpointer data) | |
- | static void maemopad_window_on_menu_file_new (GtkButton *button, gpointer data) | + | |
- | + | ||
=== Other updates in GTK+ and Hildon === | === Other updates in GTK+ and Hildon === | ||
+ | |||
<ul> | <ul> | ||
<li> | <li> | ||
Rich text support was changed with the new GTK+, as described in [http://live.gnome.org/Maemo/Gtk210Migration Maemo-GTK+ 2.6 to 2.10 Migration].This required editing two lines: | Rich text support was changed with the new GTK+, as described in [http://live.gnome.org/Maemo/Gtk210Migration Maemo-GTK+ 2.6 to 2.10 Migration].This required editing two lines: | ||
+ | <br /><br /> | ||
+ | Part of function create_textarea() in Diablo interface.c | ||
- | + | <pre> | |
- | + | ||
- | + | ||
/* Enable Rich Text Support */ | /* Enable Rich Text Support */ | ||
gtk_text_buffer_set_can_paste_rich_text ( main->buffer, TRUE ); | gtk_text_buffer_set_can_paste_rich_text ( main->buffer, TRUE ); | ||
gtk_text_buffer_set_rich_text_format ( main->buffer, "RTF" ); | gtk_text_buffer_set_rich_text_format ( main->buffer, "RTF" ); | ||
- | </ | + | </pre> |
- | Part of function | + | Part of function create_textarea() in Fremantle maemopad-window.c |
- | < | + | <pre> |
/* Enable Rich Text Support */ | /* Enable Rich Text Support */ | ||
gtk_text_buffer_register_serialize_tagset (self->buffer, "RTF"); | gtk_text_buffer_register_serialize_tagset (self->buffer, "RTF"); | ||
gtk_text_buffer_register_deserialize_tagset (self->buffer, "RTF"); | gtk_text_buffer_register_deserialize_tagset (self->buffer, "RTF"); | ||
- | </ | + | </pre> |
</li> | </li> | ||
- | |||
- | |||
+ | <li> | ||
+ | HildonFontSelectionDialog was deprecated and replaced with a GtkFontButton. | ||
+ | In Diablo, the font callback was a callback to a regular GtkAction: | ||
+ | <br /><br /> | ||
callback.c | callback.c | ||
- | < | + | <pre> |
void callback_font( GtkAction * action, gpointer data ) | void callback_font( GtkAction * action, gpointer data ) | ||
{ | { | ||
Line 398: | Line 392: | ||
} | } | ||
} | } | ||
- | </ | + | </pre> |
- | + | ||
- | + | ||
+ | Function <code>callback_font</code> got the font from an auxiliary function <code>interface_font_chooser()</code> and then modified the font in the text view. The auxiliary function <code>interface_font_chooser()</code> in turn opened a HildonFontSelectionDialog that returned the font parameters: | ||
+ | <br /><br /> | ||
callback.c | callback.c | ||
- | < | + | <pre> |
/* Font chooser */ | /* Font chooser */ | ||
PangoFontDescription* interface_font_chooser( AppUIData * main ) | PangoFontDescription* interface_font_chooser( AppUIData * main ) | ||
Line 437: | Line 431: | ||
return font; | return font; | ||
} | } | ||
- | </ | + | </pre> |
- | |||
+ | Instead of the deprecated HildonFontSelectionDialog, Fremantle uses a GtkFontButton directly in the font button callback: | ||
+ | <br /><br /> | ||
maemopad-window.c | maemopad-window.c | ||
- | < | + | <pre> |
/* font */ | /* font */ | ||
static void maemopad_window_on_font_set (GtkFontButton *button, gpointer data) | static void maemopad_window_on_font_set (GtkFontButton *button, gpointer data) | ||
Line 460: | Line 455: | ||
} | } | ||
} | } | ||
- | </ | + | </pre> |
- | This | + | This GtkFontButton was initialized in function <code>create_menu()</code> (see above) in maemopad-window.c so that it would respond to the <code>"font-set"</code> signal and call the callback above: |
- | + | self->font_item = gtk_font_button_new (); | |
- | self->font_item = gtk_font_button_new (); | + | gtk_widget_show (self->font_item); |
- | gtk_widget_show (self->font_item); | + | g_signal_connect_after (self->font_item, "font-set", |
- | g_signal_connect_after (self->font_item, "font-set", | + | G_CALLBACK (maemopad_window_on_font_set), self); |
- | + | hildon_app_menu_append (HILDON_APP_MENU (main_menu), GTK_BUTTON (self->font_item)); | |
- | hildon_app_menu_append (HILDON_APP_MENU (main_menu), GTK_BUTTON (self->font_item)); | + | |
- | + | ||
</li> | </li> | ||
- | |||
- | |||
+ | <li> | ||
+ | Instead of GtkTextView, a [http://maemo.org/api_refs/5.0/5.0-final/hildon/HildonTextView.html HildonTextView] is now used: | ||
+ | <br /><br /> | ||
Diablo callback.c | Diablo callback.c | ||
- | < | + | <pre> |
/* Create the text area */ | /* Create the text area */ | ||
void create_textarea( AppUIData *main ) | void create_textarea( AppUIData *main ) | ||
Line 489: | Line 483: | ||
... | ... | ||
} | } | ||
- | </ | + | </pre> |
Fremantle maemopad-window.c | Fremantle maemopad-window.c | ||
- | < | + | <pre> |
static void create_textarea (MaemopadWindow *self) | static void create_textarea (MaemopadWindow *self) | ||
{ | { | ||
Line 502: | Line 496: | ||
self->buffer = hildon_text_view_get_buffer (GTK_TEXT_VIEW (self->textview)); | self->buffer = hildon_text_view_get_buffer (GTK_TEXT_VIEW (self->textview)); | ||
} | } | ||
- | </ | + | </pre> |
</li> | </li> | ||
+ | |||
<li> | <li> | ||
All Hildon applications should now initialize hildon before using it. In maemopad this is done by calling <code>hildon_gtk_init()</code> which also calls <code>gtk_init()</code> so the original call can be removed: | All Hildon applications should now initialize hildon before using it. In maemopad this is done by calling <code>hildon_gtk_init()</code> which also calls <code>gtk_init()</code> so the original call can be removed: | ||
- | + | <br /><br /> | |
Diablo main.c | Diablo main.c | ||
- | < | + | <pre> |
/* Init the gtk - must be called before any hildon stuff */ | /* Init the gtk - must be called before any hildon stuff */ | ||
gtk_init( &argc, &argv ); | gtk_init( &argc, &argv ); | ||
- | </ | + | </pre> |
Fremantle main.c | Fremantle main.c | ||
- | < | + | <pre> |
/* Inititialize GTK+ and hildon: */ | /* Inititialize GTK+ and hildon: */ | ||
hildon_gtk_init( &argc, &argv ); | hildon_gtk_init( &argc, &argv ); | ||
- | </ | + | </pre> |
[[Category:Development]] | [[Category:Development]] | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Fremantle]] | [[Category:Fremantle]] |
Learn more about Contributing to the wiki.