Legacy Maemo 5 Documentation/Graphical UI Tutorial/Navigation - Revision history

amigadave: wikify slightly

2010-10-15T13:51:11Z

wikify slightly

amigadave: {{Legacy documentation}}

2010-02-12T09:45:15Z

← Older revision		Revision as of 09:45, 12 February 2010
Line 1:		Line 1:
		+	{{Legacy documentation}}
		+
	=Navigation =		=Navigation =
	In previous examples only one widget was added to a window so we can simply use a <code>gtk_container_add()</code> to "pack" it into the window. To pack more than one widget into a window, use container widgets.		In previous examples only one widget was added to a window so we can simply use a <code>gtk_container_add()</code> to "pack" it into the window. To pack more than one widget into a window, use container widgets.

msoini: Documentation/Maemo 5 Developer Guide/Graphical UI Tutorial/Navigation moved to Legacy Maemo 5 Documentation/Graphical UI Tutorial/Navigation: Phase out from Maemo Developer Guide, superceded by Official Nokia Forum documentation

2009-10-14T09:30:22Z

Documentation/Maemo 5 Developer Guide/Graphical UI Tutorial/Navigation moved to Legacy Maemo 5 Documentation/Graphical UI Tutorial/Navigation: Phase out from Maemo Developer Guide, superceded by Official Nokia Forum documentation

← Older revision

Revision as of 09:30, 14 October 2009

liox_lang_valid: /* Navigation */

2009-09-25T06:01:33Z

Navigation

← Older revision		Revision as of 06:01, 25 September 2009
Line 1:		Line 1:
	=Navigation =		=Navigation =
-	In previous examples only one widget was added to a window so we ~~could~~ simply use a <code>gtk_container_add()</code> to "pack" it into the window. To pack more than one widget into a window, use container widgets.	+	In previous examples only one widget was added to a window so we can simply use a <code>gtk_container_add()</code> to "pack" it into the window. To pack more than one widget into a window, use container widgets.

-	To develop Hildon user interfaces, ~~you can~~ use any container widget provided by GTK+. For more information, see the GTK+ 2.0 Tutorial.	+	To develop Hildon user interfaces, use any container widget provided by GTK+. For more information, see the GTK+ 2.0 Tutorial.

	Apart from supporting those containers, the Hildon framework also provides a new container widget called HildonPannableArea, a scrolling widget designed for touch screens.		Apart from supporting those containers, the Hildon framework also provides a new container widget called HildonPannableArea, a scrolling widget designed for touch screens.
Line 8:		Line 8:

	== Pannable area ==		== Pannable area ==
-	HildonPannableArea is used to create an area with another widget inside which is accessible regardless of the size using the touchscreen to scroll it. You ~~may~~ insert any type of widget into a pannable area ~~and~~ it is always accessible by using the fingers to pan, or scroll, in the area.	+	HildonPannableArea is used to create an area with another widget inside which is accessible regardless of the size using the touchscreen to scroll it. You can insert any type of widget into a pannable area; it is always accessible by using the fingers to pan, or scroll, in the area.

	This widget can be "panned" (scrolled) in any direction using the touchscreen with the fingers. One remarkable characteristic is that the scrolling is "kinetic", meaning that the motion continues from the initial motion by gradually slowing down to stop.		This widget can be "panned" (scrolled) in any direction using the touchscreen with the fingers. One remarkable characteristic is that the scrolling is "kinetic", meaning that the motion continues from the initial motion by gradually slowing down to stop.

-	~~The use of~~ this widget is very similar to GTK+ scrolled windows. In fact, both widgets implement a similar concept and its APIs are very similar.	+	Using this widget is very similar to GTK+ scrolled windows. In fact, both widgets implement a similar concept and its APIs are very similar.

	To create a new pannable area, choose one of the following functions:		To create a new pannable area, choose one of the following functions:
Line 35:		Line 35:
	The default values of these properties are right for most applications and so the simpler constructor is sufficient. For more information on the properties of the pannable area, see the Hildon reference manual.		The default values of these properties are right for most applications and so the simpler constructor is sufficient. For more information on the properties of the pannable area, see the Hildon reference manual.

