Hildon::Banner Class Reference
[Dialogs]

A widget used to display timed notifications. More...

Inheritance diagram for Hildon::Banner:

[legend]

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_timeout (guint timeout)
	Sets the timeout on the banner.
Static Public Member Functions
static Banner*	show_information (Gtk::Widget& widget, const Glib::ustring& text)
	Create and display a banner.
static Banner*	show_information_with_markup (Gtk::Widget& widget, const Glib::ustring& markup)
	Create and display a banner.
Protected Member Functions
	Banner ()
Related Functions
(Note that these are not member functions.)
Hildon::Banner*	wrap (HildonBanner* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

A widget used to display timed notifications.

Hildon::Banner is a small pop-up window that can be used to display a short, timed notification or information to the user. It can communicate that a task has been finished or that the application state has changed.

Hildon provides convenient funtions to create and show banners. To create and show information banners you can use Hildon::Banner::show_information(), or Hildon::Banner::show_information_with_markup().

Information banners dissapear automatically after a certain period. This is stored in Hildon::Banner::property_timeout() (in miliseconds), and can be changed using Hildon::Banner::set_timeout().

Note that Hildon::Banners should only be used to display non-critical pieces of information.

---

Constructor& Destructor Documentation

virtual Hildon::Banner::~Banner

(

)

[virtual]

Hildon::Banner::Banner

(

)

[protected]

---

Member Function Documentation

HildonBanner* Hildon::Banner::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

const HildonBanner* Hildon::Banner::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Window.

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

Create and display a banner.

This method creates and displays an information banner that automatically goes away after a 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.

Parameters:

	widget	The widget that wants to display a banner.
	text	The text to display.

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

Create and display a banner.

This method creates and displays an information banner that automatically goes away after a 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.

Parameters:

	widget	The widget that wants to display a banner.
	markup	A markup string to display (see Text Attribute Markup).

Returns:

The newly created banner.

void Hildon::Banner::set_text

(

const Glib::ustring &

text

)

Sets the text that is displayed in the banner.

Parameters:

text

A new text to display in banner.

void Hildon::Banner::set_markup

(

const Glib::ustring &

markup

)

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

Parameters:

markup

A new text with Pango markup to display in the banner.

void Hildon::Banner::set_timeout

(

guint

timeout

)

Sets the timeout on the banner.

After the given amount of miliseconds has elapsed the banner will be destroyed. Setting this only makes sense on banners that are timed and that have not been yet displayed on the screen.

Note that this method only has effect if self is an information banner, created using show_information() and show_information_with_markup().

Parameters:

timeout

Timeout to set in miliseconds.

---

Friends And Related Function Documentation

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

A Glib::wrap() method for this object.

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