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 * @hash: a ptr to a GSList; each element should be a ptr to
69 * create a new modest combo box
71 * Returns: a new GtkComboBox instance, or NULL in case of failure
73 GtkWidget* modest_combo_box_new (const GSList *hash);
76 * modest_combo_box_get_active_id
77 * @self: a valid ModestComboBox instance
79 * get the id for the currently active lemma, or NULL if there's nothing chosen
81 * Returns: the id or NULL if there's nothing chosen.
83 gpointer modest_combo_box_get_active_id (ModestComboBox *self);
86 * modest_combo_box_get_active_display_name
87 * @self: a valid ModestComboBox instance
89 * get the display name for the currently active lemma, or NULL if
90 * there's nothing chosen
92 * Returns: the display name or NULL if there's nothing chosen.
94 gpointer modest_combo_box_get_active_display_name (ModestComboBox *self);
98 #endif /* __MODEST_COMBO_BOX_H__ */