gtksearchengine.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005 Novell, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 *
 * Author: Anders Carlsson <andersca@imendio.com> 
 *
 * Based on nautilus-search-engine.h
 */
 
#ifndef __GTK_SEARCH_ENGINE_H__
#define __GTK_SEARCH_ENGINE_H__
 
#include "gtkquery.h"
 
G_BEGIN_DECLS
 
#define GTK_TYPE_SEARCH_ENGINE          (_gtk_search_engine_get_type ())
#define GTK_SEARCH_ENGINE(obj)          (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SEARCH_ENGINE, GtkSearchEngine))
#define GTK_SEARCH_ENGINE_CLASS(klass)  (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SEARCH_ENGINE, GtkSearchEngineClass))
#define GTK_IS_SEARCH_ENGINE(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SEARCH_ENGINE))
#define GTK_IS_SEARCH_ENGINE_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SEARCH_ENGINE))
#define GTK_SEARCH_ENGINE_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SEARCH_ENGINE, GtkSearchEngineClass))
 
typedef struct _GtkSearchEngine GtkSearchEngine;
typedef struct _GtkSearchEngineClass GtkSearchEngineClass;
typedef struct _GtkSearchEnginePrivate GtkSearchEnginePrivate;
 
struct _GtkSearchEngine 
{
  GObject parent;
 
  GtkSearchEnginePrivate *priv;
};
 
struct _GtkSearchEngineClass 
{
  GObjectClass parent_class;
  
  /* VTable */
  void     (*set_query)       (GtkSearchEngine *engine, 
                               GtkQuery        *query);
  void     (*start)           (GtkSearchEngine *engine);
  void     (*stop)            (GtkSearchEngine *engine);
  gboolean (*is_indexed)      (GtkSearchEngine *engine);
  
  /* Signals */
  void     (*hits_added)      (GtkSearchEngine *engine, 
                               GList           *hits);
  void     (*hits_subtracted) (GtkSearchEngine *engine, 
                               GList           *hits);
  void     (*finished)        (GtkSearchEngine *engine);
  void     (*error)           (GtkSearchEngine *engine, 
                               const gchar     *error_message);
};
 
GType            _gtk_search_engine_get_type        (void);
gboolean         _gtk_search_engine_enabled         (void);
 
GtkSearchEngine* _gtk_search_engine_new             (void);
 
void             _gtk_search_engine_set_query       (GtkSearchEngine *engine, 
                                                     GtkQuery        *query);
void             _gtk_search_engine_start           (GtkSearchEngine *engine);
void             _gtk_search_engine_stop            (GtkSearchEngine *engine);
gboolean         _gtk_search_engine_is_indexed      (GtkSearchEngine *engine);
 
void             _gtk_search_engine_hits_added      (GtkSearchEngine *engine, 
                                                     GList           *hits);
void             _gtk_search_engine_hits_subtracted (GtkSearchEngine *engine, 
                                                     GList           *hits);
void             _gtk_search_engine_finished        (GtkSearchEngine *engine);
void             _gtk_search_engine_error           (GtkSearchEngine *engine, 
                                                     const gchar     *error_message);
 
G_END_DECLS
 
#endif /* __GTK_SEARCH_ENGINE_H__ */