-	~~Once~~ the area is created, ~~you can~~ place your object into the pannable window using the following function.	+	When the area is created, place your object into the pannable window using the following function.

	<tt><span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">hildon_pannable_area_add_with_viewport</font></span>'''</span> <span><font color="#990000">(</font></span>HildonPannableArea <span><font color="#990000"><nowiki>*</nowiki></font></span>area<span><font color="#990000">,</font></span>		<tt><span><font color="#009900">void</font></span> <span>'''<span><font color="#000000">hildon_pannable_area_add_with_viewport</font></span>'''</span> <span><font color="#990000">(</font></span>HildonPannableArea <span><font color="#990000"><nowiki>*</nowiki></font></span>area<span><font color="#990000">,</font></span>
Line 45:		Line 45:
	'''Warning'''		'''Warning'''

-	~~Widgets~~ with native scrolling ~~should be added~~ directly inside a pannable area. ~~Widgets~~ such as~~, for example,~~ GtkTextView, GtkTreeView, GtkIconView and GtkLayout ~~should be added~~ by calling <code>gtk_container_add()</code>. Otherwise, panning ~~could~~ not work properly.	+	Add widgets with native scrolling directly inside a pannable area. Add widgets such as GtkTextView, GtkTreeView, GtkIconView and GtkLayout by calling <code>gtk_container_add()</code>. Otherwise, panning may not work properly.


Line 123:		Line 123:
	</tt>		</tt>

-	In the example above, two calls are enough to use a pannable area. The rest of the code in the example is no different from ~~that~~ used in a GTK+ application.	+	In the example above, two calls are enough to use a pannable area. The rest of the code in the example is no different from the one used in a GTK+ application.

	<tt> <span>''<span><font color="#9A1900">/* Create a new pannable area. */</font></span>''</span>		<tt> <span>''<span><font color="#9A1900">/* Create a new pannable area. */</font></span>''</span>
Line 131:		Line 131:
	</tt>		</tt>

-	To see all the buttons, users can scroll with the fingers. In this example, horizontal and vertical panning are activated as that is needed to allow users to be able to interact both all the widgets. The property "mov-mode" controls if the area can scroll horizontally, vertically (default value) or both, using HILDON_MOVEMENT_MODE_HORIZ, HILDON_MOVEMENT_MODE_VERT or HILDON_MOVEMENT_MODE_BOTH, respectively.	+	To see all the buttons, users can scroll with the fingers. In this example, horizontal and vertical panning are activated because that is needed to allow users to be able to interact both all the widgets. The property "mov-mode" controls if the area can scroll horizontally, vertically (default value) or both, using HILDON_MOVEMENT_MODE_HORIZ, HILDON_MOVEMENT_MODE_VERT or HILDON_MOVEMENT_MODE_BOTH, respectively.

	==Additional features ==		==Additional features ==
Line 289:		Line 289:
	To test the different navigation functions, just change the call in the callback.		To test the different navigation functions, just change the call in the callback.

-	When you use the navigation functions that allow to navigate to a certain child, the widget must be already realized. Use the GTK_WIDGET_REALIZED macro to check it. If you want to call it during the initialization process, use the navigation function inside a callback to the "realized" signal, connecting it with <code>g_signal_connect_after()</code>.	+	When you use the navigation functions that allow to navigate to a certain child, the widget must already be realized. Use the GTK_WIDGET_REALIZED macro to check it. If you want to call it during the initialization process, use the navigation function inside a callback to the "realized" signal, connecting it with <code>g_signal_connect_after()</code>.

tatiana: Example of a pannable area and a "jump-to" button: synced with https://garage.maemo.org/svn/maemoexamples/trunk/hildon-examples/hildon-pannable-area-jump-example.c, see ChangeLog for details

2009-09-10T13:56:10Z

Example of a pannable area and a "jump-to" button: synced with https://garage.maemo.org/svn/maemoexamples/trunk/hildon-examples/hildon-pannable-area-jump-example.c, see ChangeLog for details

Show changes

