Hildon::TimeEditor Class Reference

#include <time-editor.h>

Inheritance diagram for Hildon::TimeEditor:

List of all members.

Public Member Functions
virtual	~TimeEditor ()
HildonTimeEditor *	gobj ()
	Provides access to the underlying C GtkObject.
const HildonTimeEditor *	gobj () const
	Provides access to the underlying C GtkObject.
	TimeEditor ()
void	set_time (guint hours, guint minutes, guint seconds)
	This function sets the time on an existing time editor.
void	get_time (guint &hours, guint &minutes, guint &seconds)
	Gets the time of the Hildon::TimeEditor widget.
void	set_duration_range (guint min_seconds, guint max_seconds)
	Sets the duration editor time range of the Hildon::TimeEditor widget.
void	get_duration_range (guint &min_seconds, guint &max_seconds) const
	Gets the duration editor time range of the Hildon::TimeEditor widget.
void	set_ticks (guint ticks)
	Sets the current duration in seconds.
guint	get_ticks () const
	This function returns the current duration, in seconds.
void	set_show_seconds (bool show_seconds=true)
	This function shows or hides the seconds field.
bool	get_show_seconds () const
	This function returns a boolean indicating the visibility of seconds in the Hildon::TimeEditor.
void	set_duration_mode (bool duration_mode=true)
	This function sets the duration editor mode in which the maximum hours is 99.
bool	get_duration_mode () const
	This function returns a boolean indicating whether the Hildon::TimeEditor is in the duration mode.
void	set_duration_min (guint duration_min)
	Sets the minimum allowed duration for the duration mode.
guint	get_duration_min () const
	This function returns the smallest duration the Hildon::TimeEditor allows in the duration mode.
void	set_duration_max (guint duration_max)
	Sets the maximum allowed duration in seconds for the duration mode.
guint	get_duration_max () const
	This function returns the longest duration the Hildon::TimeEditor allows in the duration mode.
void	set_show_hours (gboolean show=true)
	This function shows or hides the hours field.
bool	get_show_hours ()
	This function returns a boolean indicating the visibility of hours in the HildonTimeEditor.
Related Functions
(Note that these are not member functions.)
Hildon::TimeEditor *	wrap (HildonTimeEditor *object, bool take_copy=false)

---

Constructor & Destructor Documentation

virtual Hildon::TimeEditor::~TimeEditor (   )  [virtual]

Hildon::TimeEditor::TimeEditor (   )

---

Member Function Documentation

guint Hildon::TimeEditor::get_duration_max (   )  const

This function returns the longest duration the Hildon::TimeEditor allows in the duration mode. Returns: Maximum allowed duration in seconds.

guint Hildon::TimeEditor::get_duration_min (   )  const

This function returns the smallest duration the Hildon::TimeEditor allows in the duration mode. Returns: Minimum allowed duration in seconds.

bool Hildon::TimeEditor::get_duration_mode (   )  const

This function returns a boolean indicating whether the Hildon::TimeEditor is in the duration mode. Returns: true if the Hildon::TimeEditor is in duration mode.

void Hildon::TimeEditor::get_duration_range (  guint &  min_seconds, guint &  max_seconds )  const

Gets the duration editor time range of the Hildon::TimeEditor widget. Parameters: min_seconds  Pointer to unsigned int. max_seconds  Pointer to unsigned int.

bool Hildon::TimeEditor::get_show_hours (   )

This function returns a boolean indicating the visibility of hours in the HildonTimeEditor. Returns: true if hours are visible. Since: 0.12.4-1.

bool Hildon::TimeEditor::get_show_seconds (   )  const

This function returns a boolean indicating the visibility of seconds in the Hildon::TimeEditor. Returns: true if the seconds are visible.

guint Hildon::TimeEditor::get_ticks (   )  const

This function returns the current duration, in seconds. This means seconds from midnight, if not in duration mode. Returns: Current duration in seconds.

void Hildon::TimeEditor::get_time (  guint &  hours, guint &  minutes, guint &  seconds )

Gets the time of the Hildon::TimeEditor widget. The time returned is always in 24h format. Parameters: hours  Hours. minutes  Minutes. seconds  Seconds.

const HildonTimeEditor* Hildon::TimeEditor::gobj (   )  const [inline]

Provides access to the underlying C GtkObject.

HildonTimeEditor* Hildon::TimeEditor::gobj (   )  [inline]

Provides access to the underlying C GtkObject.

void Hildon::TimeEditor::set_duration_max (  guint  duration_max  )

Sets the maximum allowed duration in seconds for the duration mode. Note: Has no effect in time mode Parameters: duration_max  Maximum allowed duration in seconds.

void Hildon::TimeEditor::set_duration_min (  guint  duration_min  )

Sets the minimum allowed duration for the duration mode. Note: Has no effect in time mode Parameters: duration_min  Mimimum allowed duration.

void Hildon::TimeEditor::set_duration_mode (  bool  duration_mode = true  )

This function sets the duration editor mode in which the maximum hours is 99. Parameters: duration_mode  Enable or disable duration editor mode.

void Hildon::TimeEditor::set_duration_range (  guint  min_seconds, guint  max_seconds )

Sets the duration editor time range of the Hildon::TimeEditor widget. Parameters: min_seconds  Minimum allowed time in seconds. max_seconds  Maximum allowed time in seconds.

void Hildon::TimeEditor::set_show_hours (  gboolean  show = true  )

This function shows or hides the hours field. Since: 0.12.4 Parameters: enable  Enable or disable showing of hours.

void Hildon::TimeEditor::set_show_seconds (  bool  show_seconds = true  )

This function shows or hides the seconds field. Parameters: show_seconds  Enable or disable showing of seconds.

void Hildon::TimeEditor::set_ticks (  guint  ticks  )

Sets the current duration in seconds. This means seconds from midnight, if not in duration mode. In case of any errors, it tries to fix it. Parameters: ticks  The duration to set, in seconds.

void Hildon::TimeEditor::set_time (  guint  hours, guint  minutes, guint  seconds )

This function sets the time on an existing time editor. If the time specified by the arguments is invalid, it's fixed. The time is assumed to be in 24h format. Parameters: hours  Hours. minutes  Minutes. seconds  Seconds.

---

Friends And Related Function Documentation

Hildon::TimeEditor * wrap (  HildonTimeEditor *  object, bool  take_copy = false )  [related]

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-editor.h

---