1 /* gtkentrycompletion.h
2 * Copyright (C) 2003 Kristian Rietveld <kris@gtk.org>
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.
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.
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.
20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
24 #ifndef __GTK_ENTRY_COMPLETION_H__
25 #define __GTK_ENTRY_COMPLETION_H__
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>
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))
42 typedef struct _GtkEntryCompletion GtkEntryCompletion;
43 typedef struct _GtkEntryCompletionClass GtkEntryCompletionClass;
44 typedef struct _GtkEntryCompletionPrivate GtkEntryCompletionPrivate;
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()
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>.
60 * Returns: %TRUE if @iter should be displayed as a possible completion
63 typedef gboolean (* GtkEntryCompletionMatchFunc) (GtkEntryCompletion *completion,
69 struct _GtkEntryCompletion
71 GObject parent_instance;
74 GtkEntryCompletionPrivate *priv;
77 struct _GtkEntryCompletionClass
79 GObjectClass parent_class;
81 gboolean (* match_selected) (GtkEntryCompletion *completion,
84 void (* action_activated) (GtkEntryCompletion *completion,
86 gboolean (* insert_prefix) (GtkEntryCompletion *completion,
88 gboolean (* cursor_on_match) (GtkEntryCompletion *completion,
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);
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);
104 GtkWidget *gtk_entry_completion_get_entry (GtkEntryCompletion *completion);
106 void gtk_entry_completion_set_model (GtkEntryCompletion *completion,
107 GtkTreeModel *model);
108 GtkTreeModel *gtk_entry_completion_get_model (GtkEntryCompletion *completion);
110 void gtk_entry_completion_set_match_func (GtkEntryCompletion *completion,
111 GtkEntryCompletionMatchFunc func,
113 GDestroyNotify func_notify);
114 void gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion *completion,
116 gint gtk_entry_completion_get_minimum_key_length (GtkEntryCompletion *completion);
117 void gtk_entry_completion_complete (GtkEntryCompletion *completion);
118 void gtk_entry_completion_insert_prefix (GtkEntryCompletion *completion);
120 void gtk_entry_completion_insert_action_text (GtkEntryCompletion *completion,
123 void gtk_entry_completion_insert_action_markup (GtkEntryCompletion *completion,
125 const gchar *markup);
126 void gtk_entry_completion_delete_action (GtkEntryCompletion *completion,
129 void gtk_entry_completion_set_inline_completion (GtkEntryCompletion *completion,
130 gboolean inline_completion);
131 gboolean gtk_entry_completion_get_inline_completion (GtkEntryCompletion *completion);
132 void gtk_entry_completion_set_inline_selection (GtkEntryCompletion *completion,
133 gboolean inline_selection);
134 gboolean gtk_entry_completion_get_inline_selection (GtkEntryCompletion *completion);
135 void gtk_entry_completion_set_popup_completion (GtkEntryCompletion *completion,
136 gboolean popup_completion);
137 gboolean gtk_entry_completion_get_popup_completion (GtkEntryCompletion *completion);
138 void gtk_entry_completion_set_popup_set_width (GtkEntryCompletion *completion,
139 gboolean popup_set_width);
140 gboolean gtk_entry_completion_get_popup_set_width (GtkEntryCompletion *completion);
141 void gtk_entry_completion_set_popup_single_match (GtkEntryCompletion *completion,
142 gboolean popup_single_match);
143 gboolean gtk_entry_completion_get_popup_single_match (GtkEntryCompletion *completion);
145 const gchar *gtk_entry_completion_get_completion_prefix (GtkEntryCompletion *completion);
147 void gtk_entry_completion_set_text_column (GtkEntryCompletion *completion,
149 gint gtk_entry_completion_get_text_column (GtkEntryCompletion *completion);
153 #endif /* __GTK_ENTRY_COMPLETION_H__ */