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