libmmanager/mm-category-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_CATEGORY_PROVIDER_H__
  22 #define __MM_CATEGORY_PROVIDER_H__
  23
  24 #include <glib-object.h>
  25
  26 #include "mm-application.h"
  27
  28 #define MM_TYPE_CATEGORY_PROVIDER           (mm_category_provider_get_type ())
  29 #define MM_CATEGORY_PROVIDER(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  30                                              MM_TYPE_CATEGORY_PROVIDER, MMCategoryProvider))
  31 #define MM_IS_CATEGORY_PROVIDER(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  32                                              MM_TYPE_CATEGORY_PROVIDER))
  33 #define MM_CATEGORY_PROVIDER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj),\
  34                                              MM_TYPE_CATEGORY_PROVIDER, MMCategoryProviderIface))
  35
  36 /**
  37  * SECTION:mm-category-provider
  38  * @short_description: provides #MMCategory objects.
  39  *
  40  * A handle to an object implementing the #MMCategoryProviderIface iterface.
  41  * You need this to get a list of #MMCategory objects for a #MMSoApplication,
  42  * i.e. if you're using #MMModule.
  43  */
  44
  45 /**
  46  * MMCategoryProvider:
  47  *
  48  * An abstract type that provides categories.
  49  */
  50
  51 typedef struct _MMCategoryProvider      MMCategoryProvider;
  52 typedef struct _MMCategoryProviderIface MMCategoryProviderIface;
  53
  54 /**
  55  * MMCategoryProviderIface:
  56  * @interface: the parent interface.
  57  * @get_categories: Gets a #GList of #MMCategory objects provided by the
  58  * application.
  59  *
  60  * Interface to build #MMCategory objects with #MMModule.
  61  */
  62
  63 struct _MMCategoryProviderIface {
  64   GTypeInterface interface;
  65
  66   GList* (* get_categories) (MMCategoryProvider *provider,
  67                              MMApplication      *application);
  68 };
  69
  70 /* Interface functions */
  71 GType           mm_category_provider_get_type        (void);
  72 GList*        mm_category_provider_get_categories  (MMCategoryProvider *provider,
  73                                                     MMApplication      *application);
  74
  75 #endif /* __MM_CATEGORY_PROVIDER_H__ */