atk.GObjectAccessible 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 atk.GObjectAccessible;
26 
27 private import atk.ObjectAtk;
28 private import atk.c.functions;
29 public  import atk.c.types;
30 private import gobject.ObjectG;
31 
32 
33 /**
34  * This object class is derived from AtkObject. It can be used as a
35  * basis for implementing accessible objects for GObjects which are
36  * not derived from GtkWidget. One example of its use is in providing
37  * an accessible object for GnomeCanvasItem in the GAIL library.
38  */
39 public class GObjectAccessible : ObjectAtk
40 {
41 	/** the main Gtk struct */
42 	protected AtkGObjectAccessible* atkGObjectAccessible;
43 
44 	/** Get the main Gtk struct */
45 	public AtkGObjectAccessible* getGObjectAccessibleStruct(bool transferOwnership = false)
46 	{
47 		if (transferOwnership)
48 			ownedRef = false;
49 		return atkGObjectAccessible;
50 	}
51 
52 	/** the main Gtk struct as a void* */
53 	protected override void* getStruct()
54 	{
55 		return cast(void*)atkGObjectAccessible;
56 	}
57 
58 	/**
59 	 * Sets our main struct and passes it to the parent class.
60 	 */
61 	public this (AtkGObjectAccessible* atkGObjectAccessible, bool ownedRef = false)
62 	{
63 		this.atkGObjectAccessible = atkGObjectAccessible;
64 		super(cast(AtkObject*)atkGObjectAccessible, ownedRef);
65 	}
66 
67 
68 	/** */
69 	public static GType getType()
70 	{
71 		return atk_gobject_accessible_get_type();
72 	}
73 
74 	/**
75 	 * Gets the accessible object for the specified @obj.
76 	 *
77 	 * Params:
78 	 *     obj = a #GObject
79 	 *
80 	 * Returns: a #AtkObject which is the accessible object for
81 	 *     the @obj
82 	 */
83 	public static ObjectAtk forObject(ObjectG obj)
84 	{
85 		auto __p = atk_gobject_accessible_for_object((obj is null) ? null : obj.getObjectGStruct());
86 
87 		if(__p is null)
88 		{
89 			return null;
90 		}
91 
92 		return ObjectG.getDObject!(ObjectAtk)(cast(AtkObject*) __p);
93 	}
94 
95 	/**
96 	 * Gets the GObject for which @obj is the accessible object.
97 	 *
98 	 * Returns: a #GObject which is the object for which @obj is
99 	 *     the accessible object
100 	 */
101 	public ObjectG getObject()
102 	{
103 		auto __p = atk_gobject_accessible_get_object(atkGObjectAccessible);
104 
105 		if(__p is null)
106 		{
107 			return null;
108 		}
109 
110 		return ObjectG.getDObject!(ObjectG)(cast(GObject*) __p);
111 	}
112 }