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 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, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #ifndef __G_DBUS_OBJECT_H__
  24 #define __G_DBUS_OBJECT_H__
  25
  26 #include <gio/giotypes.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_TYPE_DBUS_OBJECT         (g_dbus_object_get_type())
  31 #define G_DBUS_OBJECT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_OBJECT, GDBusObject))
  32 #define G_IS_DBUS_OBJECT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_OBJECT))
  33 #define G_DBUS_OBJECT_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), G_TYPE_DBUS_OBJECT, GDBusObjectIface))
  34
  35 typedef struct _GDBusObjectIface GDBusObjectIface;
  36
  37 /**
  38  * GDBusObjectIface:
  39  * @parent_iface: The parent interface.
  40  * @get_object_path: Returns the object path. See g_dbus_object_get_object_path().
  41  * @get_interfaces: Returns all interfaces. See g_dbus_object_get_interfaces().
  42  * @get_interface: Returns an interface by name. See g_dbus_object_get_interface().
  43  * @interface_added: Signal handler for the #GDBusObject::interface-added signal.
  44  * @interface_removed: Signal handler for the #GDBusObject::interface-removed signal.
  45  *
  46  * Base object type for D-Bus objects.
  47  *
  48  * <note><para>The @lookup_with_typecheck and @peek_with_typecheck
  49  * virtual functions should only be used by D-Bus interface
  50  * implementations.</para></note>
  51  *
  52  * Since: 2.30
  53  */
  54 struct _GDBusObjectIface
  55 {
  56   GTypeInterface parent_iface;
  57
  58   /* Virtual Functions */
  59   const gchar     *(*get_object_path) (GDBusObject  *object);
  60   GList           *(*get_interfaces)  (GDBusObject  *object);
  61   GDBusInterface  *(*get_interface)   (GDBusObject  *object,
  62                                        const gchar  *interface_name);
  63
  64   /* Signals */
  65   void (*interface_added)   (GDBusObject     *object,
  66                              GDBusInterface  *interface_);
  67   void (*interface_removed) (GDBusObject     *object,
  68                              GDBusInterface  *interface_);
  69
  70 };
  71
  72 GType            g_dbus_object_get_type        (void) G_GNUC_CONST;
  73 const gchar     *g_dbus_object_get_object_path (GDBusObject  *object);
  74 GList           *g_dbus_object_get_interfaces  (GDBusObject  *object);
  75 GDBusInterface  *g_dbus_object_get_interface   (GDBusObject  *object,
  76                                                 const gchar  *interface_name);
  77
  78 G_END_DECLS
  79
  80 #endif /* __G_DBUS_OBJECT_H__ */