bijjal: Documentation/Maemo 5 Developer Guide/Application Development/Navigation moved to Documentation/Maemo 5 Developer Guide/Graphical UI Tutorial/Navigation: Internal baseline has moved this chapter from Application development.

2009-08-18T08:28:36Z

Documentation/Maemo 5 Developer Guide/Application Development/Navigation moved to Documentation/Maemo 5 Developer Guide/Graphical UI Tutorial/Navigation: Internal baseline has moved this chapter from Application development.

← Older revision

Revision as of 08:28, 18 August 2009

bijjal: /* Pannable area example */

2009-07-13T14:28:31Z

Pannable area example

← Older revision		Revision as of 14:28, 13 July 2009
Line 51:		Line 51:
	Functions explained above are enough for a simple example. The following example packs a table with 100 toggle buttons into a pannable area.		Functions explained above are enough for a simple example. The following example packs a table with 100 toggle buttons into a pannable area.

-	~~@@IMAGE@@~~: ~~examples/hildon_pannable_area_example~~.~~c output (code )~~	+	[[Image:example-pannable-area.png\|400px]]

	'''Example 5.1. Example of a pannable area'''		'''Example 5.1. Example of a pannable area'''
Line 132:		Line 132:

	To see all the buttons, users can scroll with the fingers. In this example, horizontal and vertical panning are activated as that is needed to allow users to be able to interact both all the widgets. The property "mov-mode" controls if the area can scroll horizontally, vertically (default value) or both, using HILDON_MOVEMENT_MODE_HORIZ, HILDON_MOVEMENT_MODE_VERT or HILDON_MOVEMENT_MODE_BOTH, respectively.		To see all the buttons, users can scroll with the fingers. In this example, horizontal and vertical panning are activated as that is needed to allow users to be able to interact both all the widgets. The property "mov-mode" controls if the area can scroll horizontally, vertically (default value) or both, using HILDON_MOVEMENT_MODE_HORIZ, HILDON_MOVEMENT_MODE_VERT or HILDON_MOVEMENT_MODE_BOTH, respectively.
-

	==Additional features ==		==Additional features ==

danielwilms: 1 revision

2009-07-13T11:36:05Z

1 revision

← Older revision

Revision as of 11:36, 13 July 2009

wikiadmin: moved Maemo 5 Developer Guide/Application Development/Navigation to Documentation/Maemo 5 Developer Guide/Application Development/Navigation

2009-07-13T11:02:45Z

moved Maemo 5 Developer Guide/Application Development/Navigation to Documentation/Maemo 5 Developer Guide/Application Development/Navigation

New page

=Navigation =
In previous examples only one widget was added to a window so we could simply use a <code>gtk_container_add()</code> to "pack" it into the window. To pack more than one widget into a window, use container widgets.

To develop Hildon user interfaces, you can use any container widget provided by GTK+. For more information, see the GTK+ 2.0 Tutorial.

Apart from supporting those containers, the Hildon framework also provides a new container widget called HildonPannableArea, a scrolling widget designed for touch screens.

== Pannable area ==
HildonPannableArea is used to create an area with another widget inside which is accessible regardless of the size using the touchscreen to scroll it. You may insert any type of widget into a pannable area and it is always accessible by using the fingers to pan, or scroll, in the area.

This widget can be "panned" (scrolled) in any direction using the touchscreen with the fingers. One remarkable characteristic is that the scrolling is "kinetic", meaning that the motion continues from the initial motion by gradually slowing down to stop.

The use of this widget is very similar to GTK+ scrolled windows. In fact, both widgets implement a similar concept and its APIs are very similar.

To create a new pannable area, choose one of the following functions:

<tt>GtkWidget<nowiki>*</nowiki> '''hildon_pannable_area_new''' (void);
GtkWidget<nowiki>*</nowiki> '''hildon_pannable_area_new_full''' (gint mode,
gboolean enabled,
gdouble vel_min,
gdouble vel_max,
gdouble decel,
guint sps);
</tt>

The first one creates a new pannable area with the properties set to the default values. The second one allows you to set the value of the most important properties of this widget:

