gtksearchengine.h 3.73 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * 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
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17 18 19 20 21 22 23 24 25
 *
 * 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"
26
#include "gtkfilesystemmodel.h"
27
#include <gio/gio.h>
28 29 30 31 32 33 34 35 36 37 38 39 40

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;
41 42 43 44
typedef struct _GtkSearchHit GtkSearchHit;

struct _GtkSearchHit
{
45
  GFile *file;
46 47 48
  GFileInfo *info; /* may be NULL */
};

49
struct _GtkSearchEngine
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
{
  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);
  
  /* Signals */
  void     (*hits_added)      (GtkSearchEngine *engine, 
			       GList           *hits);
  void     (*finished)        (GtkSearchEngine *engine);
  void     (*error)           (GtkSearchEngine *engine, 
			       const gchar     *error_message);
};

GType            _gtk_search_engine_get_type        (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);

void	         _gtk_search_engine_hits_added      (GtkSearchEngine *engine, 
						     GList           *hits);
void	         _gtk_search_engine_finished        (GtkSearchEngine *engine);
void	         _gtk_search_engine_error           (GtkSearchEngine *engine, 
						     const gchar     *error_message);
88 89 90
void             _gtk_search_engine_set_recursive   (GtkSearchEngine *engine,
                                                     gboolean         recursive);
gboolean         _gtk_search_engine_get_recursive   (GtkSearchEngine *engine);
91

92 93 94
void             _gtk_search_hit_free (GtkSearchHit *hit);
GtkSearchHit    *_gtk_search_hit_dup (GtkSearchHit *hit);

95 96 97
void             _gtk_search_engine_set_model       (GtkSearchEngine    *engine,
                                                     GtkFileSystemModel *model);

98 99 100
G_END_DECLS

#endif /* __GTK_SEARCH_ENGINE_H__ */