gio/gdbusinterface.h

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #ifndef __G_DBUS_INTERFACE_H__
  24 #define __G_DBUS_INTERFACE_H__
  25
  26 #include <gio/giotypes.h>
  27 #include <gio/tizen_header_glib.h>  /* for TIZEN_PUBLIC_DEPRECATED_API */
  28
  29 G_BEGIN_DECLS
  30
  31 #define G_TYPE_DBUS_INTERFACE         (g_dbus_interface_get_type())
  32 #define G_DBUS_INTERFACE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_INTERFACE, GDBusInterface))
  33 #define G_IS_DBUS_INTERFACE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_INTERFACE))
  34 #define G_DBUS_INTERFACE_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), G_TYPE_DBUS_INTERFACE, GDBusInterfaceIface))
  35
  36 /**
  37  * GDBusInterface:
  38  *
  39  * Base type for D-Bus interfaces.
  40  *
  41  * Since: 2.30
  42  */
  43
  44 typedef struct _GDBusInterfaceIface GDBusInterfaceIface;
  45
  46 /**
  47  * GDBusInterfaceIface:
  48  * @parent_iface: The parent interface.
  49  * @get_info: Returns a #GDBusInterfaceInfo. See g_dbus_interface_get_info().
  50  * @get_object: Gets the enclosing #GDBusObject. See g_dbus_interface_get_object().
  51  * @set_object: Sets the enclosing #GDBusObject. See g_dbus_interface_set_object().
  52  * @dup_object: Gets a reference to the enclosing #GDBusObject. See g_dbus_interface_dup_object(). Added in 2.32.
  53  *
  54  * Base type for D-Bus interfaces.
  55  *
  56  * Since: 2.30
  57  */
  58 struct _GDBusInterfaceIface
  59 {
  60   GTypeInterface parent_iface;
  61
  62   /* Virtual Functions */
  63   GDBusInterfaceInfo   *(*get_info)   (GDBusInterface      *interface_);
  64   GDBusObject          *(*get_object) (GDBusInterface      *interface_);
  65   void                  (*set_object) (GDBusInterface      *interface_,
  66                                        GDBusObject         *object);
  67   GDBusObject          *(*dup_object) (GDBusInterface      *interface_);
  68 };
  69
  70 GIO_AVAILABLE_IN_ALL
  71 GType                 g_dbus_interface_get_type         (void) G_GNUC_CONST TIZEN_PUBLIC_DEPRECATED_API;
  72 GIO_AVAILABLE_IN_ALL
  73 GDBusInterfaceInfo   *g_dbus_interface_get_info         (GDBusInterface      *interface_) TIZEN_PUBLIC_DEPRECATED_API;
  74 GIO_AVAILABLE_IN_ALL
  75 GDBusObject          *g_dbus_interface_get_object       (GDBusInterface      *interface_) TIZEN_PUBLIC_DEPRECATED_API;
  76 GIO_AVAILABLE_IN_ALL
  77 void                  g_dbus_interface_set_object       (GDBusInterface      *interface_,
  78                                                          GDBusObject         *object) TIZEN_PUBLIC_DEPRECATED_API;
  79 GIO_AVAILABLE_IN_2_32
  80 GDBusObject          *g_dbus_interface_dup_object       (GDBusInterface      *interface_) TIZEN_PUBLIC_DEPRECATED_API;
  81
  82 G_END_DECLS
  83
  84 #endif /* __G_DBUS_INTERFACE_H__ */