glib-2.0/gio/gdbusinterface.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_INTERFACE_H__
0024 #define __G_DBUS_INTERFACE_H__
0025
0026 #include <gio/giotypes.h>
0027
0028 G_BEGIN_DECLS
0029
0030 #define G_TYPE_DBUS_INTERFACE         (g_dbus_interface_get_type())
0031 #define G_DBUS_INTERFACE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_INTERFACE, GDBusInterface))
0032 #define G_IS_DBUS_INTERFACE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_INTERFACE))
0033 #define G_DBUS_INTERFACE_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), G_TYPE_DBUS_INTERFACE, GDBusInterfaceIface))
0034
0035 typedef struct _GDBusInterfaceIface GDBusInterfaceIface;
0036
0037 /**
0038  * GDBusInterfaceIface:
0039  * @parent_iface: The parent interface.
0040  * @get_info: Returns a #GDBusInterfaceInfo. See g_dbus_interface_get_info().
0041  * @get_object: Gets the enclosing #GDBusObject. See g_dbus_interface_get_object().
0042  * @set_object: Sets the enclosing #GDBusObject. See g_dbus_interface_set_object().
0043  * @dup_object: Gets a reference to the enclosing #GDBusObject. See g_dbus_interface_dup_object(). Added in 2.32.
0044  *
0045  * Base type for D-Bus interfaces.
0046  *
0047  * Since: 2.30
0048  */
0049 struct _GDBusInterfaceIface
0050 {
0051   GTypeInterface parent_iface;
0052
0053   /* Virtual Functions */
0054   GDBusInterfaceInfo   *(*get_info)   (GDBusInterface      *interface_);
0055   GDBusObject          *(*get_object) (GDBusInterface      *interface_);
0056   void                  (*set_object) (GDBusInterface      *interface_,
0057                                        GDBusObject         *object);
0058   GDBusObject          *(*dup_object) (GDBusInterface      *interface_);
0059 };
0060
0061 GIO_AVAILABLE_IN_ALL
0062 GType                 g_dbus_interface_get_type         (void) G_GNUC_CONST;
0063 GIO_AVAILABLE_IN_ALL
0064 GDBusInterfaceInfo   *g_dbus_interface_get_info         (GDBusInterface      *interface_);
0065 GIO_AVAILABLE_IN_ALL
0066 GDBusObject          *g_dbus_interface_get_object       (GDBusInterface      *interface_);
0067 GIO_AVAILABLE_IN_ALL
0068 void                  g_dbus_interface_set_object       (GDBusInterface      *interface_,
0069                                                          GDBusObject         *object);
0070 GIO_AVAILABLE_IN_2_32
0071 GDBusObject          *g_dbus_interface_dup_object       (GDBusInterface      *interface_);
0072
0073 G_END_DECLS
0074
0075 #endif /* __G_DBUS_INTERFACE_H__ */