glib-2.0/gio/gdbusobject.h

0001 /* GDBus - GLib D-Bus Library
0002  *
0003  * Copyright (C) 2008-2010 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: David Zeuthen <davidz@redhat.com>
0021  */
0022
0023 #ifndef __G_DBUS_OBJECT_H__
0024 #define __G_DBUS_OBJECT_H__
0025
0026 #include <gio/giotypes.h>
0027
0028 G_BEGIN_DECLS
0029
0030 #define G_TYPE_DBUS_OBJECT         (g_dbus_object_get_type())
0031 #define G_DBUS_OBJECT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_OBJECT, GDBusObject))
0032 #define G_IS_DBUS_OBJECT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_OBJECT))
0033 #define G_DBUS_OBJECT_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), G_TYPE_DBUS_OBJECT, GDBusObjectIface))
0034
0035 typedef struct _GDBusObjectIface GDBusObjectIface;
0036
0037 /**
0038  * GDBusObjectIface:
0039  * @parent_iface: The parent interface.
0040  * @get_object_path: Returns the object path. See g_dbus_object_get_object_path().
0041  * @get_interfaces: Returns all interfaces. See g_dbus_object_get_interfaces().
0042  * @get_interface: Returns an interface by name. See g_dbus_object_get_interface().
0043  * @interface_added: Signal handler for the #GDBusObject::interface-added signal.
0044  * @interface_removed: Signal handler for the #GDBusObject::interface-removed signal.
0045  *
0046  * Base object type for D-Bus objects.
0047  *
0048  * Since: 2.30
0049  */
0050 struct _GDBusObjectIface
0051 {
0052   GTypeInterface parent_iface;
0053
0054   /* Virtual Functions */
0055   const gchar     *(*get_object_path) (GDBusObject  *object);
0056   GList           *(*get_interfaces)  (GDBusObject  *object);
0057   GDBusInterface  *(*get_interface)   (GDBusObject  *object,
0058                                        const gchar  *interface_name);
0059
0060   /* Signals */
0061   void (*interface_added)   (GDBusObject     *object,
0062                              GDBusInterface  *interface_);
0063   void (*interface_removed) (GDBusObject     *object,
0064                              GDBusInterface  *interface_);
0065
0066 };
0067
0068 GIO_AVAILABLE_IN_ALL
0069 GType            g_dbus_object_get_type        (void) G_GNUC_CONST;
0070 GIO_AVAILABLE_IN_ALL
0071 const gchar     *g_dbus_object_get_object_path (GDBusObject  *object);
0072 GIO_AVAILABLE_IN_ALL
0073 GList           *g_dbus_object_get_interfaces  (GDBusObject  *object);
0074 GIO_AVAILABLE_IN_ALL
0075 GDBusInterface  *g_dbus_object_get_interface   (GDBusObject  *object,
0076                                                 const gchar  *interface_name);
0077
0078 G_END_DECLS
0079
0080 #endif /* __G_DBUS_OBJECT_H__ */