evolution/widgets/text/e-completion.h

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * e-completion.h - A base class for text completion.
 * Copyright 2000, 2001, Ximian, Inc.
 *
 * Authors:
 *   Miguel de Icaza <miguel@ximian.com>
 *   Adapted by Jon Trowbridge <trow@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * 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, 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 <libgnome/gnome-defs.h>
#include <gtk/gtkobject.h>
#include "e-completion-match.h"

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 gboolean (*ECompletionRefineFn) (ECompletion *, ECompletionMatch *, const gchar *search_text, gint pos);

struct _ECompletion {
	GtkObject parent;

	struct _ECompletionPrivate *priv;
};

struct _ECompletionClass {
	GtkObjectClass parent_class;

	/* virtual functions */
	ECompletionRefineFn (*auto_refine) (ECompletion *comp,
					    const gchar *old_text, gint old_pos,
					    const gchar *new_text, gint new_pos);
	gboolean            ignore_pos_on_auto_unrefine;

	/* Signals */
	void     (*request_completion)  (ECompletion *comp, const gchar *search_text, gint pos, gint limit);

	void     (*begin_completion)    (ECompletion *comp, const gchar *search_text, gint pos, gint limit);
	void     (*restart_completion)  (ECompletion *comp);

	void     (*completion)         (ECompletion *comp, ECompletionMatch *match);
	void     (*lost_completion)    (ECompletion *comp, ECompletionMatch *match);

	void     (*cancel_completion)  (ECompletion *comp);
	void     (*end_completion)     (ECompletion *comp);
	void     (*clear_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);
gboolean     e_completion_refining        (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);

ECompletion *e_completion_new (void);



/* 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, ECompletionMatch *);
void         e_completion_lost_match  (ECompletion *comp, ECompletionMatch *);
void         e_completion_clear       (ECompletion *comp);
void         e_completion_end_search  (ECompletion *comp);

END_GNOME_DECLS


#endif /* E_COMPLETION_H */