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