gtk.Arrow 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  = GtkArrow.html
27  * outPack = gtk
28  * outFile = Arrow
29  * strct   = GtkArrow
30  * realStrct=
31  * ctorStrct=
32  * clss    = Arrow
33  * interf  = 
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gtk_arrow_
41  * 	- gtk_
42  * omit structs:
43  * omit prefixes:
44  * omit code:
45  * omit signals:
46  * imports:
47  * structWrap:
48  * module aliases:
49  * local aliases:
50  * overrides:
51  */
52 
53 module gtk.Arrow;
54 
55 public  import gtkc.gtktypes;
56 
57 private import gtkc.gtk;
58 private import glib.ConstructionException;
59 private import gobject.ObjectG;
60 
61 
62 
63 
64 
65 private import gtk.Misc;
66 
67 /**
68  * Description
69  * GtkArrow should be used to draw simple arrows that need to point in
70  * one of the four cardinal directions (up, down, left, or right). The
71  * style of the arrow can be one of shadow in, shadow out, etched in, or
72  * etched out. Note that these directions and style types may be
73  * ammended in versions of GTK+ to come.
74  * GtkArrow will fill any space alloted to it, but since it is inherited
75  * from GtkMisc, it can be padded and/or aligned, to fill exactly the
76  * space the programmer desires.
77  * Arrows are created with a call to gtk_arrow_new(). The direction or
78  * style of an arrow can be changed after creation by using gtk_arrow_set().
79  */
80 public class Arrow : Misc
81 {
82 	
83 	/** the main Gtk struct */
84 	protected GtkArrow* gtkArrow;
85 	
86 	
87 	public GtkArrow* getArrowStruct()
88 	{
89 		return gtkArrow;
90 	}
91 	
92 	
93 	/** the main Gtk struct as a void* */
94 	protected override void* getStruct()
95 	{
96 		return cast(void*)gtkArrow;
97 	}
98 	
99 	/**
100 	 * Sets our main struct and passes it to the parent class
101 	 */
102 	public this (GtkArrow* gtkArrow)
103 	{
104 		super(cast(GtkMisc*)gtkArrow);
105 		this.gtkArrow = gtkArrow;
106 	}
107 	
108 	protected override void setStruct(GObject* obj)
109 	{
110 		super.setStruct(obj);
111 		gtkArrow = cast(GtkArrow*)obj;
112 	}
113 	
114 	/**
115 	 */
116 	
117 	/**
118 	 * Creates a new GtkArrow widget.
119 	 * Params:
120 	 * arrowType = a valid GtkArrowType.
121 	 * shadowType = a valid GtkShadowType.
122 	 * Throws: ConstructionException GTK+ fails to create the object.
123 	 */
124 	public this (GtkArrowType arrowType, GtkShadowType shadowType)
125 	{
126 		// GtkWidget * gtk_arrow_new (GtkArrowType arrow_type,  GtkShadowType shadow_type);
127 		auto p = gtk_arrow_new(arrowType, shadowType);
128 		if(p is null)
129 		{
130 			throw new ConstructionException("null returned by gtk_arrow_new(arrowType, shadowType)");
131 		}
132 		this(cast(GtkArrow*) p);
133 	}
134 	
135 	/**
136 	 * Sets the direction and style of the GtkArrow, arrow.
137 	 * Params:
138 	 * arrow = a widget of type GtkArrow.
139 	 * arrowType = a valid GtkArrowType.
140 	 * shadowType = a valid GtkShadowType.
141 	 */
142 	public void set(GtkArrowType arrowType, GtkShadowType shadowType)
143 	{
144 		// void gtk_arrow_set (GtkArrow *arrow,  GtkArrowType arrow_type,  GtkShadowType shadow_type);
145 		gtk_arrow_set(gtkArrow, arrowType, shadowType);
146 	}
147 }