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