libmmanager/mm-hit-collection.h

   1 /* MManager - a Desktop wide manager for multimedia applications.
   2  *
   3  * Copyright (C) 2008 Cosimo Cecchi <cosimoc@gnome.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __MM_HIT_COLLECTION_H__
  22 #define __MM_HIT_COLLECTION_H__
  23
  24 #include <glib.h>
  25
  26 #include "mm-hit.h"
  27
  28 #define MM_TYPE_HIT_COLLECTION            (mm_hit_collection_get_type())
  29 #define MM_HIT_COLLECTION(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  30                                            MM_TYPE_HIT_COLLECTION, MMHitCollection))
  31 #define MM_HIT_COLLECTION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),\
  32                                            MM_TYPE_HIT_COLLECTION, MMHitCollectionClass))
  33 #define MM_IS_HIT_COLLECTION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  34                                            MM_TYPE_HIT_COLLECTION))
  35 #define MM_IS_HIT_COLLECTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj),\
  36                                            MM_TYPE_HIT_COLLECTION))
  37 #define MM_HIT_COLLECTION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),\
  38                                            MM_TYPE_HIT_COLLECTION, MMHitCollectionClass))
  39
  40 /**
  41  * SECTION:mm-hit-collection
  42  * @short_description: a collection of #MMHit objects.
  43  *
  44  * #MMHitCollection is a simple collection of #MMHit objects, and encapsulates
  45  * the results of a query.
  46  */
  47
  48 /**
  49  * MMHitCollection:
  50  *
  51  * An object identifying a collection of #MMHit objects.
  52  */
  53
  54 typedef struct _MMHitCollection        MMHitCollection;
  55 typedef struct _MMHitCollectionDetails MMHitCollectionDetails;
  56 typedef struct _MMHitCollectionClass   MMHitCollectionClass;
  57
  58 struct _MMHitCollection {
  59   GObject parent_object;
  60   MMHitCollectionDetails *details;
  61 };
  62
  63 struct _MMHitCollectionClass {
  64   GObjectClass parent_class;
  65 };
  66
  67 MMHitCollection *     mm_hit_collection_new          (void);
  68 void                  mm_hit_collection_add_hit      (MMHitCollection *collection,
  69                                                       MMHit           *hit);
  70 MMHit *               mm_hit_collection_get_next_hit (MMHitCollection *collection);
  71
  72 #endif /* __MM_HIT_COLLECTION_H__ */