git.maemo.org Git - modest/blob - src/hildon2/modest-selector-picker.h

   1 /* Copyright (c) 2006, 2008 Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_SELECTOR_PICKER_H__
  31 #define __MODEST_SELECTOR_PICKER_H__
  32
  33 #include <hildon/hildon-picker-button.h>
  34 #include <modest-pair.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* convenience macros */
  39 #define MODEST_TYPE_SELECTOR_PICKER             (modest_selector_picker_get_type())
  40 #define MODEST_SELECTOR_PICKER(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SELECTOR_PICKER,ModestSelectorPicker))
  41 #define MODEST_SELECTOR_PICKER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_SELECTOR_PICKER,GObject))
  42 #define MODEST_IS_SELECTOR_PICKER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SELECTOR_PICKER))
  43 #define MODEST_IS_SELECTOR_PICKER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_SELECTOR_PICKER))
  44 #define MODEST_SELECTOR_PICKER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_SELECTOR_PICKER,ModestSelectorPickerClass))
  45
  46 typedef struct _ModestSelectorPicker      ModestSelectorPicker;
  47 typedef struct _ModestSelectorPickerClass ModestSelectorPickerClass;
  48
  49 struct _ModestSelectorPicker {
  50          HildonPickerButton parent;
  51         /* insert public members, if any */
  52 };
  53
  54 struct _ModestSelectorPickerClass {
  55         HildonPickerButtonClass parent_class;
  56 };
  57
  58
  59 /* member functions */
  60 GType        modest_selector_picker_get_type    (void) G_GNUC_CONST;
  61
  62 /**
  63  * modest_selector_picker_new
  64  * @pairs: a #ModestPairList; each element should be a ptr to a #ModestPair,
  65  * with the first item in the pair being an opaque ID, and the second item being
  66  * a gchar* string for display.
  67  * If the ID is a string or other non fundamental type, you must make sure that
  68  * the instance remains allocated for the lifetime of this combo box.
  69  * The simplest way to achieve this is to ensure that the ModestPairList exists
  70  * for as long as the combo box.
  71  * @cmp_id_func: a GEqualFunc to compare the ids (= the first elements of the pairs)
  72  * For example, if the ids are strings, you can use g_str_equal.
  73  *
  74  * (If you provide NULL for this parameter, the id ptr address will be compared)
  75  *
  76  * create a new modest selector picker.
  77  *
  78  * Returns: a new ModestSelectorPicker instance, or NULL in case of failure
  79  */
  80 GtkWidget*   modest_selector_picker_new         (ModestPairList* pairs,
  81                                                  GEqualFunc id_equal_func);
  82
  83 /**
  84  * modest_selector_picker_set_pair_list:
  85  * @combo: a #ModestSelectorPicker
  86  * @pairs: a #ModestPairList
  87  *
  88  * sets the model of the picker with a new pair list.
  89  */
  90 void         modest_selector_picker_set_pair_list (ModestSelectorPicker *combo,
  91                                                    ModestPairList *pairs);
  92 /**
  93  * modest_selector_picker_get_active_id
  94  * @self: a valid ModestSelectorPicker instance
  95  *
  96  * get the id for the currently active item, or NULL if there's nothing chosen
  97  * (ie., the id is the first element of the pair)
  98  *
  99  * Returns: the id or NULL if there's nothing chosen.
 100  */
 101 gpointer   modest_selector_picker_get_active_id  (ModestSelectorPicker *self);
 102
 103 /**
 104  * modest_selector_picker_set_active_id
 105  * @self: a valid ModestSelectorPicker instance
 106  * @id: the id to make active
 107  *
 108  * set the active item
 109  *
 110  */
 111 void       modest_selector_picker_set_active_id (ModestSelectorPicker *self, gpointer id);
 112
 113 /**
 114  * modest_selector_picker_get_active_display_name
 115  * @self: a valid ModestSelectorPicker instance
 116  *
 117  * get the display name for the currently active lemma, or NULL if
 118  * there's nothing chosen
 119  *
 120  * Returns: the display name or NULL if there's nothing chosen.
 121  */
 122 const gchar* modest_selector_picker_get_active_display_name  (ModestSelectorPicker *self);
 123
 124 G_END_DECLS
 125
 126 #endif /* __MODEST_SELECTOR_PICKER_H__ */
 127