Hildon::TimeButton Class Reference
[Widgets, Buttons]

Button displaying and allowing selection of a time. More...

Inheritance diagram for Hildon::TimeButton:

[legend]

List of all members.

Public Member Functions
virtual	~TimeButton ()
HildonTimeButton *	gobj ()
	Provides access to the underlying C GtkObject.
const HildonTimeButton *	gobj () const
	Provides access to the underlying C GtkObject.
	TimeButton ()
	TimeButton (Gtk::Hildon::SizeType size, ButtonArrangement arrangement)
	TimeButton (Gtk::Hildon::SizeType size, ButtonArrangement arrangement, guint minutes_step)
	Creates a new Hildon::TimeButton.
void	set_time (guint hours, guint minutes)
	Sets the time to be displayed in button.
void	get_time (guint &hours, guint &minutes) const
	Retrieves the time from button.
guint	get_hours () const
guint	get_minutes () const
void	set_selector (TimeSelector &selector)
TimeSelector *	get_selector ()
	Retrieves the Hildon::TouchSelector associated to button.
const TimeSelector *	get_selector () const
	Retrieves the Hildon::TouchSelector associated to button.
Related Functions
(Note that these are not member functions.)
Hildon::TimeButton *	wrap (HildonTimeButton *object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

Button displaying and allowing selection of a time.

The TimeButton widget shows a text label and a time, and allows the user to select a different time. Visually, it's a button that, once clicked, presents a Hildon::PickerDialog containing a Hildon::TimeSelector. Once the user selects a different time from the selector, this will be shown in the button.

See also:

Hildon::PickerButton, Hildon::DateButton

---

Constructor & Destructor Documentation

virtual Hildon::TimeButton::~TimeButton

(

)

[virtual]

Hildon::TimeButton::TimeButton

(

)

Hildon::TimeButton::TimeButton	(	Gtk::Hildon::SizeType	size,
		ButtonArrangement	arrangement
	)			[explicit]

Hildon::TimeButton::TimeButton	(	Gtk::Hildon::SizeType	size,
		ButtonArrangement	arrangement,
		guint	minutes_step
	)

Creates a new Hildon::TimeButton.

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

Parameters:

	size	One of Hildon::SizeType.
	arrangement	One of Hildon::ButtonArrangement.
	minutes_step	Step between the minutes in the selector options.

Returns:

A new Hildon::TimeButton

{2,2}.

---

Member Function Documentation

HildonTimeButton* Hildon::TimeButton::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Hildon::PickerButton.

const HildonTimeButton* Hildon::TimeButton::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Hildon::PickerButton.

void Hildon::TimeButton::set_time	(	guint	hours,
		guint	minutes
	)

Sets the time to be displayed in button.

This time will be selected by default on the Hildon::TimeSelector.

{2,2}

Parameters:

	hours	The hours to be set.
	minutes	The time to be set.

void Hildon::TimeButton::get_time	(	guint &	hours,
		guint &	minutes
	)			const

Retrieves the time from button.

{2,2}

Parameters:

	hours	Return location for the hours of the time selected.
	minutes	Return location for the minutes of the time selected.

guint Hildon::TimeButton::get_hours

(

)

const

guint Hildon::TimeButton::get_minutes

(

)

const

void Hildon::TimeButton::set_selector

(

TimeSelector &

selector

)

[inline]

TimeSelector* Hildon::TimeButton::get_selector

(

)

[inline]

Retrieves the Hildon::TouchSelector associated to button.

Returns:

A Hildon::TouchSelector

{2,2}.

Reimplemented from Hildon::PickerButton.

const TimeSelector* Hildon::TimeButton::get_selector

(

)

const [inline]

Retrieves the Hildon::TouchSelector associated to button.

Returns:

A Hildon::TouchSelector

{2,2}.

Reimplemented from Hildon::PickerButton.

---

Friends And Related Function Documentation

Hildon::TimeButton * wrap	(	HildonTimeButton *	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:

• time-button.h