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