* SECTION:hildon-time-selector
* @short_description: A widget to select the current time.
*
- * HildonTimeSelector is a time widget, equivalent to hildon-calendar, but with a multi-column
- * approach
+ * #HildonTimeSelector allows users to choose a time by selecting hour
+ * and minute. It also allows choosing between AM or PM format.
*
+ * The currently selected time can be altered with
+ * hildon_time_selector_set_time(), and retrieved using
+ * hildon_time_selector_get_time().
+ *
+ * Use this widget instead of deprecated HildonTimeEditor widget.
*/
-
-#include "hildon-time-selector.h"
-
#define _GNU_SOURCE /* needed for GNU nl_langinfo_l */
#define __USE_GNU /* needed for locale */
#include <time.h>
#include <langinfo.h>
#include <locale.h>
-
#include <gconf/gconf-client.h>
+#include "hildon-time-selector.h"
+
#define HILDON_TIME_SELECTOR_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_TIME_SELECTOR, HildonTimeSelectorPrivate))
#define LAST_YEAR 50 /* since current year */
#define _(String) dgettext("hildon-libs", String)
-
-/* #define _(String) "%I:%M %p" debug purposes */
+#define N_(String) String
/* FIXME: we should get this two props from the clock ui headers */
TOTAL_TIME_COLUMNS
};
+enum
+{
+ PROP_0,
+ PROP_MINUTES_STEP
+};
+
struct _HildonTimeSelectorPrivate
{
GtkTreeModel *hours_model;
GtkTreeModel *minutes_model;
GtkTreeModel *ampm_model;
+ guint minutes_step;
gboolean ampm_format; /* if using am/pm format or 24 h one */
gboolean pm; /* if we are on pm (only useful if ampm_format == TRUE) */
};
static void hildon_time_selector_finalize (GObject * object);
+static GObject* hildon_time_selector_constructor (GType type,
+ guint n_construct_properties,
+ GObjectConstructParam *construct_params);
+static void hildon_time_selector_get_property (GObject *object,
+ guint param_id,
+ GValue *value,
+ GParamSpec *pspec);
+static void hildon_time_selector_set_property (GObject *object,
+ guint param_id,
+ const GValue *value,
+ GParamSpec *pspec);
/* private functions */
static GtkTreeModel *_create_hours_model (HildonTimeSelector * selector);
-static GtkTreeModel *_create_minutes_model (HildonTimeSelector * selector);
+static GtkTreeModel *_create_minutes_model (guint minutes_step);
static GtkTreeModel *_create_ampm_model (HildonTimeSelector * selector);
static void _get_real_time (gint * hours, gint * minutes);
static void _check_ampm_format (HildonTimeSelector * selector);
static void _set_pm (HildonTimeSelector * selector, gboolean pm);
-static gchar *_custom_print_func (HildonTouchSelector * selector);
+static gchar *_custom_print_func (HildonTouchSelector * selector,
+ gpointer user_data);
static void
hildon_time_selector_class_init (HildonTimeSelectorClass * class)
container_class = (GtkContainerClass *) class;
/* GObject */
+ gobject_class->get_property = hildon_time_selector_get_property;
+ gobject_class->set_property = hildon_time_selector_set_property;
+ gobject_class->constructor = hildon_time_selector_constructor;
gobject_class->finalize = hildon_time_selector_finalize;
+ g_object_class_install_property (gobject_class,
+ PROP_MINUTES_STEP,
+ g_param_spec_uint ("minutes-step",
+ "Step between minutes in the model",
+ "Step between the minutes in the list of"
+ " options of the widget ",
+ 1, 30, 1,
+ G_PARAM_READWRITE|G_PARAM_CONSTRUCT_ONLY));
+
/* GtkWidget */
/* GtkContainer */
g_type_class_add_private (object_class, sizeof (HildonTimeSelectorPrivate));
}
-
-static void
-hildon_time_selector_init (HildonTimeSelector * selector)
+static GObject*
+hildon_time_selector_constructor (GType type,
+ guint n_construct_properties,
+ GObjectConstructParam *construct_params)
{
- selector->priv = HILDON_TIME_SELECTOR_GET_PRIVATE (selector);
+ GObject *object;
+ HildonTimeSelector *selector;
+ HildonTouchSelectorColumn *column;
- GTK_WIDGET_SET_FLAGS (GTK_WIDGET (selector), GTK_NO_WINDOW);
- gtk_widget_set_redraw_on_allocate (GTK_WIDGET (selector), FALSE);
+ object = (* G_OBJECT_CLASS (hildon_time_selector_parent_class)->constructor)
+ (type, n_construct_properties, construct_params);
- hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector),
- _custom_print_func);
+ selector = HILDON_TIME_SELECTOR (object);
- _get_real_time (&selector->priv->creation_hours,
- &selector->priv->creation_minutes);
+ selector->priv->hours_model = _create_hours_model (selector);
- _check_ampm_format (selector);
+ column = hildon_touch_selector_append_text_column (HILDON_TOUCH_SELECTOR (selector),
+ selector->priv->hours_model, TRUE);
+ g_object_set (column, "text-column", 0, NULL);
- selector->priv->hours_model = _create_hours_model (selector);
- selector->priv->minutes_model = _create_minutes_model (selector);
- hildon_touch_selector_append_text_column (HILDON_TOUCH_SELECTOR (selector),
- selector->priv->hours_model, TRUE);
+ /* we need initialization parameters in order to create minute models*/
+ selector->priv->minutes_step = selector->priv->minutes_step ? selector->priv->minutes_step : 1;
+
+ selector->priv->minutes_model = _create_minutes_model (selector->priv->minutes_step);
- hildon_touch_selector_append_text_column (HILDON_TOUCH_SELECTOR (selector),
- selector->priv->minutes_model, TRUE);
+ column = hildon_touch_selector_append_text_column (HILDON_TOUCH_SELECTOR (selector),
+ selector->priv->minutes_model, TRUE);
+ g_object_set (column, "text-column", 0, NULL);
if (selector->priv->ampm_format) {
selector->priv->ampm_model = _create_ampm_model (selector);
NULL);
}
+
/* By default we should select the current day */
hildon_time_selector_set_time (selector,
selector->priv->creation_hours,
selector->priv->creation_minutes);
+ return object;
+
}
static void
-hildon_time_selector_finalize (GObject * object)
+hildon_time_selector_init (HildonTimeSelector * selector)
{
- HildonTimeSelector *selector = NULL;
+ selector->priv = HILDON_TIME_SELECTOR_GET_PRIVATE (selector);
- selector = HILDON_TIME_SELECTOR (object);
+ GTK_WIDGET_SET_FLAGS (GTK_WIDGET (selector), GTK_NO_WINDOW);
+ gtk_widget_set_redraw_on_allocate (GTK_WIDGET (selector), FALSE);
+
+ hildon_touch_selector_set_print_func (HILDON_TOUCH_SELECTOR (selector),
+ _custom_print_func);
+
+ _get_real_time (&selector->priv->creation_hours,
+ &selector->priv->creation_minutes);
+
+ _check_ampm_format (selector);
+
+}
+
+static void
+hildon_time_selector_get_property (GObject *object,
+ guint param_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ HildonTimeSelectorPrivate *priv = HILDON_TIME_SELECTOR_GET_PRIVATE (object);
+
+ switch (param_id)
+ {
+ case PROP_MINUTES_STEP:
+ g_value_set_uint (value, priv->minutes_step);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
+ break;
+ }
+}
+
+static void
+hildon_time_selector_set_property (GObject *object,
+ guint param_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ HildonTimeSelectorPrivate *priv = HILDON_TIME_SELECTOR_GET_PRIVATE (object);
+
+ switch (param_id)
+ {
+ case PROP_MINUTES_STEP:
+ priv->minutes_step = g_value_get_uint (value);
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
+ break;
+ }
+}
+
+static void
+hildon_time_selector_finalize (GObject * object)
+{
/* FIXME: FILL ME !! */
(*G_OBJECT_CLASS (hildon_time_selector_parent_class)->finalize) (object);
/* ------------------------------ PRIVATE METHODS ---------------------------- */
static gchar *
-_custom_print_func (HildonTouchSelector * touch_selector)
+_custom_print_func (HildonTouchSelector * touch_selector,
+ gpointer user_data)
{
gchar *result = NULL;
struct tm tm = { 0, 0, 0, 0, 0, 0, 0, 0, 0 };
tm.tm_hour = hours;
if (selector->priv->ampm_format) {
- strftime (string, 255, _("wdgt_va_12h_hours"), &tm);
+ if (selector->priv->pm) {
+ strftime (string, 255, _("wdgt_va_12h_time_pm"), &tm);
+ } else {
+ strftime (string, 255, _("wdgt_va_12h_time_am"), &tm);
+ }
} else {
- strftime (string, 255, _("wdgt_va_24h_hours"), &tm);
+ strftime (string, 255, _("wdgt_va_24h_time"), &tm);
}
}
static GtkTreeModel *
-_create_minutes_model (HildonTimeSelector * selector)
+_create_minutes_model (guint minutes_step)
{
GtkListStore *store_minutes = NULL;
gint i = 0;
- gchar *label = NULL;
+ static gchar label[255];
+ struct tm tm = { 0, 0, 0, 0, 0, 0, 0, 0, 0 };
GtkTreeIter iter;
store_minutes = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_INT);
- for (i = 0; i <= 59; i++) {
- label = g_strdup_printf ("%02d", i);
+ for (i = 0; i <= 59; i=i+minutes_step) {
+ tm.tm_min = i;
+ strftime (label, 255, _("wdgt_va_minutes"), &tm);
gtk_list_store_append (store_minutes, &iter);
gtk_list_store_set (store_minutes, &iter,
COLUMN_STRING, label, COLUMN_INT, i, -1);
- g_free (label);
}
return GTK_TREE_MODEL (store_minutes);
{
GtkListStore *store_hours = NULL;
gint i = 0;
- gchar *label = NULL;
GtkTreeIter iter;
- gint last_hour = 12;
- gint addition = 0;
+ struct tm tm = { 0, 0, 0, 0, 0, 0, 0, 0, 0 };
+ static gchar label[255];
+ static gint range_12h[12] = {12, 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11};
+ static gint range_24h[24] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11,
+ 12,13,14,15,16,17,18,19,20,21,22,23};
+ gint *range = NULL;
+ gint num_elements = 0;
+ gchar *format_string = NULL;
if (selector->priv->ampm_format) {
- last_hour = 12;
- addition = 1;
+ range = range_12h;
+ num_elements = 12;
+ format_string = N_("wdgt_va_12h_hours");
} else {
- last_hour = 24;
- addition = 0;
+ range = range_24h;
+ num_elements = 24;
+ format_string = N_("wdgt_va_24h_hours");
}
store_hours = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_INT);
- for (i = 0; i < last_hour; i++) {
- label = g_strdup_printf ("%02d", i + addition);
+ for (i = 0; i < num_elements; i++) {
+ tm.tm_hour = range[i];
+ strftime (label, 255, _(format_string), &tm);
gtk_list_store_append (store_hours, &iter);
gtk_list_store_set (store_hours, &iter,
- COLUMN_STRING, label, COLUMN_INT, i, -1);
- g_free (label);
+ COLUMN_STRING, label, COLUMN_INT, range[i], -1);
}
return GTK_TREE_MODEL (store_hours);
{
GtkListStore *store_ampm = NULL;
GtkTreeIter iter;
+ static gchar label[255];
store_ampm = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_INT);
+ snprintf (label, 255, _("wdgt_va_am"));
gtk_list_store_append (store_ampm, &iter);
- gtk_list_store_set (store_ampm, &iter, COLUMN_STRING, "am", /* FIXME: use nl_langinfo am/pm strings */
+ gtk_list_store_set (store_ampm, &iter,
+ COLUMN_STRING, label,
COLUMN_INT, 0, -1);
+ snprintf (label, 255, _("wdgt_va_pm"));
gtk_list_store_append (store_ampm, &iter);
gtk_list_store_set (store_ampm, &iter,
- COLUMN_STRING, "pm", COLUMN_INT, 1, -1);
+ COLUMN_STRING, label,
+ COLUMN_INT, 1, -1);
return GTK_TREE_MODEL (store_ampm);
}
g_return_if_fail (HILDON_IS_TIME_SELECTOR (touch_selector));
selector = HILDON_TIME_SELECTOR (touch_selector);
- if (num_column == COLUMN_AMPM) {
- hildon_touch_selector_get_active_iter (HILDON_TOUCH_SELECTOR (selector),
- COLUMN_AMPM, &iter);
- gtk_tree_model_get (selector->priv->ampm_model, &iter, COLUMN_INT, &pm, -1);
+ if (num_column == COLUMN_AMPM &&
+ hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector),
+ COLUMN_AMPM, &iter)) {
+ gtk_tree_model_get (selector->priv->ampm_model, &iter, COLUMN_INT, &pm, -1);
selector->priv->pm = pm;
}
_check_ampm_format (HildonTimeSelector * selector)
{
GConfClient *client = NULL;
- gboolean value = FALSE;
+ gboolean value = TRUE;
GError *error = NULL;
client = gconf_client_get_default ();
g_error_free (error);
}
- selector->priv->ampm_format = value;
+ selector->priv->ampm_format = !value;
selector->priv->pm = TRUE;
}
gtk_tree_model_iter_nth_child (selector->priv->ampm_model, &iter, NULL, pm);
- hildon_touch_selector_set_active_iter (HILDON_TOUCH_SELECTOR (selector),
- COLUMN_AMPM, &iter, FALSE);
+ hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector),
+ COLUMN_AMPM, &iter, FALSE);
}
/* ------------------------------ PUBLIC METHODS ---------------------------- */
* Creates a new #HildonTimeSelector
*
* Returns: a new #HildonTimeSelector
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_time_selector_new ()
return g_object_new (HILDON_TYPE_TIME_SELECTOR, NULL);
}
-/*
- * hours (0-23)
- * minutes (0-59)
- */
+
+/**
+ * hildon_time_selector_new_step:
+ *
+ * Creates a new #HildonTimeSelector
+ * @minutes_step: step between the minutes we are going to show in the
+ * selector
+ *
+ * Returns: a new #HildonTimeSelector
+ *
+ * Since: 2.2
+ **/
+GtkWidget *
+hildon_time_selector_new_step (guint minutes_step)
+{
+ return g_object_new (HILDON_TYPE_TIME_SELECTOR, "minutes-step",
+ minutes_step, NULL);
+}
+
+/**
+ * hildon_time_selector_set_time
+ * @selector: the #HildonTimeSelector
+ * @hours: the current hour (0-23)
+ * @minutes: the current minute (0-59)
+ *
+ * Sets the current active hour on the #HildonTimeSelector widget
+ *
+ * The format of the hours accepted is always 24h format, with a range
+ * (0-23):(0-59).
+ *
+ * Since: 2.2
+ *
+ * Returns: %TRUE on success, %FALSE otherwise
+ **/
gboolean
hildon_time_selector_set_time (HildonTimeSelector * selector,
guint hours, guint minutes)
GtkTreeIter iter;
gint hours_item = 0;
- g_return_val_if_fail (hours >= 0 && hours <= 23, FALSE);
- g_return_val_if_fail (minutes >= 0 && minutes <= 59, FALSE);
+ g_return_val_if_fail (hours <= 23, FALSE);
+ g_return_val_if_fail (minutes <= 59, FALSE);
if (selector->priv->ampm_format) {
- if (hours > 12) {
- hours_item = hours - 13;
- } else {
- hours_item = hours - 1;
- }
-
_set_pm (selector, hours >= 12);
+
+ hours_item = hours - selector->priv->pm * 12;
} else {
hours_item = hours;
}
gtk_tree_model_iter_nth_child (selector->priv->hours_model, &iter, NULL,
hours_item);
- hildon_touch_selector_set_active_iter (HILDON_TOUCH_SELECTOR (selector),
- COLUMN_HOURS, &iter, FALSE);
+ hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector),
+ COLUMN_HOURS, &iter, FALSE);
+ g_assert (selector->priv->minutes_step>0);
+ minutes = minutes/selector->priv->minutes_step;
gtk_tree_model_iter_nth_child (selector->priv->minutes_model, &iter, NULL,
minutes);
- hildon_touch_selector_set_active_iter (HILDON_TOUCH_SELECTOR (selector),
- COLUMN_MINUTES, &iter, FALSE);
+ hildon_touch_selector_select_iter (HILDON_TOUCH_SELECTOR (selector),
+ COLUMN_MINUTES, &iter, FALSE);
return TRUE;
}
+/**
+ * hildon_time_selector_get_time
+ * @selector: the #HildonTimeSelector
+ * @hours: to set the current hour (0-23)
+ * @minutes: to set the current minute (0-59)
+ *
+ * Gets the current active hour on the #HildonTimeSelector widget. Both @year
+ * and @minutes can be NULL.
+ *
+ * This method returns the date always in 24h format, with a range (0-23):(0-59)
+ *
+ * Since: 2.2
+ **/
void
hildon_time_selector_get_time (HildonTimeSelector * selector,
guint * hours, guint * minutes)
GtkTreeIter iter;
if (hours != NULL) {
- hildon_touch_selector_get_active_iter (HILDON_TOUCH_SELECTOR (selector),
- COLUMN_HOURS, &iter);
+ hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector),
+ COLUMN_HOURS, &iter);
gtk_tree_model_get (selector->priv->hours_model,
&iter, COLUMN_INT, hours, -1);
if (selector->priv->ampm_format) {
+ *hours %= 12;
*hours += selector->priv->pm * 12;
}
}
if (minutes != NULL) {
- hildon_touch_selector_get_active_iter (HILDON_TOUCH_SELECTOR (selector),
- COLUMN_MINUTES, &iter);
+ hildon_touch_selector_get_selected (HILDON_TOUCH_SELECTOR (selector),
+ COLUMN_MINUTES, &iter);
gtk_tree_model_get (selector->priv->minutes_model,
&iter, COLUMN_INT, minutes, -1);
}
projects / hildon / blobdiff