Start documenting objects.
[mmediamanager.git] / libmmanager / mm-application-provider.h
blobdded93b6de3b2136b82c3fd70348ffef8676734a
1 /* MManager - a Desktop wide manager for multimedia applications.
3 * Copyright (C) 2008 Cosimo Cecchi <cosimoc@gnome.org>
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.
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.
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.
21 #ifndef __MM_APPLICATION_PROVIDER_H__
22 #define __MM_APPLICATION_PROVIDER_H__
24 #include <glib-object.h>
26 #include "mm-application.h"
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))
36 /**
37 * MMApplicationProvider:
39 * A handle to an object implementing the #MMApplicationProviderIface iterface.
40 * You need this to build a #MMApplication object if you're using #MMModule.
43 typedef struct _MMApplicationProvider MMApplicationProvider;
44 typedef struct _MMApplicationProviderIface MMApplicationProviderIface;
46 /**
47 * MMApplicationProviderIface:
48 * @interface: the parent interface.
49 * @get_application: Gets the implemented #MMApplication object.
51 * Interface to build #MMApplication objects with #MMModule.
54 struct _MMApplicationProviderIface {
55 GTypeInterface interface;
57 MMApplication* (* get_application) (MMApplicationProvider *provider);
60 /* Interface functions */
62 GType mm_application_provider_get_type (void);
63 MMApplication* mm_application_provider_get_application (MMApplicationProvider *provider);
65 #endif /* __MM_APPLICATION_PROVIDER_H__ */