From 0e3e3e99143b969db1e40d72a0806f5dec5f329b Mon Sep 17 00:00:00 2001 From: Jon Trowbridge Date: Mon, 19 Feb 2001 22:47:23 +0000 Subject: Added. Allows you to attach an ECompletion to an EEntry, and have that 2001-02-19 Jon Trowbridge * gal/e-text/e-entry.c (e_entry_enable_completion_full): Added. Allows you to attach an ECompletion to an EEntry, and have that ECompletion be used for (obviously enough) completions. * gal/e-text/e-completion-view.h, gal/e-text/e-completion-view.c: Added. ECompletionView is a widget for displaying the results of a completion request in a format that is appropriate for a drop-down window. * gal/e-text/e-completion.h, gal/e-text/e-completion.c: Added. ECompletion is a "pure virtual base class" for completion-type operations. It is implemented so that completions can be either synchronous or asynchronous. * gal/e-text/e-text.c: Lots of changes to accomodate the ETextModel changes. First of all, we render embedded text objects as being underlined. We also cause the model to emit the appropriate object activation signal when an embedded object is double-clicked. Also, all of the code that moves the cursor in response to user input has been removed. Instead, the EText now listens for "reposition" events from the underlying model, and bases all cursor motions on those. (get_bounds_item_relative): Fixed bug in the handling of differently-anchored text. Being differently-anchored is not a crime or a perversion --- it is an alternative lifestyle that we have to respect. * gal/e-text/e-text-model-uri.h, gal/e-text/e-text-model-uri.c: A sample ETextModel that converts URIs into embedded objects that get opened in the browser when you double-click them. * gal/e-text/e-text-model-repos.h, gal/e-text/e-text-model-repos.c: Added. A group of simple structures & functions for handling various cursor movement rules. These are the sorts of things that are passed as arguments to ETextModel "reposition" event handlers. * gal/e-text/e-text-model.h, gal/e-text/e-text-model.c: Privitized the ETextModel struct and "methodized" all of the operations, so that derived classes can do arbitrarily respond to get/set requests in arbitrarily strange ways. Also added the concept of declaring regions of the text as "embedded text objects". Finally, caused operations that change the text to emit a "reposition" signal that passes information that can be used by a view (like an EText) to move the cursor or selection in an intelligent way in response to those changes. This means that you can now open two ETexts that look at the same ETextModel, and have the cursor in one do the right thing when you edit the other. (As opposed to producing a lot of potential segfaults, as it was before.) svn path=/trunk/; revision=8280 --- widgets/text/e-completion.h | 95 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 widgets/text/e-completion.h (limited to 'widgets/text/e-completion.h') diff --git a/widgets/text/e-completion.h b/widgets/text/e-completion.h new file mode 100644 index 0000000000..41be79a927 --- /dev/null +++ b/widgets/text/e-completion.h @@ -0,0 +1,95 @@ +/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ + +/* ECompletion - A base class for text completion. + * Copyright (C) 2000, 2001 Ximian, Inc. + * + * Author: Miguel de Icaza + * Adapted by Jon Trowbridge + * + */ + +/* + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 + * USA + */ + +#ifndef E_COMPLETION_H +#define E_COMPLETION_H + +#include +#include + +BEGIN_GNOME_DECLS + +#define E_COMPLETION_TYPE (e_completion_get_type ()) +#define E_COMPLETION(o) (GTK_CHECK_CAST ((o), E_COMPLETION_TYPE, ECompletion)) +#define E_COMPLETION_CLASS(k) (GTK_CHECK_CLASS_CAST ((k), E_COMPLETION_TYPE, ECompletionClass)) +#define E_IS_COMPLETION(o) (GTK_CHECK_TYPE ((o), E_COMPLETION_TYPE)) +#define E_IS_COMPLETION_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_COMPLETION_TYPE)) + +typedef struct _ECompletion ECompletion; +typedef struct _ECompletionClass ECompletionClass; +struct _ECompletionPrivate; + +typedef void (*ECompletionBeginFn) (ECompletion *, const gchar *text, gint pos, gint limit, gpointer user_data); +typedef void (*ECompletionEndFn) (ECompletion *, gboolean finished, gpointer user_data); +typedef void (*ECompletionMatchFn) (const gchar *text, double score, gpointer extra_data, gpointer user_data); + +struct _ECompletion { + GtkObject parent; + + struct _ECompletionPrivate *priv; +}; + +struct _ECompletionClass { + GtkObjectClass parent_class; + + /* Signals */ + void (*begin_completion) (ECompletion *comp); + void (*completion) (ECompletion *comp, const gchar *text, gpointer extra_data); + void (*restart_completion) (ECompletion *comp); + void (*cancel_completion) (ECompletion *comp); + void (*end_completion) (ECompletion *comp); +}; + +GtkType e_completion_get_type (void); + +void e_completion_begin_search (ECompletion *comp, const gchar *text, gint pos, gint limit); +void e_completion_cancel_search (ECompletion *comp); + +gboolean e_completion_searching (ECompletion *comp); +const gchar *e_completion_search_text (ECompletion *comp); +gint e_completion_search_text_pos (ECompletion *comp); +gint e_completion_match_count (ECompletion *comp); +void e_completion_foreach_match (ECompletion *comp, ECompletionMatchFn fn, gpointer user_data); +gpointer e_completion_find_extra_data (ECompletion *comp, const gchar *text); + +void e_completion_construct (ECompletion *comp, ECompletionBeginFn, ECompletionEndFn, gpointer user_data); +ECompletion *e_completion_new (ECompletionBeginFn, ECompletionEndFn, gpointer user_data); + + + +/* These functions should only be called by derived classes or search callbacks, + or very bad things might happen. */ + +void e_completion_found_match (ECompletion *comp, const gchar *completion_text); +void e_completion_found_match_full (ECompletion *comp, const gchar *completion_text, double score, + gpointer extra_data, GtkDestroyNotify extra_data_destructor); +void e_completion_end_search (ECompletion *comp); + +END_GNOME_DECLS + + +#endif /* E_COMPLETION_H */ -- cgit