Hildon::Note Class Reference
[Dialogs]

A dialog to ask the user for confirmation. More...

Inheritance diagram for Hildon::Note:

[legend]

List of all members.

Public Member Functions
virtual	~Note ()
HildonNote*	gobj ()
	Provides access to the underlying C GtkObject.
const HildonNote*	gobj () const
	Provides access to the underlying C GtkObject.
	Note (NoteType note_type, const Glib::ustring& description=Glib::ustring())
	Note (Gtk::ProgressBar& progressbar, const Glib::ustring& description=Glib::ustring())
	Note (NoteType note_type, Gtk::Window& parent, const Glib::ustring& description=Glib::ustring())
	Note (Gtk::ProgressBar& progressbar, Gtk::Window& parent, const Glib::ustring& description=Glib::ustring())
void	set_button_text (const Glib::ustring& text)
	Sets the text of the button in note.
void	set_button_text (const Glib::ustring& text_ok, const Glib::ustring& text_cancel)
	Sets the text for the buttons in note.
Related Functions
(Note that these are not member functions.)
Hildon::Note*	wrap (HildonNote* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

A dialog to ask the user for confirmation.

Hildon::Note is a convenient way to prompt users for a small amount of input. A simple note contains an information text and, in case of confirmation notes, it shows buttons to confirm or cancel. It also can include a progress bar.

This widget provides convenient constructors to create either information notes, confirmation notes or cancel notes, which are useful to show the progress of a requested task allowing the user to cancel it.

To create information notes you can use Hildon::Note::Note(NoteType, const Glib::ustring&) with Hildon::NOTE_TYPE_INFORMATION, which creates a note with a text and two buttons to confirm or cancel. Note that it is possible to create a confirmation note with customized buttons by using Gtk::Dialog::add_button().

To create a note with a text, a progress bar and a cancel button, the Hildon::Note::Note(Gtk::ProgressBar&, const Glib::ustring&) constructor can be used.

---

Constructor& Destructor Documentation

virtual Hildon::Note::~Note

(

)

[virtual]

Hildon::Note::Note	(	NoteType	note_type,
		const Glib::ustring &	description = Glib::ustring()
	)			[explicit]

Hildon::Note::Note	(	Gtk::ProgressBar &	progressbar,
		const Glib::ustring &	description = Glib::ustring()
	)			[explicit]

Hildon::Note::Note	(	NoteType	note_type,
		Gtk::Window &	parent,
		const Glib::ustring &	description = Glib::ustring()
	)

Hildon::Note::Note	(	Gtk::ProgressBar &	progressbar,
		Gtk::Window &	parent,
		const Glib::ustring &	description = Glib::ustring()
	)

---

Member Function Documentation

HildonNote* Hildon::Note::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

const HildonNote* Hildon::Note::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

void Hildon::Note::set_button_text

(

const Glib::ustring &

text

)

Sets the text of the button in note.

Parameters:

text

Sets the button text. If there are two buttons in dialog, the button texts will be <text>, "Cancel".

void Hildon::Note::set_button_text	(	const Glib::ustring &	text_ok,
		const Glib::ustring &	text_cancel
	)

Sets the text for the buttons in note.

Parameters:

	text_ok	The new text of the default OK button.
	text_cancel	The new text of the default cancel button.

---

Friends And Related Function Documentation

Hildon::Note* wrap	(	HildonNote *	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:

• note.h