gio.DBusObjectManagerIF source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD 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
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.DBusObjectManagerIF;
26 
27 private import gio.DBusInterfaceIF;
28 private import gio.DBusObjectIF;
29 private import gio.c.functions;
30 public  import gio.c.types;
31 private import glib.ListG;
32 private import glib.Str;
33 private import glib.c.functions;
34 private import gobject.ObjectG;
35 private import gobject.Signals;
36 private import std.algorithm;
37 
38 
39 /**
40  * The #GDBusObjectManager type is the base type for service- and
41  * client-side implementations of the standardized
42  * [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager)
43  * interface.
44  * 
45  * See #GDBusObjectManagerClient for the client-side implementation
46  * and #GDBusObjectManagerServer for the service-side implementation.
47  */
48 public interface DBusObjectManagerIF{
49 	/** Get the main Gtk struct */
50 	public GDBusObjectManager* getDBusObjectManagerStruct(bool transferOwnership = false);
51 
52 	/** the main Gtk struct as a void* */
53 	protected void* getStruct();
54 
55 
56 	/** */
57 	public static GType getType()
58 	{
59 		return g_dbus_object_manager_get_type();
60 	}
61 
62 	/**
63 	 * Gets the interface proxy for @interface_name at @object_path, if
64 	 * any.
65 	 *
66 	 * Params:
67 	 *     objectPath = Object path to look up.
68 	 *     interfaceName = D-Bus interface name to look up.
69 	 *
70 	 * Returns: A #GDBusInterface instance or %NULL. Free
71 	 *     with g_object_unref().
72 	 *
73 	 * Since: 2.30
74 	 */
75 	public DBusInterfaceIF getInterface(string objectPath, string interfaceName);
76 
77 	/**
78 	 * Gets the #GDBusObjectProxy at @object_path, if any.
79 	 *
80 	 * Params:
81 	 *     objectPath = Object path to look up.
82 	 *
83 	 * Returns: A #GDBusObject or %NULL. Free with
84 	 *     g_object_unref().
85 	 *
86 	 * Since: 2.30
87 	 */
88 	public DBusObjectIF getObject(string objectPath);
89 
90 	/**
91 	 * Gets the object path that @manager is for.
92 	 *
93 	 * Returns: A string owned by @manager. Do not free.
94 	 *
95 	 * Since: 2.30
96 	 */
97 	public string getObjectPath();
98 
99 	/**
100 	 * Gets all #GDBusObject objects known to @manager.
101 	 *
102 	 * Returns: A list of
103 	 *     #GDBusObject objects. The returned list should be freed with
104 	 *     g_list_free() after each element has been freed with
105 	 *     g_object_unref().
106 	 *
107 	 * Since: 2.30
108 	 */
109 	public ListG getObjects();
110 
111 	/**
112 	 * Emitted when @interface is added to @object.
113 	 *
114 	 * This signal exists purely as a convenience to avoid having to
115 	 * connect signals to all objects managed by @manager.
116 	 *
117 	 * Params:
118 	 *     object = The #GDBusObject on which an interface was added.
119 	 *     interface_ = The #GDBusInterface that was added.
120 	 *
121 	 * Since: 2.30
122 	 */
123 	gulong addOnInterfaceAdded(void delegate(DBusObjectIF, DBusInterfaceIF, DBusObjectManagerIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
124 
125 	/**
126 	 * Emitted when @interface has been removed from @object.
127 	 *
128 	 * This signal exists purely as a convenience to avoid having to
129 	 * connect signals to all objects managed by @manager.
130 	 *
131 	 * Params:
132 	 *     object = The #GDBusObject on which an interface was removed.
133 	 *     interface_ = The #GDBusInterface that was removed.
134 	 *
135 	 * Since: 2.30
136 	 */
137 	gulong addOnInterfaceRemoved(void delegate(DBusObjectIF, DBusInterfaceIF, DBusObjectManagerIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
138 
139 	/**
140 	 * Emitted when @object is added to @manager.
141 	 *
142 	 * Params:
143 	 *     object = The #GDBusObject that was added.
144 	 *
145 	 * Since: 2.30
146 	 */
147 	gulong addOnObjectAdded(void delegate(DBusObjectIF, DBusObjectManagerIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
148 
149 	/**
150 	 * Emitted when @object is removed from @manager.
151 	 *
152 	 * Params:
153 	 *     object = The #GDBusObject that was removed.
154 	 *
155 	 * Since: 2.30
156 	 */
157 	gulong addOnObjectRemoved(void delegate(DBusObjectIF, DBusObjectManagerIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
158 }