Hildon::PickerDialog Class Reference
[Dialogs]

A utility dialog that shows a Hildon::TouchSelector widget. More...

Inheritance diagram for Hildon::PickerDialog:

[legend]

List of all members.

Public Member Functions
virtual	~PickerDialog ()
HildonPickerDialog*	gobj ()
	Provides access to the underlying C GtkObject.
const HildonPickerDialog*	gobj () const
	Provides access to the underlying C GtkObject.
	PickerDialog ()
	PickerDialog (Gtk::Window& parent)
	Creates a new Hildon::PickerButton.
void	set_selector (TouchSelector& selector)
	Sets selector as the Hildon::TouchSelector to be shown in dialog.
TouchSelector*	get_selector ()
	Retrieves the Hildon::TouchSelector associated to dialog.
const TouchSelector*	get_selector () const
	Retrieves the Hildon::TouchSelector associated to dialog.
void	set_done_label (const Glib::ustring& label)
	Sets a custom string to be used as the 'Done' button label in dialog.
Glib::ustring	get_done_label () const
	Retrieves current 'Done' button label.
Related Functions
(Note that these are not member functions.)
Hildon::PickerDialog*	wrap (HildonPickerDialog* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

A utility dialog that shows a Hildon::TouchSelector widget.

Hildon::PickerDialog is a dialog that is used to show a Hildon::TouchSelector widget and a "Done" button to allow users to finish their selections.

The PickerDialog will show a "Done" button in case the Hildon::TouchSelector allows multiple selection. The label of the button can be set using Hildon::PickerDialog::set_done_label() and retrieved using Hildon::PickerDialog::get_done_label().

Note that in most cases developers don't need to deal directly with this dialog. Hildon::PickerButton is designed to pop up a Hildon::PickerDialog and manage the interaction with it.

---

Constructor& Destructor Documentation

virtual Hildon::PickerDialog::~PickerDialog

(

)

[virtual]

Hildon::PickerDialog::PickerDialog

(

)

Hildon::PickerDialog::PickerDialog

(

Gtk::Window &

parent

)

[explicit]

Creates a new Hildon::PickerButton.

See Hildon::Button::new() for details on the parameters.

Parameters:

	size	One of Hildon::SizeType, specifying the size of the new button.
	arrangement	One of Hildon::ButtonArrangement, specifying the placement of the labels.

Returns:

A newly created Hildon::PickerButton

.

---

Member Function Documentation

HildonPickerDialog* Hildon::PickerDialog::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

const HildonPickerDialog* Hildon::PickerDialog::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

void Hildon::PickerDialog::set_selector

(

TouchSelector&

selector

)

Sets selector as the Hildon::TouchSelector to be shown in dialog.

Parameters:

selector

A Hildon::TouchSelector.

Returns:

true if selector was set, false otherwise

.

TouchSelector* Hildon::PickerDialog::get_selector

(

)

Retrieves the Hildon::TouchSelector associated to dialog.

Returns:

A Hildon::TouchSelector

.

const TouchSelector* Hildon::PickerDialog::get_selector

(

)

const

Retrieves the Hildon::TouchSelector associated to dialog.

Returns:

A Hildon::TouchSelector

.

void Hildon::PickerDialog::set_done_label

(

const Glib::ustring &

label

)

Sets a custom string to be used as the 'Done' button label in dialog.

Parameters:

label

A string.

Glib::ustring Hildon::PickerDialog::get_done_label

(

)

const

Retrieves current 'Done' button label.

Returns:

The custom string to be used.

.

---

Friends And Related Function Documentation

Hildon::PickerDialog* wrap	(	HildonPickerDialog *	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:

• picker-dialog.h