* mode: Used to change the behaviour of the pannable area allowing to choose whether to use the "kinetic" effect described above.
* enabled: Enable or disable finger-scroll.
* vel_min, vel_max: Allows developers to adjust how many pixels the child widget moves per "frame".
* decel: Value for the deceleration property.
* sps: Amount of scroll events to generate per second.

The default values of these properties are right for most applications and so the simpler constructor is sufficient. For more information on the properties of the pannable area, see the Hildon reference manual.

Once the area is created, you can place your object into the pannable window using the following function.

<tt>void '''hildon_pannable_area_add_with_viewport''' (HildonPannableArea <nowiki>*</nowiki>area,
GtkWidget <nowiki>*</nowiki>child);
</tt>

That is a convenience function used to add a child to a GtkViewport, and add the viewport to the pannable area.

'''Warning'''

Widgets with native scrolling should be added directly inside a pannable area. Widgets such as, for example, GtkTextView, GtkTreeView, GtkIconView and GtkLayout should be added by calling <code>gtk_container_add()</code>. Otherwise, panning could not work properly.

==Pannable area example ==
Functions explained above are enough for a simple example. The following example packs a table with 100 toggle buttons into a pannable area.

@@IMAGE@@: examples/hildon_pannable_area_example.c output (code )

'''Example 5.1. Example of a pannable area'''

<tt>'''<nowiki>#include</nowiki>''' <stdio.h>
'''<nowiki>#include</nowiki>''' <hildon/hildon.h>

'''static''' GtkWidget <nowiki>*</nowiki>'''create_table''' ()
{

GtkWidget <nowiki>*</nowiki>hbox<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>table<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>button<nowiki>;</nowiki>
char buffer[32];
int i, j<nowiki>;</nowiki>

''/* create a table of 10 by 10 squares. */''
table <nowiki>=</nowiki> '''gtk_table_new''' (10, 10, FALSE);

''/* set the spacing to 10 on x and 10 on y */''
'''gtk_table_set_row_spacings''' ('''GTK_TABLE''' (table), 10);
'''gtk_table_set_col_spacings''' ('''GTK_TABLE''' (table), 10);

'''gtk_widget_show''' (table);

''/* this simply creates a grid of toggle buttons on the table''
'' * to demonstrate the scrolled window. */''
'''for''' (i <nowiki>=</nowiki> 1<nowiki>;</nowiki> i < 10<nowiki>;</nowiki> i++)
'''for''' (j <nowiki>=</nowiki> 1<nowiki>;</nowiki> j < 10<nowiki>;</nowiki> j++) {
'''sprintf''' (buffer, "button (%d,%d)\n", i, j);
button <nowiki>=</nowiki> '''gtk_toggle_button_new_with_label''' (buffer);

'''gtk_table_attach_defaults''' ('''GTK_TABLE''' (table), button,
i, i+1, j, j+1);
}

'''return''' table<nowiki>;</nowiki>
}

int '''main'''( int argc,
char <nowiki>*</nowiki>argv[] )
{
'''static''' GtkWidget <nowiki>*</nowiki>window<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>button<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>pannable_area<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>table<nowiki>;</nowiki>

'''hildon_gtk_init''' (&argc, &argv);

window <nowiki>=</nowiki> '''hildon_stackable_window_new''' ();
'''g_signal_connect''' ('''G_OBJECT''' (window), "destroy",
'''G_CALLBACK''' (gtk_widget_destroy), NULL);

pannable_area <nowiki>=</nowiki> '''hildon_pannable_area_new''' ();

table <nowiki>=</nowiki> '''create_table''' ();

''/* pack the table into the scrolled window */''
'''hildon_pannable_area_add_with_viewport''' (
'''HILDON_PANNABLE_AREA''' (pannable_area), table);

''/* Add the box into the window*/''
'''gtk_container_add''' ('''GTK_CONTAINER''' (window), pannable_area);

'''gtk_widget_show_all''' (window);

'''gtk_main''' ();

'''return''' 0<nowiki>;</nowiki>
}
</tt>

In the example above, two calls are enough to use a pannable area. The rest of the code in the example is no different from that used in a GTK+ application.

