rhythmdb/rhythmdb-query-results.h

   1  /*
   2  *  Copyright (C) 2006  Jonathan Matthew  <jonathan@kaolin.wh9.net>
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2 of the License, or
   7  *  (at your option) any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; if not, write to the Free Software
  16  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.
  17  *
  18  */
  19
  20 #ifndef RHYTHMDB_QUERY_RESULTS_H
  21 #define RHYTHMDB_QUERY_RESULTS_H
  22
  23 /*
  24  * Interface for objects that can handle query results from RhythmDB.
  25  */
  26
  27 #include <glib.h>
  28 #include <glib-object.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define RHYTHMDB_TYPE_QUERY_RESULTS             (rhythmdb_query_results_get_type ())
  33 #define RHYTHMDB_QUERY_RESULTS(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), RHYTHMDB_TYPE_QUERY_RESULTS, RhythmDBQueryResults))
  34 #define RHYTHMDB_IS_QUERY_RESULTS(o)            (G_TYPE_CHECK_INSTANCE_TYPE ((o), RHYTHMDB_TYPE_QUERY_RESULTS))
  35 #define RHYTHMDB_QUERY_RESULTS_GET_IFACE(obj)   (G_TYPE_INSTANCE_GET_INTERFACE ((obj), RHYTHMDB_TYPE_QUERY_RESULTS, RhythmDBQueryResultsIface))
  36
  37 typedef struct _RhythmDBQueryResults RhythmDBQueryResults;
  38 typedef struct _RhythmDBQueryResultsIface RhythmDBQueryResultsIface;
  39
  40 struct _RhythmDBQueryResultsIface
  41 {
  42         GTypeInterface g_iface;
  43
  44         /* vtable */
  45         void    (*set_query)            (RhythmDBQueryResults *results,
  46                                          GPtrArray *query);
  47
  48         void    (*add_results)          (RhythmDBQueryResults *results,
  49                                          GPtrArray *entries);
  50
  51         void    (*query_complete)       (RhythmDBQueryResults *results);
  52 };
  53
  54 GType   rhythmdb_query_results_get_type (void);
  55
  56 void    rhythmdb_query_results_set_query (RhythmDBQueryResults *results,
  57                                           GPtrArray *query);
  58
  59 void    rhythmdb_query_results_add_results (RhythmDBQueryResults *results,
  60                                             GPtrArray *entries);
  61
  62 void    rhythmdb_query_results_query_complete (RhythmDBQueryResults *results);
  63
  64 G_END_DECLS
  65
  66 #endif /* RHYTHMDB_QUERY_RESULTS_H */