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  * @lookup_with_typecheck: Like @get_interface but warns on stderr if the returned object, if any,
  44  *   does not conform to @type. Returned object must be freed by the caller.
  45  * @peek_with_typecheck: Like @lookup_with_typecheck but does not transfer the reference.
  46  * @interface_added: Signal handler for the #GDBusObject::interface-added signal.
  47  * @interface_removed: Signal handler for the #GDBusObject::interface-removed signal.
  48  *
  49  * Base object type for D-Bus objects.
  50  *
  51  * <note><para>The @lookup_with_typecheck and @peek_with_typecheck
  52  * virtual functions should only be used by D-Bus interface
  53  * implementations.</para></note>
  54  *
  55  * Since: 2.30
  56  */
  57 struct _GDBusObjectIface
  58 {
  59   GTypeInterface parent_iface;
  60
  61   /* Virtual Functions */
  62   const gchar     *(*get_object_path) (GDBusObject  *object);
  63   GList           *(*get_interfaces)  (GDBusObject  *object);
  64   GDBusInterface  *(*get_interface)   (GDBusObject  *object,
  65                                        const gchar  *interface_name);
  66
  67   gpointer         (*lookup_with_typecheck) (GDBusObject *object,
  68                                              const gchar *interface_name,
  69                                              GType        type);
  70   gpointer         (*peek_with_typecheck)   (GDBusObject *object,
  71                                              const gchar *interface_name,
  72                                              GType        type);
  73
  74   /* Signals */
  75   void (*interface_added)   (GDBusObject     *object,
  76                              GDBusInterface  *interface);
  77   void (*interface_removed) (GDBusObject     *object,
  78                              GDBusInterface  *interface);
  79
  80 };
  81
  82 GType            g_dbus_object_get_type        (void) G_GNUC_CONST;
  83 const gchar     *g_dbus_object_get_object_path (GDBusObject  *object);
  84 GList           *g_dbus_object_get_interfaces  (GDBusObject  *object);
  85 GDBusInterface  *g_dbus_object_get_interface   (GDBusObject  *object,
  86                                                 const gchar  *interface_name);
  87
  88 gpointer         g_dbus_object_peek_with_typecheck   (GDBusObject *object,
  89                                                       const gchar *interface_name,
  90                                                       GType        type);
  91 gpointer         g_dbus_object_lookup_with_typecheck (GDBusObject *object,
  92                                                       const gchar *interface_name,
  93                                                       GType        type);
  94
  95 G_END_DECLS
  96
  97 #endif /* __G_DBUS_OBJECT_H__ */