git.maemo.org Git - modest/blob - src/widgets/modest-provider-combo-box.h

   1 /* Copyright (c) 2006, 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_PROVIDER_COMBO_BOX
  31 #define _MODEST_PROVIDER_COMBO_BOX
  32
  33 #include <gtk/gtkcombobox.h>
  34 #include <modest-presets.h>
  35
  36 G_BEGIN_DECLS
  37
  38 #define MODEST_TYPE_PROVIDER_COMBO_BOX modest_provider_combo_box_get_type()
  39
  40 #define MODEST_PROVIDER_COMBO_BOX(obj) \
  41         (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  42         MODEST_TYPE_PROVIDER_COMBO_BOX, ModestProviderComboBox))
  43
  44 #define MODEST_PROVIDER_COMBO_BOX_CLASS(klass) \
  45         (G_TYPE_CHECK_CLASS_CAST ((klass), \
  46         MODEST_TYPE_PROVIDER_COMBO_BOX, ModestProviderComboBoxClass))
  47
  48 #define MODEST_IS_PROVIDER_COMBO_BOX(obj) \
  49         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  50         MODEST_TYPE_PROVIDER_COMBO_BOX))
  51
  52 #define MODEST_IS_PROVIDER_COMBO_BOX_CLASS(klass) \
  53         (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  54         MODEST_TYPE_PROVIDER_COMBO_BOX))
  55
  56 #define MODEST_PROVIDER_COMBO_BOX_GET_CLASS(obj) \
  57         (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  58         MODEST_TYPE_PROVIDER_COMBO_BOX, ModestProviderComboBoxClass))
  59
  60 /** The type of the ID
  61  *
  62  * this means the value of returned by get_active_provider_id will be
  63  * different depending on the value returned by get_active_id_type
  64  *
  65  * If the selected option is a provider then the ID will be the provider ID
  66  * If the selected option is "Other..." the the ID will be 0
  67  * If the selected option is a singleton provider protocol then the ID will be protocol name
  68  **/
  69 typedef enum {
  70         MODEST_PROVIDER_COMBO_BOX_ID_PROVIDER,
  71         MODEST_PROVIDER_COMBO_BOX_ID_OTHER,
  72         MODEST_PROVIDER_COMBO_BOX_ID_PLUGIN_PROTOCOL
  73 } ModestProviderComboBoxIdType;
  74
  75 typedef struct {
  76         GtkComboBox parent;
  77 } ModestProviderComboBox;
  78
  79 typedef struct {
  80         GtkComboBoxClass parent_class;
  81 } ModestProviderComboBoxClass;
  82
  83 GType modest_provider_combo_box_get_type (void);
  84
  85 ModestProviderComboBox* modest_provider_combo_box_new (void);
  86
  87 void modest_provider_combo_box_fill (ModestProviderComboBox *combobox, ModestPresets *presets,
  88                                      gint mcc);
  89
  90 void modest_provider_combo_box_refresh (ModestProviderComboBox *combobox);
  91
  92 gchar* modest_provider_combo_box_get_active_provider_id (ModestProviderComboBox *combobox);
  93
  94 gchar* modest_provider_combo_box_get_active_provider_label (ModestProviderComboBox *combobox);
  95
  96 ModestProviderComboBoxIdType modest_provider_combo_box_get_active_id_type (ModestProviderComboBox *combobox);
  97
  98 void  modest_provider_combo_box_set_others_provider (ModestProviderComboBox *self);
  99
 100
 101 G_END_DECLS
 102
 103 #endif /* _MODEST_PROVIDER_COMBO_BOX */