Hildon::Banner Class Reference

#include <banner.h>

Inheritance diagram for Hildon::Banner:

List of all members.

Public Member Functions
virtual	~Banner ()
HildonBanner *	gobj ()
	Provides access to the underlying C GtkObject.
const HildonBanner *	gobj () const
	Provides access to the underlying C GtkObject.
void	set_text (const Glib::ustring &text)
	Sets the text that is displayed in the banner.
void	set_markup (const Glib::ustring &markup)
	Sets the text with markup that is displayed in the banner.
void	set_fraction (double fraction)
Static Public Member Functions
static void	show_information (Gtk::Widget &widget, const Glib::ustring &icon_name, const Glib::ustring &text)
	This function creates and displays an information banner that automatically goes away after certain time period.
static void	show_information (Gtk::Widget &widget, const Glib::ustring &text)
static void	show_information_with_markup (Gtk::Widget &widget, const Glib::ustring &icon_name, const Glib::ustring &markup)
	This function creates and displays an information banner that automatically goes away after certain time period.
static void	show_information_with_markup (Gtk::Widget &widget, const Glib::ustring &markup)
static Banner *	show_animation (Gtk::Widget &widget, const Glib::ustring &animation_name, const Glib::ustring &text)
	Shows an animated progress notification.
static Banner *	show_animation (Gtk::Widget &widget, const Glib::ustring &animation_name)
static Banner *	show_progress (Gtk::Widget &widget, Gtk::ProgressBar &bar, const Glib::ustring &text)
	Shows progress notification.
static Banner *	show_progress (Gtk::Widget &widget, const Glib::ustring &text)
Protected Member Functions
	Banner ()
Related Functions
(Note that these are not member functions.)
Hildon::Banner *	wrap (HildonBanner *object, bool take_copy=false)

---

Constructor & Destructor Documentation

virtual Hildon::Banner::~Banner (   )  [virtual]

Hildon::Banner::Banner (   )  [protected]

---

Member Function Documentation

const HildonBanner* Hildon::Banner::gobj (   )  const [inline]

Provides access to the underlying C GtkObject.

HildonBanner* Hildon::Banner::gobj (   )  [inline]

Provides access to the underlying C GtkObject.

void Hildon::Banner::set_fraction (  double  fraction  )

void Hildon::Banner::set_markup (  const Glib::ustring &  markup  )

Sets the text with markup that is displayed in the banner. Since: 0.12.8 Parameters: markup  A new text with Pango markup to display in the banner.

void Hildon::Banner::set_text (  const Glib::ustring &  text  )

Sets the text that is displayed in the banner. Since: 0.12.2 Parameters: text  A new text to display in banner.

static Banner* Hildon::Banner::show_animation (  Gtk::Widget &  widget, const Glib::ustring &  animation_name )  [static]

static Banner* Hildon::Banner::show_animation (  Gtk::Widget &  widget, const Glib::ustring &  animation_name, const Glib::ustring &  text )  [static]

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). Parameters: widget  The Gtk::Widget that wants to display banner. animation_name  The progress animation to use. You usually can just pass 0 for the default animation. text  The text to display. Returns: A Hildon::Banner widget. You must call gtk_widget_destroy once you are ready with the banner. Since: 0.12.2.

static void Hildon::Banner::show_information (  Gtk::Widget &  widget, const Glib::ustring &  text )  [static]

static void Hildon::Banner::show_information (  Gtk::Widget &  widget, const Glib::ustring &  icon_name, const Glib::ustring &  text )  [static]

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. Since: 0.12.2 Parameters: widget  The Gtk::Widget that wants to display banner. icon_name  The name of icon to use. Can be 0 for default icon. text  Text to display.

static void Hildon::Banner::show_information_with_markup (  Gtk::Widget &  widget, const Glib::ustring &  markup )  [static]

static void Hildon::Banner::show_information_with_markup (  Gtk::Widget &  widget, const Glib::ustring &  icon_name, const Glib::ustring &  markup )  [static]

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. Since: 0.12.8 Parameters: widget  The Gtk::Widget that wants to display banner. icon_name  The name of icon to use. Can be 0 for default icon. markup  A markup string to display (see Pango markup format).

static Banner* Hildon::Banner::show_progress (  Gtk::Widget &  widget, const Glib::ustring &  text )  [static]

static Banner* Hildon::Banner::show_progress (  Gtk::Widget &  widget, Gtk::ProgressBar &  bar, const Glib::ustring &  text )  [static]

Shows progress notification. See hildon_banner_show_animation for more information. Parameters: widget  The Gtk::Widget that wants to display banner. bar  Progressbar to use. You usually can just pass 0, unless you want somehow customized progress bar. text  Text to display. Returns: A Hildon::Banner widget. You must call gtk_widget_destroy once you are ready with the banner. Since: 0.12.2.

---

Friends And Related Function Documentation

Hildon::Banner * wrap (  HildonBanner *  object, bool  take_copy = false )  [related]

Parameters: object  The C instance take_copy  False if the result should take ownership of the C instance. True if it should take a new copy or ref. Returns: A C++ instance that wraps this C instance.

---

The documentation for this class was generated from the following file:

• banner.h

---