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