gio.DBusObjectProxy 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.DBusObjectProxy;
26 
27 private import gio.DBusConnection;
28 private import gio.DBusObjectIF;
29 private import gio.DBusObjectT;
30 private import gio.c.functions;
31 public  import gio.c.types;
32 private import glib.ConstructionException;
33 private import glib.Str;
34 private import gobject.ObjectG;
35 
36 
37 /**
38  * A #GDBusObjectProxy is an object used to represent a remote object
39  * with one or more D-Bus interfaces. Normally, you don't instantiate
40  * a #GDBusObjectProxy yourself - typically #GDBusObjectManagerClient
41  * is used to obtain it.
42  *
43  * Since: 2.30
44  */
45 public class DBusObjectProxy : ObjectG, DBusObjectIF
46 {
47 	/** the main Gtk struct */
48 	protected GDBusObjectProxy* gDBusObjectProxy;
49 
50 	/** Get the main Gtk struct */
51 	public GDBusObjectProxy* getDBusObjectProxyStruct(bool transferOwnership = false)
52 	{
53 		if (transferOwnership)
54 			ownedRef = false;
55 		return gDBusObjectProxy;
56 	}
57 
58 	/** the main Gtk struct as a void* */
59 	protected override void* getStruct()
60 	{
61 		return cast(void*)gDBusObjectProxy;
62 	}
63 
64 	/**
65 	 * Sets our main struct and passes it to the parent class.
66 	 */
67 	public this (GDBusObjectProxy* gDBusObjectProxy, bool ownedRef = false)
68 	{
69 		this.gDBusObjectProxy = gDBusObjectProxy;
70 		super(cast(GObject*)gDBusObjectProxy, ownedRef);
71 	}
72 
73 	// add the DBusObject capabilities
74 	mixin DBusObjectT!(GDBusObjectProxy);
75 
76 
77 	/** */
78 	public static GType getType()
79 	{
80 		return g_dbus_object_proxy_get_type();
81 	}
82 
83 	/**
84 	 * Creates a new #GDBusObjectProxy for the given connection and
85 	 * object path.
86 	 *
87 	 * Params:
88 	 *     connection = a #GDBusConnection
89 	 *     objectPath = the object path
90 	 *
91 	 * Returns: a new #GDBusObjectProxy
92 	 *
93 	 * Since: 2.30
94 	 *
95 	 * Throws: ConstructionException GTK+ fails to create the object.
96 	 */
97 	public this(DBusConnection connection, string objectPath)
98 	{
99 		auto __p = g_dbus_object_proxy_new((connection is null) ? null : connection.getDBusConnectionStruct(), Str.toStringz(objectPath));
100 
101 		if(__p is null)
102 		{
103 			throw new ConstructionException("null returned by new");
104 		}
105 
106 		this(cast(GDBusObjectProxy*) __p, true);
107 	}
108 
109 	/**
110 	 * Gets the connection that @proxy is for.
111 	 *
112 	 * Returns: A #GDBusConnection. Do not free, the
113 	 *     object is owned by @proxy.
114 	 *
115 	 * Since: 2.30
116 	 */
117 	public DBusConnection getConnection()
118 	{
119 		auto __p = g_dbus_object_proxy_get_connection(gDBusObjectProxy);
120 
121 		if(__p is null)
122 		{
123 			return null;
124 		}
125 
126 		return ObjectG.getDObject!(DBusConnection)(cast(GDBusConnection*) __p);
127 	}
128 }