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