1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_COMBO_BOX_H__
31 #define __MODEST_COMBO_BOX_H__
33 #include <gtk/gtkcombobox.h>
34 #include <modest-pair.h>
38 /* convenience macros */
39 #define MODEST_TYPE_COMBO_BOX (modest_combo_box_get_type())
40 #define MODEST_COMBO_BOX(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_COMBO_BOX,ModestComboBox))
41 #define MODEST_COMBO_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_COMBO_BOX,GObject))
42 #define MODEST_IS_COMBO_BOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_COMBO_BOX))
43 #define MODEST_IS_COMBO_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_COMBO_BOX))
44 #define MODEST_COMBO_BOX_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_COMBO_BOX,ModestComboBoxClass))
46 typedef struct _ModestComboBox ModestComboBox;
47 typedef struct _ModestComboBoxClass ModestComboBoxClass;
49 struct _ModestComboBox {
51 /* insert public members, if any */
54 struct _ModestComboBoxClass {
55 GtkComboBoxClass parent_class;
56 /* insert signal callback declarations, eg. */
57 /* void (* my_event) (ModestComboBox* obj); */
61 /* member functions */
62 GType modest_combo_box_get_type (void) G_GNUC_CONST;
65 * modest_combo_box_new
66 * @pairs: a #ModestPairList; each element should be a ptr to a #ModestPair,
67 * with the first item in the pair being an opaque ID, and the second item being
68 * a gchar* string for display.
69 * If the ID is a string or other non fundamental type, you must make sure that
70 * the instance remains allocated for the lifetime of this combo box.
71 * The simplest way to achieve this is to ensure that the ModestPairList exists
72 * for as long as the combo box.
73 * @cmp_id_func: a GEqualFunc to compare the ids (= the first elements of the pairs)
74 * For example, if the ids are strings, you can use g_str_equal.
76 * (If you provide NULL for this parameter, the id ptr address will be compared)
78 * create a new modest combo box
80 * Returns: a new GtkComboBox instance, or NULL in case of failure
82 GtkWidget* modest_combo_box_new (ModestPairList* pairs,
83 GEqualFunc id_equal_func);
86 * modest_combo_box_get_active_id
87 * @self: a valid ModestComboBox instance
89 * get the id for the currently active item, or NULL if there's nothing chosen
90 * (ie., the id is the first element of the pair)
92 * Returns: the id or NULL if there's nothing chosen.
94 gpointer modest_combo_box_get_active_id (ModestComboBox *self);
97 * modest_combo_box_set_active_id
98 * @self: a valid ModestComboBox instance
99 * @id: the id to make active
101 * set the active item
104 void modest_combo_box_set_active_id (ModestComboBox *self, gpointer id);
107 * modest_combo_box_get_active_display_name
108 * @self: a valid ModestComboBox instance
110 * get the display name for the currently active lemma, or NULL if
111 * there's nothing chosen
113 * Returns: the display name or NULL if there's nothing chosen.
115 const gchar* modest_combo_box_get_active_display_name (ModestComboBox *self);
119 #endif /* __MODEST_COMBO_BOX_H__ */