atk.State 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  * Conversion parameters:
26  * inFile  = atk-AtkState.html
27  * outPack = atk
28  * outFile = State
29  * strct   = 
30  * realStrct=
31  * ctorStrct=
32  * clss    = State
33  * interf  = 
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- atk_state_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- glib.Str
47  * structWrap:
48  * module aliases:
49  * local aliases:
50  * overrides:
51  */
52 
53 module atk.State;
54 
55 public  import gtkc.atktypes;
56 
57 private import gtkc.atk;
58 private import glib.ConstructionException;
59 private import gobject.ObjectG;
60 
61 private import glib.Str;
62 
63 
64 
65 /**
66  * An AtkState describes a component's particular state. The actual
67  * state of an component is described by its AtkStateSet, which is a
68  * set of AtkStates.
69  */
70 public class State
71 {
72 	
73 	/**
74 	 */
75 	
76 	/**
77 	 * Register a new object state.
78 	 * Params:
79 	 * name = a character string describing the new state.
80 	 * Returns: an AtkState value for the new state.
81 	 */
82 	public static AtkStateType typeRegister(string name)
83 	{
84 		// AtkStateType atk_state_type_register (const gchar *name);
85 		return atk_state_type_register(Str.toStringz(name));
86 	}
87 	
88 	/**
89 	 * Gets the description string describing the AtkStateType type.
90 	 * Params:
91 	 * type = The AtkStateType whose name is required
92 	 * Returns: the string describing the AtkStateType
93 	 */
94 	public static string typeGetName(AtkStateType type)
95 	{
96 		// const gchar * atk_state_type_get_name (AtkStateType type);
97 		return Str.toString(atk_state_type_get_name(type));
98 	}
99 	
100 	/**
101 	 * Gets the AtkStateType corresponding to the description string name.
102 	 * Params:
103 	 * name = a character string state name
104 	 * Returns: an AtkStateType corresponding to name
105 	 */
106 	public static AtkStateType typeForName(string name)
107 	{
108 		// AtkStateType atk_state_type_for_name (const gchar *name);
109 		return atk_state_type_for_name(Str.toStringz(name));
110 	}
111 }