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 gobject.ObjectG;
29 private import gtkc.atk;
30 public  import gtkc.atktypes;
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()
46 	{
47 		return atkGObjectAccessible;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)atkGObjectAccessible;
54 	}
55 
56 	protected override void setStruct(GObject* obj)
57 	{
58 		atkGObjectAccessible = cast(AtkGObjectAccessible*)obj;
59 		super.setStruct(obj);
60 	}
61 
62 	/**
63 	 * Sets our main struct and passes it to the parent class.
64 	 */
65 	public this (AtkGObjectAccessible* atkGObjectAccessible, bool ownedRef = false)
66 	{
67 		this.atkGObjectAccessible = atkGObjectAccessible;
68 		super(cast(AtkObject*)atkGObjectAccessible, ownedRef);
69 	}
70 
71 	/**
72 	 */
73 
74 	public static GType getType()
75 	{
76 		return atk_gobject_accessible_get_type();
77 	}
78 
79 	/**
80 	 * Gets the accessible object for the specified @obj.
81 	 *
82 	 * Params:
83 	 *     obj = a #GObject
84 	 *
85 	 * Return: a #AtkObject which is the accessible object for
86 	 *     the @obj
87 	 */
88 	public static ObjectAtk forObject(ObjectG obj)
89 	{
90 		auto p = atk_gobject_accessible_for_object((obj is null) ? null : obj.getObjectGStruct());
91 		
92 		if(p is null)
93 		{
94 			return null;
95 		}
96 		
97 		return ObjectG.getDObject!(ObjectAtk)(cast(AtkObject*) p);
98 	}
99 
100 	/**
101 	 * Gets the GObject for which @obj is the accessible object.
102 	 *
103 	 * Return: a #GObject which is the object for which @obj is
104 	 *     the accessible object
105 	 */
106 	public ObjectG getObject()
107 	{
108 		auto p = atk_gobject_accessible_get_object(atkGObjectAccessible);
109 		
110 		if(p is null)
111 		{
112 			return null;
113 		}
114 		
115 		return ObjectG.getDObject!(ObjectG)(cast(GObject*) p);
116 	}
117 }