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