vcs.maemo.org Git - hildon/blob - hildon-widgets/hildon-weekday-picker.h

   1 /*
   2  * This file is part of hildon-libs
   3  *
   4  * Copyright (C) 2005 Nokia Corporation.
   5  *
   6  * Contact: Luc Pionchon <luc.pionchon@nokia.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 2.1 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  *
  23  */
  24
  25 #ifndef __HILDON_WEEKDAY_PICKER_H__
  26 #define __HILDON_WEEKDAY_PICKER_H__
  27
  28 #include <gtk/gtkcontainer.h>
  29
  30 G_BEGIN_DECLS
  31 /**
  32  * HILDON_WEEKDAY_PICKER_TYPE:
  33  *
  34  * Macro for getting type of weekday picker.
  35  */
  36 #define HILDON_WEEKDAY_PICKER_TYPE \
  37         ( hildon_weekday_picker_get_type() )
  38 #define HILDON_WEEKDAY_PICKER(obj) \
  39         (GTK_CHECK_CAST (obj, HILDON_WEEKDAY_PICKER_TYPE, \
  40          HildonWeekdayPicker))
  41 #define HILDON_WEEKDAY_PICKER_CLASS(klass) \
  42         (GTK_CHECK_CLASS_CAST ((klass), \
  43          HILDON_WEEKDAY_PICKER_TYPE, HildonWeekdayPickerClass))
  44 #define HILDON_IS_WEEKDAY_PICKER(obj) \
  45         (GTK_CHECK_TYPE (obj, HILDON_WEEKDAY_PICKER_TYPE))
  46 #define HILDON_IS_WEEKDAY_PICKER_CLASS(klass) \
  47         (GTK_CHECK_CLASS_TYPE ((klass), HILDON_WEEKDAY_PICKER_TYPE))
  48 /**
  49  * HildonWeekdayPicker:
  50  *
  51  * Internal struct for weekday picker.
  52  */
  53 typedef struct _HildonWeekdayPicker HildonWeekdayPicker;
  54 typedef struct _HildonWeekdayPickerClass HildonWeekdayPickerClass;
  55
  56 struct _HildonWeekdayPicker {
  57     GtkContainer parent;
  58 };
  59
  60 struct _HildonWeekdayPickerClass {
  61     GtkContainerClass parent_class;
  62
  63     void (*selection_changed) (HildonWeekdayPicker * self);
  64 };
  65
  66 GType hildon_weekday_picker_get_type(void);
  67
  68 /**
  69  * hildon_weekday_picker_new:
  70  *
  71  * Creates a new #HildonWeekdayPicker.
  72  *
  73  * Return value: New #HildonWeekdayPicker.
  74  **/
  75 GtkWidget *hildon_weekday_picker_new(void);
  76
  77 /**
  78  * hildon_weekday_picker_set_day:
  79  * @picker: #HildonWeekdayPicker.
  80  * @day: #GDateWeekday.
  81  *
  82  * Select specified weekday.
  83  *
  84  **/
  85 void hildon_weekday_picker_set_day(HildonWeekdayPicker * picker,
  86                                    GDateWeekday day);
  87
  88 /**
  89  * hildon_weekday_picker_unset_day:
  90  * @picker: #HildonWeekdayPicker.
  91  * @day: #GDateWeekday.
  92  *
  93  * Unselect specified weekday.
  94  *
  95  **/
  96 void hildon_weekday_picker_unset_day(HildonWeekdayPicker * picker,
  97                                      GDateWeekday day);
  98
  99 /**
 100  * hildon_weekday_picker_toggle_day:
 101  * @picker: #HildonWeekdayPicker.
 102  * @day: #GDateWeekday.
 103  *
 104  * Toggle current status of the specified weekday.
 105  *
 106  **/
 107 void hildon_weekday_picker_toggle_day(HildonWeekdayPicker * picker,
 108                                       GDateWeekday day);
 109
 110 /**
 111  * hildon_weekday_picker_set_all:
 112  * @picker: #HildonWeekdayPicker.
 113  *
 114  * Select all weekdays.
 115  *
 116  **/
 117 void hildon_weekday_picker_set_all(HildonWeekdayPicker * picker);
 118
 119 /**
 120  * hildon_weekday_picker_unset_all:
 121  * @picker: #HildonWeekdayPicker.
 122  *
 123  * Unselect all weekdays.
 124  *
 125  **/
 126 void hildon_weekday_picker_unset_all(HildonWeekdayPicker * picker);
 127
 128 /**
 129  * hildon_weekday_picker_isset_day:
 130  * @picker: #HildonWeekdayPicker.
 131  * @day: #GDateWeekday.
 132  *
 133  * Check if the specified weekday is set.
 134  *
 135  * Return value: Set/not set.
 136  **/
 137 gboolean hildon_weekday_picker_isset_day(HildonWeekdayPicker * picker,
 138                                          GDateWeekday day);
 139
 140 G_END_DECLS
 141 #endif