HildonBanner

HildonBanner —

Synopsis




            HildonBannerPrivate;
void        hildon_banner_show_information  (GtkWidget *widget,
                                             const gchar *icon_name,
                                             const gchar *text);
void        hildon_banner_show_information_with_markup
                                            (GtkWidget *widget,
                                             const gchar *icon_name,
                                             const gchar *markup);
GtkWidget*  hildon_banner_show_animation    (GtkWidget *widget,
                                             const gchar *animation_name,
                                             const gchar *text);
GtkWidget*  hildon_banner_show_progress     (GtkWidget *widget,
                                             GtkProgressBar *bar,
                                             const gchar *text);
void        hildon_banner_set_text          (HildonBanner *self,
                                             const gchar *text);
void        hildon_banner_set_markup        (HildonBanner *self,
                                             const gchar *markup);
void        hildon_banner_set_fraction      (HildonBanner *self,
                                             gdouble fraction);

Description

Details

HildonBannerPrivate

typedef struct _HildonBannerPrivate HildonBannerPrivate;


hildon_banner_show_information ()

void        hildon_banner_show_information  (GtkWidget *widget,
                                             const gchar *icon_name,
                                             const gchar *text);

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.
text : Text to display

Since 0.12.2


hildon_banner_show_information_with_markup ()

void        hildon_banner_show_information_with_markup
                                            (GtkWidget *widget,
                                             const gchar *icon_name,
                                             const gchar *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)

Since 0.12.8


hildon_banner_show_animation ()

GtkWidget*  hildon_banner_show_animation    (GtkWidget *widget,
                                             const gchar *animation_name,
                                             const gchar *text);

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 ready with the banner.

Since 0.12.2


hildon_banner_show_progress ()

GtkWidget*  hildon_banner_show_progress     (GtkWidget *widget,
                                             GtkProgressBar *bar,
                                             const gchar *text);

Shows progress notification. See hildon_banner_show_animation for more information.

widget : the GtkWidget that wants to display banner
bar : Progressbar to use. You usually can just pass NULL, unless you want somehow customized progress bar.
text : text to display.
Returns : a HildonBanner widget. You must call gtk_widget_destroy once you are ready with the banner.

Since 0.12.2


hildon_banner_set_text ()

void        hildon_banner_set_text          (HildonBanner *self,
                                             const gchar *text);

Sets the text that is displayed in the banner.

self : a HildonBanner widget
text : a new text to display in banner

Since 0.12.2


hildon_banner_set_markup ()

void        hildon_banner_set_markup        (HildonBanner *self,
                                             const gchar *markup);

Sets the text with markup that is displayed in the banner.

self : a HildonBanner widget
markup : a new text with Pango markup to display in the banner

Since 0.12.8


hildon_banner_set_fraction ()

void        hildon_banner_set_fraction      (HildonBanner *self,
                                             gdouble fraction);

The fraction is the completion of progressbar, the scale is from 0.0 to 1.0. Sets the amount of fraction the progressbar has.

self : a HildonBanner widget
fraction : gdouble

Since 0.12.2