Maeomm Reference Documentation: hildonmm
Main Page   Namespaces   Book  

Hildon::DateButton Class Reference
[Widgets]

Inheritance diagram for Hildon::DateButton:

Inheritance graph
[legend]

List of all members.


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

Public Member Functions

 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.
 DateButton (Gtk::Hildon::SizeType size, ButtonArrangement arrangement=BUTTON_ARRANGEMENT_HORIZONTAL)
 DateButton ()
void get_date (guint& year, guint& month, guint& day) const
 Retrieves currently selected date from button.
const DateSelectorget_selector () const
 Retrieves the Hildon::TouchSelector associated to button.
DateSelectorget_selector ()
 Retrieves the Hildon::TouchSelector associated to button.
const HildonDateButton* gobj () const
 Provides access to the underlying C GtkObject.
HildonDateButton* gobj ()
 Provides access to the underlying C GtkObject.
void set_date (guint year, guint month, guint day)
 Sets the date in button.
void set_selector (DateSelector& selector)
virtual ~DateButton ()

Related Functions

(Note that these are not member functions.)

Hildon::DateButtonwrap (HildonDateButton* object, bool take_copy=false)
 A Glib::wrap() method for this object.

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
.


Member Function Documentation

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

Retrieves currently selected date from button.

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

const DateSelector* Hildon::DateButton::get_selector (  )  const [inline]

Retrieves the Hildon::TouchSelector associated to button.

Returns:
A Hildon::TouchSelector
.

Reimplemented from Hildon::PickerButton.

References Hildon::PickerButton::get_selector().

DateSelector* Hildon::DateButton::get_selector (  )  [inline]

Retrieves the Hildon::TouchSelector associated to button.

Returns:
A Hildon::TouchSelector
.

Reimplemented from Hildon::PickerButton.

References Hildon::PickerButton::get_selector().

const HildonDateButton* Hildon::DateButton::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Hildon::PickerButton.

HildonDateButton* Hildon::DateButton::gobj (  )  [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.

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

void Hildon::DateButton::set_selector ( DateSelector selector  )  [inline]


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:

Generated for hildonmm by Doxygen 1.5.6 © 1997-2001