atk.ObjectFactory 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.ObjectFactory;
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 class is the base object class for a factory used to create an
35  * accessible object for a specific GType. The function
36  * atk_registry_set_factory_type() is normally called to store in the
37  * registry the factory type to be used to create an accessible of a
38  * particular GType.
39  */
40 public class ObjectFactory : ObjectG
41 {
42 	/** the main Gtk struct */
43 	protected AtkObjectFactory* atkObjectFactory;
44 
45 	/** Get the main Gtk struct */
46 	public AtkObjectFactory* getObjectFactoryStruct()
47 	{
48 		return atkObjectFactory;
49 	}
50 
51 	/** the main Gtk struct as a void* */
52 	protected override void* getStruct()
53 	{
54 		return cast(void*)atkObjectFactory;
55 	}
56 
57 	protected override void setStruct(GObject* obj)
58 	{
59 		atkObjectFactory = cast(AtkObjectFactory*)obj;
60 		super.setStruct(obj);
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (AtkObjectFactory* atkObjectFactory, bool ownedRef = false)
67 	{
68 		this.atkObjectFactory = atkObjectFactory;
69 		super(cast(GObject*)atkObjectFactory, ownedRef);
70 	}
71 
72 	/**
73 	 */
74 
75 	public static GType getType()
76 	{
77 		return atk_object_factory_get_type();
78 	}
79 
80 	/**
81 	 * Provides an #AtkObject that implements an accessibility interface
82 	 * on behalf of @obj
83 	 *
84 	 * Params:
85 	 *     obj = a #GObject
86 	 *
87 	 * Return: an #AtkObject that implements an accessibility
88 	 *     interface on behalf of @obj
89 	 */
90 	public ObjectAtk createAccessible(ObjectG obj)
91 	{
92 		auto p = atk_object_factory_create_accessible(atkObjectFactory, (obj is null) ? null : obj.getObjectGStruct());
93 		
94 		if(p is null)
95 		{
96 			return null;
97 		}
98 		
99 		return ObjectG.getDObject!(ObjectAtk)(cast(AtkObject*) p, true);
100 	}
101 
102 	/**
103 	 * Gets the GType of the accessible which is created by the factory.
104 	 *
105 	 * Return: the type of the accessible which is created by the @factory.
106 	 *     The value G_TYPE_INVALID is returned if no type if found.
107 	 */
108 	public GType getAccessibleType()
109 	{
110 		return atk_object_factory_get_accessible_type(atkObjectFactory);
111 	}
112 
113 	/**
114 	 * Inform @factory that it is no longer being used to create
115 	 * accessibles. When called, @factory may need to inform
116 	 * #AtkObjects which it has created that they need to be re-instantiated.
117 	 * Note: primarily used for runtime replacement of #AtkObjectFactorys
118 	 * in object registries.
119 	 */
120 	public void invalidate()
121 	{
122 		atk_object_factory_invalidate(atkObjectFactory);
123 	}
124 }