Hildon::DateButton Class Reference
[Widgets, Buttons]

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

Inheritance diagram for Hildon::DateButton:

[legend]

List of all members.

Public Member Functions
virtual	~DateButton ()
HildonDateButton *	gobj ()
	Provides access to the underlying C GtkObject.
const HildonDateButton *	gobj () const
	Provides access to the underlying C GtkObject.
	DateButton ()
	DateButton (Gtk::Hildon::SizeType size, ButtonArrangement arrangement=BUTTON_ARRANGEMENT_HORIZONTAL)
	DateButton (Gtk::Hildon::SizeType size, ButtonArrangement arrangement, int min_year, int max_year)
	Creates a new Hildon::DateButton with a specific valid range of years.
void	set_date (guint year, guint month, guint day)
	Sets the date in button.
void	get_date (guint &year, guint &month, guint &day) const
	Retrieves currently selected date from button.
void	set_selector (DateSelector &selector)
DateSelector *	get_selector ()
	Retrieves the Hildon::TouchSelector associated to button.
const DateSelector *	get_selector () const
	Retrieves the Hildon::TouchSelector associated to button.
Related Functions
(Note that these are not member functions.)
Hildon::DateButton *	wrap (HildonDateButton *object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

Button displaying and allowing selection of a date.

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

See also:

Hildon::PickerButton, Hildon::TimeButton

---

Constructor & Destructor Documentation

virtual Hildon::DateButton::~DateButton

(

)

[virtual]

Hildon::DateButton::DateButton

(

)

Hildon::DateButton::DateButton	(	Gtk::Hildon::SizeType	size,
		ButtonArrangement	arrangement = BUTTON_ARRANGEMENT_HORIZONTAL
	)			[explicit]

Hildon::DateButton::DateButton	(	Gtk::Hildon::SizeType	size,
		ButtonArrangement	arrangement,
		int	min_year,
		int	max_year
	)

Creates a new Hildon::DateButton with a specific valid range of years.

See Hildon::DateSelector::new_with_year_range() for details on the range.

Parameters:

	size	One of Hildon::SizeType.
	arrangement	One of Hildon::ButtonArrangement.
	min_year	The minimum available year or -1 to ignore.
	max_year	The maximum available year or -1 to ignore.

Returns:

A new Hildon::DateButton

{2,2}.

---

Member Function Documentation

HildonDateButton* Hildon::DateButton::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Hildon::PickerButton.

const HildonDateButton* Hildon::DateButton::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Hildon::PickerButton.

void Hildon::DateButton::set_date	(	guint	year,
		guint	month,
		guint	day
	)

Sets the date in button.

The date set will be displayed and will be the default selected option on the shown Hildon::DateSelector.

{2,2}

Parameters:

	year	The year to set.
	month	The month number to set.
	day	The day of the month to set.

void Hildon::DateButton::get_date	(	guint &	year,
		guint &	month,
		guint &	day
	)			const

Retrieves currently selected date from button.

{2,2}

Parameters:

	year	Return location for the selected year.
	month	Return location for the selected month.
	day	Return location for the selected day.

void Hildon::DateButton::set_selector

(

DateSelector &

selector

)

[inline]

DateSelector* Hildon::DateButton::get_selector

(

)

[inline]

Retrieves the Hildon::TouchSelector associated to button.

Returns:

A Hildon::TouchSelector

{2,2}.

Reimplemented from Hildon::PickerButton.

const DateSelector* Hildon::DateButton::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::DateButton * wrap	(	HildonDateButton *	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:

• date-button.h