Keep on documenting methods.
[mmediamanager.git] / src / mm-attribute-manager.c
blob90160232e9dce372d754ee204feb5da5ae88a3f2
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 #include "mm-attribute-manager.h"
23 #include <glib.h>
24 #include <glib-object.h>
26 static void
27 mm_attribute_manager_base_init (gpointer g_class)
32 GType
33 mm_attribute_manager_get_type (void)
35 static GType type = 0;
37 if (G_UNLIKELY (type == 0)) {
38 const GTypeInfo our_info = {
39 sizeof (MMAttributeManagerIface),
40 mm_attribute_manager_base_init,
41 NULL,
44 type = g_type_register_static (G_TYPE_INTERFACE,
45 "MMAttributeManager",
46 &our_info, (GTypeFlags) 0);
49 return type;
52 /* public methods */
54 /**
55 * mm_attribute_manager_get_supported_attributes:
56 * @am: a #MMAttributeManager.
58 * Gets a list of all the #MMAttribute<!-- --!>s supported by @am.
60 * Return value: a #GList containing all the #MMAttribute<!-- --!>s supported by
61 * @am. Use #g_list_free when done with it.
64 GList *
65 mm_attribute_manager_get_supported_attributes (MMAttributeManager *am)
67 MMAttributeManagerIface *iface = MM_ATTRIBUTE_MANAGER_GET_IFACE (am);
69 return iface->get_supported_attributes (am);
72 /**
73 * mm_attribute_manager_lookup_attribute:
74 * @am: a #MMAttributeManager.
75 * @id: a #MMAttribute unique identifier.
77 * Looks up the #MMAttribute identified by @id among those supported by @am.
79 * Return value: a #MMAttribute if the attribute is found, %NULL else. You
80 * must not modify or free the #MMAttribute got this way.
83 MMAttribute *
84 mm_attribute_manager_lookup_attribute (MMAttributeManager *am,
85 const char *id)
87 MMAttributeManagerIface *iface = MM_ATTRIBUTE_MANAGER_GET_IFACE (am);
89 return iface->lookup_attribute (am, id);