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_reserved1) (void);
  64   void (*_gtk_reserved2) (void);
  65   void (*_gtk_reserved3) (void);
  66   void (*_gtk_reserved4) (void);
  67 };
  68
  69
  70 /* construction */
  71 GType         gtk_combo_box_get_type         (void) G_GNUC_CONST;
  72 GtkWidget    *gtk_combo_box_new              (void);
  73 GtkWidget    *gtk_combo_box_new_with_entry   (void);
  74 GtkWidget    *gtk_combo_box_new_with_model   (GtkTreeModel    *model);
  75
  76 /* grids */
  77 gint          gtk_combo_box_get_wrap_width         (GtkComboBox *combo_box);
  78 void          gtk_combo_box_set_wrap_width         (GtkComboBox *combo_box,
  79                                                     gint         width);
  80 gint          gtk_combo_box_get_row_span_column    (GtkComboBox *combo_box);
  81 void          gtk_combo_box_set_row_span_column    (GtkComboBox *combo_box,
  82                                                     gint         row_span);
  83 gint          gtk_combo_box_get_column_span_column (GtkComboBox *combo_box);
  84 void          gtk_combo_box_set_column_span_column (GtkComboBox *combo_box,
  85                                                     gint         column_span);
  86
  87 gboolean      gtk_combo_box_get_add_tearoffs       (GtkComboBox *combo_box);
  88 void          gtk_combo_box_set_add_tearoffs       (GtkComboBox *combo_box,
  89                                                     gboolean     add_tearoffs);
  90
  91 G_CONST_RETURN gchar *gtk_combo_box_get_title      (GtkComboBox *combo_box);
  92 void                  gtk_combo_box_set_title      (GtkComboBox *combo_box,
  93                                                     const gchar *title);
  94
  95 gboolean      gtk_combo_box_get_focus_on_click     (GtkComboBox *combo);
  96 void          gtk_combo_box_set_focus_on_click     (GtkComboBox *combo,
  97                                                     gboolean     focus_on_click);
  98
  99 /* get/set active item */
 100 gint          gtk_combo_box_get_active       (GtkComboBox     *combo_box);
 101 void          gtk_combo_box_set_active       (GtkComboBox     *combo_box,
 102                                               gint             index_);
 103 gboolean      gtk_combo_box_get_active_iter  (GtkComboBox     *combo_box,
 104                                               GtkTreeIter     *iter);
 105 void          gtk_combo_box_set_active_iter  (GtkComboBox     *combo_box,
 106                                               GtkTreeIter     *iter);
 107
 108 /* getters and setters */
 109 void          gtk_combo_box_set_model        (GtkComboBox     *combo_box,
 110                                               GtkTreeModel    *model);
 111 GtkTreeModel *gtk_combo_box_get_model        (GtkComboBox     *combo_box);
 112
 113 GtkTreeViewRowSeparatorFunc gtk_combo_box_get_row_separator_func (GtkComboBox                *combo_box);
 114 void                        gtk_combo_box_set_row_separator_func (GtkComboBox                *combo_box,
 115                                                                   GtkTreeViewRowSeparatorFunc func,
 116                                                                   gpointer                    data,
 117                                                                   GDestroyNotify              destroy);
 118
 119 void               gtk_combo_box_set_button_sensitivity (GtkComboBox        *combo_box,
 120                                                          GtkSensitivityType  sensitivity);
 121 GtkSensitivityType gtk_combo_box_get_button_sensitivity (GtkComboBox        *combo_box);
 122
 123 gboolean           gtk_combo_box_get_has_entry          (GtkComboBox        *combo_box);
 124 void               gtk_combo_box_set_entry_text_column  (GtkComboBox        *combo_box,
 125                                                          gint                text_column);
 126 gint               gtk_combo_box_get_entry_text_column  (GtkComboBox        *combo_box);
 127
 128 void               gtk_combo_box_set_popup_fixed_width  (GtkComboBox      *combo_box,
 129                                                          gboolean          fixed);
 130 gboolean           gtk_combo_box_get_popup_fixed_width  (GtkComboBox      *combo_box);
 131
 132 #ifndef GTK_DISABLE_DEPRECATED
 133
 134 /* convenience -- text */
 135 GtkWidget    *gtk_combo_box_new_text         (void);
 136 void          gtk_combo_box_append_text      (GtkComboBox     *combo_box,
 137                                               const gchar     *text);
 138 void          gtk_combo_box_insert_text      (GtkComboBox     *combo_box,
 139                                               gint             position,
 140                                               const gchar     *text);
 141 void          gtk_combo_box_prepend_text     (GtkComboBox     *combo_box,
 142                                               const gchar     *text);
 143 void          gtk_combo_box_remove_text      (GtkComboBox     *combo_box,
 144                                               gint             position);
 145 gchar        *gtk_combo_box_get_active_text  (GtkComboBox     *combo_box);
 146
 147 #endif
 148
 149 /* programmatic control */
 150 void          gtk_combo_box_popup            (GtkComboBox     *combo_box);
 151 void          gtk_combo_box_popup_for_device (GtkComboBox     *combo_box,
 152                                               GdkDevice       *device);
 153 void          gtk_combo_box_popdown          (GtkComboBox     *combo_box);
 154 AtkObject*    gtk_combo_box_get_popup_accessible (GtkComboBox *combo_box);
 155
 156
 157 G_END_DECLS
 158
 159 #endif /* __GTK_COMBO_BOX_H__ */