/* gtkentrycompletion.h * Copyright (C) 2003 Kristian Rietveld * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library. If not, see . */ #ifndef __GTK_ENTRY_COMPLETION_H__ #define __GTK_ENTRY_COMPLETION_H__ #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION) #error "Only can be included directly." #endif #include #include #include #include #include #include G_BEGIN_DECLS #define GTK_TYPE_ENTRY_COMPLETION (gtk_entry_completion_get_type ()) #define GTK_ENTRY_COMPLETION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletion)) #define GTK_ENTRY_COMPLETION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletionClass)) #define GTK_IS_ENTRY_COMPLETION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY_COMPLETION)) #define GTK_IS_ENTRY_COMPLETION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY_COMPLETION)) #define GTK_ENTRY_COMPLETION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletionClass)) typedef struct _GtkEntryCompletion GtkEntryCompletion; typedef struct _GtkEntryCompletionClass GtkEntryCompletionClass; typedef struct _GtkEntryCompletionPrivate GtkEntryCompletionPrivate; /** * GtkEntryCompletionMatchFunc: * @completion: the #GtkEntryCompletion * @key: the string to match, normalized and case-folded * @iter: a #GtkTreeIter indicating the row to match * @user_data: user data given to gtk_entry_completion_set_match_func() * * A function which decides whether the row indicated by @iter matches * a given @key, and should be displayed as a possible completion for @key. * Note that @key is normalized and case-folded (see g_utf8_normalize() * and g_utf8_casefold()). If this is not appropriate, match functions * have access to the unmodified key via * `gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry ()))`. * * Returns: %TRUE if @iter should be displayed as a possible completion * for @key */ typedef gboolean (* GtkEntryCompletionMatchFunc) (GtkEntryCompletion *completion, const gchar *key, GtkTreeIter *iter, gpointer user_data); struct _GtkEntryCompletion { GObject parent_instance; /*< private >*/ GtkEntryCompletionPrivate *priv; }; struct _GtkEntryCompletionClass { GObjectClass parent_class; gboolean (* match_selected) (GtkEntryCompletion *completion, GtkTreeModel *model, GtkTreeIter *iter); void (* action_activated) (GtkEntryCompletion *completion, gint index_); gboolean (* insert_prefix) (GtkEntryCompletion *completion, const gchar *prefix); gboolean (* cursor_on_match) (GtkEntryCompletion *completion, GtkTreeModel *model, GtkTreeIter *iter); /* Padding for future expansion */ void (*_gtk_reserved0) (void); void (*_gtk_reserved1) (void); void (*_gtk_reserved2) (void); void (*_gtk_reserved3) (void); }; /* core */ GDK_AVAILABLE_IN_ALL GType gtk_entry_completion_get_type (void) G_GNUC_CONST; GDK_AVAILABLE_IN_ALL GtkEntryCompletion *gtk_entry_completion_new (void); GDK_AVAILABLE_IN_ALL GtkEntryCompletion *gtk_entry_completion_new_with_area (GtkCellArea *area); GDK_AVAILABLE_IN_ALL GtkWidget *gtk_entry_completion_get_entry (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_model (GtkEntryCompletion *completion, GtkTreeModel *model); GDK_AVAILABLE_IN_ALL GtkTreeModel *gtk_entry_completion_get_model (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_match_func (GtkEntryCompletion *completion, GtkEntryCompletionMatchFunc func, gpointer func_data, GDestroyNotify func_notify); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion *completion, gint length); GDK_AVAILABLE_IN_ALL gint gtk_entry_completion_get_minimum_key_length (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_3_4 gchar * gtk_entry_completion_compute_prefix (GtkEntryCompletion *completion, const char *key); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_complete (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_insert_prefix (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_insert_action_text (GtkEntryCompletion *completion, gint index_, const gchar *text); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_insert_action_markup (GtkEntryCompletion *completion, gint index_, const gchar *markup); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_delete_action (GtkEntryCompletion *completion, gint index_); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_inline_completion (GtkEntryCompletion *completion, gboolean inline_completion); GDK_AVAILABLE_IN_ALL gboolean gtk_entry_completion_get_inline_completion (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_inline_selection (GtkEntryCompletion *completion, gboolean inline_selection); GDK_AVAILABLE_IN_ALL gboolean gtk_entry_completion_get_inline_selection (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_popup_completion (GtkEntryCompletion *completion, gboolean popup_completion); GDK_AVAILABLE_IN_ALL gboolean gtk_entry_completion_get_popup_completion (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_popup_set_width (GtkEntryCompletion *completion, gboolean popup_set_width); GDK_AVAILABLE_IN_ALL gboolean gtk_entry_completion_get_popup_set_width (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_popup_single_match (GtkEntryCompletion *completion, gboolean popup_single_match); GDK_AVAILABLE_IN_ALL gboolean gtk_entry_completion_get_popup_single_match (GtkEntryCompletion *completion); GDK_AVAILABLE_IN_ALL const gchar *gtk_entry_completion_get_completion_prefix (GtkEntryCompletion *completion); /* convenience */ GDK_AVAILABLE_IN_ALL void gtk_entry_completion_set_text_column (GtkEntryCompletion *completion, gint column); GDK_AVAILABLE_IN_ALL gint gtk_entry_completion_get_text_column (GtkEntryCompletion *completion); G_END_DECLS #endif /* __GTK_ENTRY_COMPLETION_H__ */