X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtkentrycompletion.h;h=726685c75be51ad8cbeffb2eecb3f48039eb03b7;hb=9d0febc9a64a5bfb0fcfc3a88de4757f6c1ff090;hp=26285d2ac64a51acfe801cd8d2c1a2352804f3c5;hpb=f478d9f0f61d46102507a034f63919a5c9cb0e04;p=~andy%2Fgtk diff --git a/gtk/gtkentrycompletion.h b/gtk/gtkentrycompletion.h index 26285d2ac..726685c75 100644 --- a/gtk/gtkentrycompletion.h +++ b/gtk/gtkentrycompletion.h @@ -12,18 +12,19 @@ * 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, write to the - * Free Software Foundation, Inc., 59 Temple Place - Suite 330, - * Boston, MA 02111-1307, USA. + * License along with this library. If not, see . */ +#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION) +#error "Only can be included directly." +#endif + #ifndef __GTK_ENTRY_COMPLETION_H__ #define __GTK_ENTRY_COMPLETION_H__ -#include - #include #include +#include #include #include @@ -40,6 +41,23 @@ 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, @@ -64,19 +82,22 @@ struct _GtkEntryCompletionClass void (* action_activated) (GtkEntryCompletion *completion, gint index_); gboolean (* insert_prefix) (GtkEntryCompletion *completion, - const gchar *prefix); + const gchar *prefix); gboolean (* cursor_on_match) (GtkEntryCompletion *completion, - GtkTreeModel *model, - GtkTreeIter *iter); + 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 */ GType gtk_entry_completion_get_type (void) G_GNUC_CONST; GtkEntryCompletion *gtk_entry_completion_new (void); +GtkEntryCompletion *gtk_entry_completion_new_with_area (GtkCellArea *area); GtkWidget *gtk_entry_completion_get_entry (GtkEntryCompletion *completion); @@ -91,6 +112,9 @@ void gtk_entry_completion_set_match_func (GtkEntryComplet void gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion *completion, gint length); 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); void gtk_entry_completion_complete (GtkEntryCompletion *completion); void gtk_entry_completion_insert_prefix (GtkEntryCompletion *completion); @@ -119,8 +143,7 @@ void gtk_entry_completion_set_popup_single_match (GtkEntryComplet gboolean popup_single_match); gboolean gtk_entry_completion_get_popup_single_match (GtkEntryCompletion *completion); -void gtk_entry_completion_insert_completion_text (GtkEntryCompletion *completion, - const gchar *text); +const gchar *gtk_entry_completion_get_completion_prefix (GtkEntryCompletion *completion); /* convenience */ void gtk_entry_completion_set_text_column (GtkEntryCompletion *completion, gint column);