Pileus Git - ~andy/gtk/blob - gtk/gtkcombobox.h

   1 /* gtkcombobox.h
   2  * Copyright (C) 2002, 2003  Kristian Rietveld <kris@gtk.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_COMBO_BOX_H__
  25 #define __GTK_COMBO_BOX_H__
  26
  27 #include <gtk/gtkbin.h>
  28 #include <gtk/gtktreemodel.h>
  29 #include <gtk/gtktreeview.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define GTK_TYPE_COMBO_BOX             (gtk_combo_box_get_type ())
  34 #define GTK_COMBO_BOX(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_COMBO_BOX, GtkComboBox))
  35 #define GTK_COMBO_BOX_CLASS(vtable)    (G_TYPE_CHECK_CLASS_CAST ((vtable), GTK_TYPE_COMBO_BOX, GtkComboBoxClass))
  36 #define GTK_IS_COMBO_BOX(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_COMBO_BOX))
  37 #define GTK_IS_COMBO_BOX_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), GTK_TYPE_COMBO_BOX))
  38 #define GTK_COMBO_BOX_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), GTK_TYPE_COMBO_BOX, GtkComboBoxClass))
  39
  40 typedef struct _GtkComboBox        GtkComboBox;
  41 typedef struct _GtkComboBoxClass   GtkComboBoxClass;
  42 typedef struct _GtkComboBoxPrivate GtkComboBoxPrivate;
  43
  44 struct _GtkComboBox
  45 {
  46   GtkBin parent_instance;
  47
  48   /*< private >*/
  49   GtkComboBoxPrivate *priv;
  50 };
  51
  52 struct _GtkComboBoxClass
  53 {
  54   GtkBinClass parent_class;
  55
  56   /* signals */
  57   void     (* changed)          (GtkComboBox *combo_box);
  58
  59   /* vfuncs */
  60   gchar *  (* get_active_text)  (GtkComboBox *combo_box);
  61
  62   /* Padding for future expansion */
  63   void (*_gtk_reserved0) (void);
  64   void (*_gtk_reserved1) (void);
  65   void (*_gtk_reserved2) (void);
  66 };
  67
  68
  69 /* construction */
  70 GType         gtk_combo_box_get_type         (void) G_GNUC_CONST;
  71 GtkWidget    *gtk_combo_box_new              (void);
  72 GtkWidget    *gtk_combo_box_new_with_entry   (void);
  73 GtkWidget    *gtk_combo_box_new_with_model   (GtkTreeModel    *model);
  74
  75 /* grids */
  76 gint          gtk_combo_box_get_wrap_width         (GtkComboBox *combo_box);
  77 void          gtk_combo_box_set_wrap_width         (GtkComboBox *combo_box,
  78                                                     gint         width);
  79 gint          gtk_combo_box_get_row_span_column    (GtkComboBox *combo_box);
  80 void          gtk_combo_box_set_row_span_column    (GtkComboBox *combo_box,
  81                                                     gint         row_span);
  82 gint          gtk_combo_box_get_column_span_column (GtkComboBox *combo_box);
  83 void          gtk_combo_box_set_column_span_column (GtkComboBox *combo_box,
  84                                                     gint         column_span);
  85
  86 gboolean      gtk_combo_box_get_add_tearoffs       (GtkComboBox *combo_box);
  87 void          gtk_combo_box_set_add_tearoffs       (GtkComboBox *combo_box,
  88                                                     gboolean     add_tearoffs);
  89
  90 G_CONST_RETURN gchar *gtk_combo_box_get_title      (GtkComboBox *combo_box);
  91 void                  gtk_combo_box_set_title      (GtkComboBox *combo_box,
  92                                                     const gchar *title);
  93
  94 gboolean      gtk_combo_box_get_focus_on_click     (GtkComboBox *combo);
  95 void          gtk_combo_box_set_focus_on_click     (GtkComboBox *combo,
  96                                                     gboolean     focus_on_click);
  97
  98 /* get/set active item */
  99 gint          gtk_combo_box_get_active       (GtkComboBox     *combo_box);
 100 void          gtk_combo_box_set_active       (GtkComboBox     *combo_box,
 101                                               gint             index_);
 102 gboolean      gtk_combo_box_get_active_iter  (GtkComboBox     *combo_box,
 103                                               GtkTreeIter     *iter);
 104 void          gtk_combo_box_set_active_iter  (GtkComboBox     *combo_box,
 105                                               GtkTreeIter     *iter);
 106
 107 /* getters and setters */
 108 void          gtk_combo_box_set_model        (GtkComboBox     *combo_box,
 109                                               GtkTreeModel    *model);
 110 GtkTreeModel *gtk_combo_box_get_model        (GtkComboBox     *combo_box);
 111
 112 GtkTreeViewRowSeparatorFunc gtk_combo_box_get_row_separator_func (GtkComboBox                *combo_box);
 113 void                        gtk_combo_box_set_row_separator_func (GtkComboBox                *combo_box,
 114                                                                   GtkTreeViewRowSeparatorFunc func,
 115                                                                   gpointer                    data,
 116                                                                   GDestroyNotify              destroy);
 117
 118 void               gtk_combo_box_set_button_sensitivity (GtkComboBox        *combo_box,
 119                                                          GtkSensitivityType  sensitivity);
 120 GtkSensitivityType gtk_combo_box_get_button_sensitivity (GtkComboBox        *combo_box);
 121
 122 gboolean           gtk_combo_box_get_has_entry          (GtkComboBox        *combo_box);
 123 void               gtk_combo_box_set_entry_text_column  (GtkComboBox        *combo_box,
 124                                                          gint                text_column);
 125 gint               gtk_combo_box_get_entry_text_column  (GtkComboBox        *combo_box);
 126
 127 /* convenience -- text */
 128 GtkWidget    *gtk_combo_box_new_text         (void);
 129 void          gtk_combo_box_append_text      (GtkComboBox     *combo_box,
 130                                               const gchar     *text);
 131 void          gtk_combo_box_insert_text      (GtkComboBox     *combo_box,
 132                                               gint             position,
 133                                               const gchar     *text);
 134 void          gtk_combo_box_prepend_text     (GtkComboBox     *combo_box,
 135                                               const gchar     *text);
 136 void          gtk_combo_box_remove_text      (GtkComboBox     *combo_box,
 137                                               gint             position);
 138 gchar        *gtk_combo_box_get_active_text  (GtkComboBox     *combo_box);
 139
 140 /* programmatic control */
 141 void          gtk_combo_box_popup            (GtkComboBox     *combo_box);
 142 void          gtk_combo_box_popup_for_device (GtkComboBox     *combo_box,
 143                                               GdkDevice       *device);
 144 void          gtk_combo_box_popdown          (GtkComboBox     *combo_box);
 145 AtkObject*    gtk_combo_box_get_popup_accessible (GtkComboBox *combo_box);
 146
 147
 148 G_END_DECLS
 149
 150 #endif /* __GTK_COMBO_BOX_H__ */