atk.Misc 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.Misc;
26 
27 private import gobject.ObjectG;
28 private import gtkc.atk;
29 public  import gtkc.atktypes;
30 
31 
32 /**
33  * A set of utility functions for thread locking. This interface and
34  * all his related methods are deprecated since 2.12.
35  */
36 public class Misc : ObjectG
37 {
38 	/** the main Gtk struct */
39 	protected AtkMisc* atkMisc;
40 
41 	/** Get the main Gtk struct */
42 	public AtkMisc* getMiscStruct()
43 	{
44 		return atkMisc;
45 	}
46 
47 	/** the main Gtk struct as a void* */
48 	protected override void* getStruct()
49 	{
50 		return cast(void*)atkMisc;
51 	}
52 
53 	protected override void setStruct(GObject* obj)
54 	{
55 		atkMisc = cast(AtkMisc*)obj;
56 		super.setStruct(obj);
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (AtkMisc* atkMisc, bool ownedRef = false)
63 	{
64 		this.atkMisc = atkMisc;
65 		super(cast(GObject*)atkMisc, ownedRef);
66 	}
67 
68 
69 	/** */
70 	public static GType getType()
71 	{
72 		return atk_misc_get_type();
73 	}
74 
75 	/**
76 	 * Obtain the singleton instance of AtkMisc for this application.
77 	 *
78 	 * Deprecated: Since 2.12.
79 	 *
80 	 * Return: The singleton instance of AtkMisc for this application.
81 	 *
82 	 * Since: 1.13
83 	 */
84 	public static Misc getInstance()
85 	{
86 		auto p = atk_misc_get_instance();
87 		
88 		if(p is null)
89 		{
90 			return null;
91 		}
92 		
93 		return ObjectG.getDObject!(Misc)(cast(AtkMisc*) p);
94 	}
95 
96 	/**
97 	 * Take the thread mutex for the GUI toolkit,
98 	 * if one exists.
99 	 * (This method is implemented by the toolkit ATK implementation layer;
100 	 * for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).
101 	 *
102 	 * Deprecated: Since 2.12.
103 	 *
104 	 * Since: 1.13
105 	 */
106 	public void threadsEnter()
107 	{
108 		atk_misc_threads_enter(atkMisc);
109 	}
110 
111 	/**
112 	 * Release the thread mutex for the GUI toolkit,
113 	 * if one exists. This method, and atk_misc_threads_enter,
114 	 * are needed in some situations by threaded application code which
115 	 * services ATK requests, since fulfilling ATK requests often
116 	 * requires calling into the GUI toolkit.  If a long-running or
117 	 * potentially blocking call takes place inside such a block, it should
118 	 * be bracketed by atk_misc_threads_leave/atk_misc_threads_enter calls.
119 	 * (This method is implemented by the toolkit ATK implementation layer;
120 	 * for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE).
121 	 *
122 	 * Deprecated: Since 2.12.
123 	 *
124 	 * Since: 1.13
125 	 */
126 	public void threadsLeave()
127 	{
128 		atk_misc_threads_leave(atkMisc);
129 	}
130 }