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

   1 /* gtkentrycompletion.h
   2  * Copyright (C) 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef __GTK_ENTRY_COMPLETION_H__
  19 #define __GTK_ENTRY_COMPLETION_H__
  20
  21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtk.h> can be included directly."
  23 #endif
  24
  25 #include <gtk/gtktreemodel.h>
  26 #include <gtk/gtkliststore.h>
  27 #include <gtk/gtkcellarea.h>
  28 #include <gtk/gtktreeviewcolumn.h>
  29 #include <gtk/gtktreemodelfilter.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define GTK_TYPE_ENTRY_COMPLETION            (gtk_entry_completion_get_type ())
  34 #define GTK_ENTRY_COMPLETION(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletion))
  35 #define GTK_ENTRY_COMPLETION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletionClass))
  36 #define GTK_IS_ENTRY_COMPLETION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY_COMPLETION))
  37 #define GTK_IS_ENTRY_COMPLETION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY_COMPLETION))
  38 #define GTK_ENTRY_COMPLETION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletionClass))
  39
  40 typedef struct _GtkEntryCompletion            GtkEntryCompletion;
  41 typedef struct _GtkEntryCompletionClass       GtkEntryCompletionClass;
  42 typedef struct _GtkEntryCompletionPrivate     GtkEntryCompletionPrivate;
  43
  44 /**
  45  * GtkEntryCompletionMatchFunc:
  46  * @completion: the #GtkEntryCompletion
  47  * @key: the string to match, normalized and case-folded
  48  * @iter: a #GtkTreeIter indicating the row to match
  49  * @user_data: user data given to gtk_entry_completion_set_match_func()
  50  *
  51  * A function which decides whether the row indicated by @iter matches
  52  * a given @key, and should be displayed as a possible completion for @key.
  53  * Note that @key is normalized and case-folded (see g_utf8_normalize()
  54  * and g_utf8_casefold()). If this is not appropriate, match functions
  55  * have access to the unmodified key via
  56  * <literal>gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry (<!-- -->)))</literal>.
  57  *
  58  * Returns: %TRUE if @iter should be displayed as a possible completion
  59  *     for @key
  60  */
  61 typedef gboolean (* GtkEntryCompletionMatchFunc) (GtkEntryCompletion *completion,
  62                                                   const gchar        *key,
  63                                                   GtkTreeIter        *iter,
  64                                                   gpointer            user_data);
  65
  66
  67 struct _GtkEntryCompletion
  68 {
  69   GObject parent_instance;
  70
  71   /*< private >*/
  72   GtkEntryCompletionPrivate *priv;
  73 };
  74
  75 struct _GtkEntryCompletionClass
  76 {
  77   GObjectClass parent_class;
  78
  79   gboolean (* match_selected)   (GtkEntryCompletion *completion,
  80                                  GtkTreeModel       *model,
  81                                  GtkTreeIter        *iter);
  82   void     (* action_activated) (GtkEntryCompletion *completion,
  83                                  gint                index_);
  84   gboolean (* insert_prefix)    (GtkEntryCompletion *completion,
  85                                  const gchar        *prefix);
  86   gboolean (* cursor_on_match)  (GtkEntryCompletion *completion,
  87                                  GtkTreeModel       *model,
  88                                  GtkTreeIter        *iter);
  89
  90   /* Padding for future expansion */
  91   void (*_gtk_reserved0) (void);
  92   void (*_gtk_reserved1) (void);
  93   void (*_gtk_reserved2) (void);
  94   void (*_gtk_reserved3) (void);
  95 };
  96
  97 /* core */
  98 GType               gtk_entry_completion_get_type               (void) G_GNUC_CONST;
  99 GtkEntryCompletion *gtk_entry_completion_new                    (void);
 100 GtkEntryCompletion *gtk_entry_completion_new_with_area          (GtkCellArea                 *area);
 101
 102 GtkWidget          *gtk_entry_completion_get_entry              (GtkEntryCompletion          *completion);
 103
 104 void                gtk_entry_completion_set_model              (GtkEntryCompletion          *completion,
 105                                                                  GtkTreeModel                *model);
 106 GtkTreeModel       *gtk_entry_completion_get_model              (GtkEntryCompletion          *completion);
 107
 108 void                gtk_entry_completion_set_match_func         (GtkEntryCompletion          *completion,
 109                                                                  GtkEntryCompletionMatchFunc  func,
 110                                                                  gpointer                     func_data,
 111                                                                  GDestroyNotify               func_notify);
 112 void                gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion          *completion,
 113                                                                  gint                         length);
 114 gint                gtk_entry_completion_get_minimum_key_length (GtkEntryCompletion          *completion);
 115 GDK_AVAILABLE_IN_3_4
 116 gchar *             gtk_entry_completion_compute_prefix         (GtkEntryCompletion          *completion,
 117                                                                  const char                  *key);
 118 void                gtk_entry_completion_complete               (GtkEntryCompletion          *completion);
 119 void                gtk_entry_completion_insert_prefix          (GtkEntryCompletion          *completion);
 120
 121 void                gtk_entry_completion_insert_action_text     (GtkEntryCompletion          *completion,
 122                                                                  gint                         index_,
 123                                                                  const gchar                 *text);
 124 void                gtk_entry_completion_insert_action_markup   (GtkEntryCompletion          *completion,
 125                                                                  gint                         index_,
 126                                                                  const gchar                 *markup);
 127 void                gtk_entry_completion_delete_action          (GtkEntryCompletion          *completion,
 128                                                                  gint                         index_);
 129
 130 void                gtk_entry_completion_set_inline_completion  (GtkEntryCompletion          *completion,
 131                                                                  gboolean                     inline_completion);
 132 gboolean            gtk_entry_completion_get_inline_completion  (GtkEntryCompletion          *completion);
 133 void                gtk_entry_completion_set_inline_selection  (GtkEntryCompletion          *completion,
 134                                                                  gboolean                     inline_selection);
 135 gboolean            gtk_entry_completion_get_inline_selection  (GtkEntryCompletion          *completion);
 136 void                gtk_entry_completion_set_popup_completion   (GtkEntryCompletion          *completion,
 137                                                                  gboolean                     popup_completion);
 138 gboolean            gtk_entry_completion_get_popup_completion   (GtkEntryCompletion          *completion);
 139 void                gtk_entry_completion_set_popup_set_width    (GtkEntryCompletion          *completion,
 140                                                                  gboolean                     popup_set_width);
 141 gboolean            gtk_entry_completion_get_popup_set_width    (GtkEntryCompletion          *completion);
 142 void                gtk_entry_completion_set_popup_single_match (GtkEntryCompletion          *completion,
 143                                                                  gboolean                     popup_single_match);
 144 gboolean            gtk_entry_completion_get_popup_single_match (GtkEntryCompletion          *completion);
 145
 146 const gchar         *gtk_entry_completion_get_completion_prefix (GtkEntryCompletion *completion);
 147 /* convenience */
 148 void                gtk_entry_completion_set_text_column        (GtkEntryCompletion          *completion,
 149                                                                  gint                         column);
 150 gint                gtk_entry_completion_get_text_column        (GtkEntryCompletion          *completion);
 151
 152 G_END_DECLS
 153
 154 #endif /* __GTK_ENTRY_COMPLETION_H__ */