gio/gdbusobject.h

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   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.1 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
  16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: David Zeuthen <davidz@redhat.com>
  19  */
  20
  21 #ifndef __G_DBUS_OBJECT_H__
  22 #define __G_DBUS_OBJECT_H__
  23
  24 #include <gio/giotypes.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define G_TYPE_DBUS_OBJECT         (g_dbus_object_get_type())
  29 #define G_DBUS_OBJECT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_OBJECT, GDBusObject))
  30 #define G_IS_DBUS_OBJECT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_OBJECT))
  31 #define G_DBUS_OBJECT_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), G_TYPE_DBUS_OBJECT, GDBusObjectIface))
  32
  33 typedef struct _GDBusObjectIface GDBusObjectIface;
  34
  35 /**
  36  * GDBusObjectIface:
  37  * @parent_iface: The parent interface.
  38  * @get_object_path: Returns the object path. See g_dbus_object_get_object_path().
  39  * @get_interfaces: Returns all interfaces. See g_dbus_object_get_interfaces().
  40  * @get_interface: Returns an interface by name. See g_dbus_object_get_interface().
  41  * @interface_added: Signal handler for the #GDBusObject::interface-added signal.
  42  * @interface_removed: Signal handler for the #GDBusObject::interface-removed signal.
  43  *
  44  * Base object type for D-Bus objects.
  45  *
  46  * Since: 2.30
  47  */
  48 struct _GDBusObjectIface
  49 {
  50   GTypeInterface parent_iface;
  51
  52   /* Virtual Functions */
  53   const gchar     *(*get_object_path) (GDBusObject  *object);
  54   GList           *(*get_interfaces)  (GDBusObject  *object);
  55   GDBusInterface  *(*get_interface)   (GDBusObject  *object,
  56                                        const gchar  *interface_name);
  57
  58   /* Signals */
  59   void (*interface_added)   (GDBusObject     *object,
  60                              GDBusInterface  *interface_);
  61   void (*interface_removed) (GDBusObject     *object,
  62                              GDBusInterface  *interface_);
  63
  64 };
  65
  66 GLIB_AVAILABLE_IN_ALL
  67 GType            g_dbus_object_get_type        (void) G_GNUC_CONST;
  68 GLIB_AVAILABLE_IN_ALL
  69 const gchar     *g_dbus_object_get_object_path (GDBusObject  *object);
  70 GLIB_AVAILABLE_IN_ALL
  71 GList           *g_dbus_object_get_interfaces  (GDBusObject  *object);
  72 GLIB_AVAILABLE_IN_ALL
  73 GDBusInterface  *g_dbus_object_get_interface   (GDBusObject  *object,
  74                                                 const gchar  *interface_name);
  75
  76 G_END_DECLS
  77
  78 #endif /* __G_DBUS_OBJECT_H__ */