<tt> ''/* Create a new pannable area. */''
pannable_area <nowiki>=</nowiki> '''hildon_pannable_area_new''' ();
''/* Pack the table into the pannable area */''
'''hildon_pannable_area_add_with_viewport''' ( '''HILDON_PANNABLE_AREA''' (pannable_area), table);
</tt>

To see all the buttons, users can scroll with the fingers. In this example, horizontal and vertical panning are activated as that is needed to allow users to be able to interact both all the widgets. The property "mov-mode" controls if the area can scroll horizontally, vertically (default value) or both, using HILDON_MOVEMENT_MODE_HORIZ, HILDON_MOVEMENT_MODE_VERT or HILDON_MOVEMENT_MODE_BOTH, respectively.

==Additional features ==
Pannable areas provide a set of convenience functions that make it easier to move to a certain element inside the area without users interaction.

These functions allow to scroll or jump to a position which ensures that a certain point or a certain child widget is visible for the user.

For example, the first of the functions changes the current position on the pannable area to ensure position (x,y) is visible. The movement is a quick jump. The second function performs a smoothly scroll towards the selected position.

<tt>void '''hildon_pannable_area_jump_to''' (HildonPannableArea <nowiki>*</nowiki>area,
'''const''' gint x,
'''const''' gint y);
void '''hildon_pannable_area_scroll_to''' (HildonPannableArea <nowiki>*</nowiki>area,
'''const''' gint x,
'''const''' gint y);
</tt>

The following functions make it possible to jump or scroll to a certain descendent of the area. The argument should be a reference to a descendent widget.

<tt>void '''hildon_pannable_area_jump_to_child''' (HildonPannableArea <nowiki>*</nowiki>area,
GtkWidget <nowiki>*</nowiki>child);
void hildon_pannable_area_scroll_to_child
(HildonPannableArea <nowiki>*</nowiki>area,
GtkWidget <nowiki>*</nowiki>child);
</tt>

Here is a modified version of the previous example. The pannable area is packed into an GtkVBox and a new button is also added to navigate to the last clicked button.

'''Example 5.2. Example of a pannable area and a "jump-to" button'''

<tt>'''<nowiki>#include</nowiki>''' <stdio.h>
'''<nowiki>#include</nowiki>''' <hildon/hildon.h>

GtkWidget <nowiki>*</nowiki> last_clicked_button<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki> pannable_area<nowiki>;</nowiki>

'''static''' void '''destroy'''( GtkWidget <nowiki>*</nowiki>widget,
gpointer data )
{
'''gtk_main_quit''' ();
}

'''static''' void '''clicked''' (GtkButton <nowiki>*</nowiki>button,
gpointer user_data)
{
last_clicked_button <nowiki>=</nowiki> '''GTK_WIDGET''' (button);
}

'''static''' void '''go_to_last_clicked''' (GtkButton <nowiki>*</nowiki>button,
gpointer user_data)
{
''/* hildon_pannable_area_jump_to_child (HILDON_PANNABLE_AREA (pannable_area), */''
''/* last_clicked_button); */''
'''hildon_pannable_area_jump_to_child''' ('''HILDON_PANNABLE_AREA''' (pannable_area),
last_clicked_button);

}

'''static''' GtkWidget <nowiki>*</nowiki>'''create_table''' ()
{

GtkWidget <nowiki>*</nowiki>hbox<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>table<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>button<nowiki>;</nowiki>
char buffer[32];
int i, j<nowiki>;</nowiki>

''/* create a table of 10 by 10 squares. */''
table <nowiki>=</nowiki> '''gtk_table_new''' (10, 10, FALSE);

''/* set the spacing to 10 on x and 10 on y */''
'''gtk_table_set_row_spacings''' ('''GTK_TABLE''' (table), 10);
'''gtk_table_set_col_spacings''' ('''GTK_TABLE''' (table), 10);

'''gtk_widget_show''' (table);

''/* this simply creates a grid of toggle buttons on the table''
'' * to demonstrate the scrolled window. */''
'''for''' (i <nowiki>=</nowiki> 1<nowiki>;</nowiki> i < 10<nowiki>;</nowiki> i++)
'''for''' (j <nowiki>=</nowiki> 1<nowiki>;</nowiki> j < 10<nowiki>;</nowiki> j++) {
'''sprintf''' (buffer, "button (%d,%d)\n", i, j);
button <nowiki>=</nowiki> '''gtk_toggle_button_new_with_label''' (buffer);

'''g_signal_connect''' ('''G_OBJECT''' (button),
"clicked",
'''G_CALLBACK''' (clicked),
NULL);

'''gtk_table_attach_defaults''' ('''GTK_TABLE''' (table), button,
i, i+1, j, j+1);

'''gtk_widget_show''' (button);
}

'''return''' table<nowiki>;</nowiki>
}

