Properties

Description

HildonBanner can be used to display a short, timed notification
or information to the user. It can communicate that a
task has been finished or the application state has changed.
Banners should be used only to display non-critical pieces of
information.

Details

HildonBanner

typedef struct _HildonBanner HildonBanner;

hildon_banner_show_information ()

This function creates and displays an information banner that
automatically goes away after certain time period. For each window
in your application there can only be one timed banner, so if you
spawn a new banner before the earlier one has timed out, the
previous one will be replaced.

hildon_banner_show_information_with_markup ()

This function creates and displays an information banner that
automatically goes away after certain time period. For each window
in your application there can only be one timed banner, so if you
spawn a new banner before the earlier one has timed out, the
previous one will be replaced.

widget :

the GtkWidget that wants to display banner

icon_name :

the name of icon to use. Can be NULL for default icon.

markup :

a markup string to display (see Pango markup format)

Returns :

the newly created banner

hildon_banner_show_animation ()

Shows an animated progress notification. It's recommended not to try
to show more than one progress notification at a time, since
they will appear on top of each other. You can use progress
notifications with timed banners. In this case the banners are
located so that you can somehow see both.

Please note that banners are destroyed automatically once the
window they are attached to is closed. The pointer that you
receive with this function do not contain additional references,
so it can become invalid without warning (this is true for
all toplevel windows in gtk). To make sure that the banner do not disapear
automatically, you can separately ref the return value (this
doesn't prevent the banner from disappearing, but the object it just
not finalized). In this case you have to call both gtk_widget_destroy
followed by g_object_unref (in this order).

widget :

the GtkWidget that wants to display banner

animation_name :

The progress animation to use. You usually can just
pass NULL for the default animation.

text :

the text to display.

Returns :

a HildonBanner widget. You must call gtk_widget_destroy
once you are done with the banner.

hildon_banner_set_timeout ()

Sets the timeout on the banner. After the given amount of miliseconds
has elapsed the banner will go away. Note that settings this only makes
sense on the banners that are timed and that have not been yet displayed
on the screen.