libmmanager/mm-application-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_APPLICATION_PROVIDER_H__
  22 #define __MM_APPLICATION_PROVIDER_H__
  23
  24 #include <glib-object.h>
  25
  26 #include "mm-application.h"
  27
  28 #define MM_TYPE_APPLICATION_PROVIDER           (mm_application_provider_get_type ())
  29 #define MM_APPLICATION_PROVIDER(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  30                                                 MM_TYPE_APPLICATION_PROVIDER, MMApplicationProvider))
  31 #define MM_IS_APPLICATION_PROVIDER(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  32                                                 MM_TYPE_APPLICATION_PROVIDER))
  33 #define MM_APPLICATION_PROVIDER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj),\
  34                                                 MM_TYPE_APPLICATION_PROVIDER, MMApplicationProviderIface))
  35
  36 /**
  37  * SECTION:mm-application-provider
  38  * @short_description: provides #MMApplication objects.
  39  *
  40  * A handle to an object implementing the #MMApplicationProviderIface iterface.
  41  * You need this to build a #MMApplication object if you're using #MMModule.
  42  */
  43
  44 /**
  45  * MMApplicationProvider:
  46  *
  47  * An abstract type that specifies an application provider.
  48  */
  49
  50 typedef struct _MMApplicationProvider MMApplicationProvider;
  51 typedef struct _MMApplicationProviderIface MMApplicationProviderIface;
  52
  53 /**
  54  * MMApplicationProviderIface:
  55  * @interface: the parent interface.
  56  * @get_application: Gets the implemented #MMApplication object.
  57  *
  58  * Interface to build #MMApplication objects with #MMModule.
  59  */
  60
  61 struct _MMApplicationProviderIface {
  62   GTypeInterface interface;
  63
  64   MMApplication* (* get_application) (MMApplicationProvider *provider);
  65 };
  66
  67 /* Interface functions */
  68
  69 GType           mm_application_provider_get_type        (void);
  70 MMApplication*  mm_application_provider_get_application (MMApplicationProvider *provider);
  71
  72 #endif /* __MM_APPLICATION_PROVIDER_H__ */