int '''main'''( int argc,
char <nowiki>*</nowiki>argv[] )
{
'''static''' GtkWidget <nowiki>*</nowiki>window<nowiki>;</nowiki>
''// GtkWidget *pannable_area;''
GtkWidget <nowiki>*</nowiki>button<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>table<nowiki>;</nowiki>
GtkWidget <nowiki>*</nowiki>hbox<nowiki>;</nowiki>

'''gtk_init''' (&argc, &argv);

''/* Create a new hildon window for the pannable area to be''
'' * packed into. */''
window <nowiki>=</nowiki> '''hildon_stackable_window_new''' ();
'''g_signal_connect''' ('''G_OBJECT''' (window), "destroy",
'''G_CALLBACK''' (destroy), NULL);
'''gtk_window_set_title''' ('''GTK_WINDOW''' (window), "HildonPannableArea example");

''/* Create a table which will be inside the pannable area */''
table <nowiki>=</nowiki> '''create_table''' ();

hbox <nowiki>=</nowiki> '''gtk_hbox_new''' (FALSE, 0);
''/* Add a button to jump */''
''/* Button to go to last clicked */''

button <nowiki>=</nowiki> '''gtk_button_new_with_label''' ("Go to last clicked");
'''gtk_widget_show''' (button);

'''g_signal_connect''' ('''G_OBJECT''' (button),
"clicked",
'''G_CALLBACK''' (go_to_last_clicked),
NULL);

'''gtk_box_pack_start''' ('''GTK_BOX''' (hbox),
button,
TRUE,
TRUE,
0);

''/* create a new pannable area. */''
pannable_area <nowiki>=</nowiki> '''hildon_pannable_area_new''' ();

''/* pack the table into the scrolled window */''
'''hildon_pannable_area_add_with_viewport''' (
'''HILDON_PANNABLE_AREA''' (pannable_area), table);

'''gtk_box_pack_start''' ('''GTK_BOX''' (hbox),
pannable_area,
TRUE,
TRUE,
0);

''// gtk_container_add (GTK_CONTAINER (hbox), pannable_area);''

''//HACK THAT SHOULD DETROYED''
'''g_object_set''' ('''G_OBJECT''' (pannable_area),
"mov-mode", HILDON_MOVEMENT_MODE_BOTH );

''// gtk_container_set_border_width (GTK_CONTAINER (pannable_area), 10);''

''/* Adding pannable area into window*/''
'''gtk_container_add''' ( '''GTK_CONTAINER''' (window), pannable_area);
'''gtk_widget_show''' (hbox);

'''gtk_widget_show_all''' (window);

'''gtk_widget_show''' (pannable_area);

'''gtk_main'''();

'''return''' 0<nowiki>;</nowiki>
}
</tt>

The example used a global variable to store a reference to the last clicked button. This reference is used by the callback go_to_last_clicked to jump to it by calling one of the navigation functions. This function is used as a handler for the signal "clicked" of the button outside the pannable area.

To test the different navigation functions, just change the call in the callback.

When you use the navigation functions that allow to navigate to a certain child, the widget must be already realized. Use the GTK_WIDGET_REALIZED macro to check it. If you want to call it during the initialization process, use the navigation function inside a callback to the "realized" signal, connecting it with <code>g_signal_connect_after()</code>.