It seems that the only things left to document are FoobarDetails
[mmediamanager.git] / libmmanager / mm-error.h
blob293efafb3797aba252a1f11ffef145a00f8dbbe0
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_ERROR_H__
22 #define __MM_ERROR_H__
24 #include <glib.h>
26 /**
27 * SECTION:mm-error
28 * @short_description: error codes.
30 * Enumerations for error codes to be used in libmmanager #GError<!-- -->s.
33 /**
34 * MM_XML_ERROR_QUARK:
36 * The #GQuark used for #MMXmlErrorEnum errors.
39 #define MM_XML_ERROR_QUARK g_quark_from_static_string ("MMXmlError")
41 /**
42 * MM_DBUS_ERROR_QUARK:
44 * The #GQuark used for #MMDBusErrorEnum errors.
47 #define MM_DBUS_ERROR_QUARK g_quark_from_static_string ("MMDBusError")
49 /**
50 * MM_SO_ERROR_QUARK:
52 * The #GQuark used for #MMSoErrorEnum errors.
55 #define MM_SO_ERROR_QUARK g_quark_from_static_string ("MMSoError")
57 /**
58 * MMXmlErrorEnum:
59 * @MM_XML_ERROR_UNSERIALIZE_FAILED: An unspecified error occurred.
60 * @MM_XML_ERROR_UNEXPECTED_EOF: The XML buffer ended unexpectedly.
61 * @MM_XML_ERROR_UNEXPECTED_NODE: A node different from the expected one
62 * was found while parsing the XML buffer.
63 * @MM_XML_ERROR_UNKNOWN_GTYPE: Failed to go from XML to #GType because the
64 * type seems to be unknown.
66 * Error codes for libmmanager XML operations.
69 typedef enum {
70 MM_XML_ERROR_UNSERIALIZE_FAILED,
71 MM_XML_ERROR_UNEXPECTED_EOF,
72 MM_XML_ERROR_UNEXPECTED_NODE,
73 MM_XML_ERROR_UNKNOWN_GTYPE
74 } MMXmlErrorEnum;
76 /**
77 * MMDBusErrorEnum:
78 * @MM_DBUS_ERROR_FAILED: An unspecified error occurred.
79 * @MM_DBUS_ERROR_BUS_UNAVAILABLE: Could not connect to the session bus.
80 * @MM_DBUS_ERROR_NULL_ATTRIBUTE: Failed validating the arguments.
81 * @MM_DBUS_ERROR_REMOTE_METHOD_FAILED: A remote method failed to execute.
82 * @MM_DBUS_ERROR_SERIALIZE_FAIL: An error occurred while serializing an
83 * object.
84 * @MM_DBUS_ERROR_UNSERIALIZE_FAIL: An error occurred while unserializing an
85 * object.
87 * Error codes for libmmanager DBus operations.
90 typedef enum {
91 MM_DBUS_ERROR_FAILED,
92 MM_DBUS_ERROR_BUS_UNAVAILABLE,
93 MM_DBUS_ERROR_NULL_ATTRIBUTE,
94 MM_DBUS_ERROR_REMOTE_METHOD_FAILED,
95 MM_DBUS_ERROR_SERIALIZE_FAIL,
96 MM_DBUS_ERROR_UNSERIALIZE_FAIL
97 } MMDBusErrorEnum;
99 /**
100 * MMSoErrorEnum:
101 * @MM_SO_ERROR_FAILED: An unspecified error occurred.
102 * @MM_SO_ERROR_NULL_PROVIDER: Error while validating a provider.
104 * Error codes for libmmanager Shared Object operations.
107 typedef enum {
108 MM_SO_ERROR_FAILED,
109 MM_SO_ERROR_NULL_PROVIDER
110 } MMSoErrorEnum;
112 #endif /* __MM_ERROR_H__ */