libmmanager/mm-hit-collection-provider.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_PROVIDER_H__
  22 #define __MM_HIT_COLLECTION_PROVIDER_H__
  23
  24 #include <glib-object.h>
  25 #include "mm-category.h"
  26 #include "mm-filter.h"
  27
  28 #define MM_TYPE_HIT_COLLECTION_PROVIDER           (mm_hit_collection_provider_get_type ())
  29 #define MM_HIT_COLLECTION_PROVIDER(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  30                                                    MM_TYPE_HIT_COLLECTION_PROVIDER, MMHitCollectionProvider))
  31 #define MM_IS_HIT_COLLECTION_PROVIDER(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  32                                                    MM_TYPE_HIT_COLLECTION_PROVIDER))
  33 #define MM_HIT_COLLECTION_PROVIDER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj),\
  34                                                    MM_TYPE_HIT_COLLECTION_PROVIDER, MMHitCollectionProviderIface))
  35
  36 /**
  37  * SECTION:mm-hit-collection-provider
  38  * @short_description: provides #MMHitCollection objects.
  39  *
  40  * A handle to an object implementing the #MMHitCollectionProvider iterface.
  41  * You need this to get a #MMHitCollection for a #MMSoCategory,
  42  * i.e. if you're using #MMModule.
  43  */
  44
  45 /**
  46  * MMHitCollectionProvider:
  47  *
  48  * An abstract type that provides hit collections.
  49  */
  50
  51 typedef struct _MMHitCollectionProvider      MMHitCollectionProvider;
  52 typedef struct _MMHitCollectionProviderIface MMHitCollectionProviderIface;
  53
  54 /**
  55  * MMHitCollectionProviderIface:
  56  * @interface: the parent interface.
  57  * @get_hits: Gets a #MMHitCollection for the specified category and filter.
  58  *
  59  * Interface to build #MMHitCollection objects with #MMModule.
  60  */
  61
  62 struct _MMHitCollectionProviderIface {
  63   GTypeInterface interface;
  64
  65   MMHitCollection* (*get_hits) (MMHitCollectionProvider *provider,
  66                                 MMCategory              *category,
  67                                 MMFilter                *filter);
  68 };
  69
  70 /* Interface functions */
  71 GType             mm_hit_collection_provider_get_type  (void);
  72 MMHitCollection*  mm_hit_collection_provider_get_hits  (MMHitCollectionProvider *provider,
  73                                                         MMCategory              *category,
  74                                                         MMFilter                *filter);
  75
  76 #endif /* __MM_HIT_COLLECTION_PROVIDER_H__ */