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 gtk.AspectFrame;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import gtk.Frame;
31 private import gtk.Widget;
32 private import gtkc.gtk;
33 public  import gtkc.gtktypes;
34 
35 
36 /**
37  * The #GtkAspectFrame is useful when you want
38  * pack a widget so that it can resize but always retains
39  * the same aspect ratio. For instance, one might be
40  * drawing a small preview of a larger image. #GtkAspectFrame
41  * derives from #GtkFrame, so it can draw a label and
42  * a frame around the child. The frame will be
43  * “shrink-wrapped” to the size of the child.
44  * 
45  * # CSS nodes
46  * 
47  * GtkAspectFrame uses a CSS node with name frame.
48  */
49 public class AspectFrame : Frame
50 {
51 	/** the main Gtk struct */
52 	protected GtkAspectFrame* gtkAspectFrame;
53 
54 	/** Get the main Gtk struct */
55 	public GtkAspectFrame* getAspectFrameStruct()
56 	{
57 		return gtkAspectFrame;
58 	}
59 
60 	/** the main Gtk struct as a void* */
61 	protected override void* getStruct()
62 	{
63 		return cast(void*)gtkAspectFrame;
64 	}
65 
66 	protected override void setStruct(GObject* obj)
67 	{
68 		gtkAspectFrame = cast(GtkAspectFrame*)obj;
69 		super.setStruct(obj);
70 	}
71 
72 	/**
73 	 * Sets our main struct and passes it to the parent class.
74 	 */
75 	public this (GtkAspectFrame* gtkAspectFrame, bool ownedRef = false)
76 	{
77 		this.gtkAspectFrame = gtkAspectFrame;
78 		super(cast(GtkFrame*)gtkAspectFrame, ownedRef);
79 	}
80 
81 
82 	/** */
83 	public static GType getType()
84 	{
85 		return gtk_aspect_frame_get_type();
86 	}
87 
88 	/**
89 	 * Create a new #GtkAspectFrame.
90 	 *
91 	 * Params:
92 	 *     label = Label text.
93 	 *     xalign = Horizontal alignment of the child within the allocation of
94 	 *         the #GtkAspectFrame. This ranges from 0.0 (left aligned)
95 	 *         to 1.0 (right aligned)
96 	 *     yalign = Vertical alignment of the child within the allocation of
97 	 *         the #GtkAspectFrame. This ranges from 0.0 (top aligned)
98 	 *         to 1.0 (bottom aligned)
99 	 *     ratio = The desired aspect ratio.
100 	 *     obeyChild = If %TRUE, @ratio is ignored, and the aspect
101 	 *         ratio is taken from the requistion of the child.
102 	 *
103 	 * Return: the new #GtkAspectFrame.
104 	 *
105 	 * Throws: ConstructionException GTK+ fails to create the object.
106 	 */
107 	public this(string label, float xalign, float yalign, float ratio, bool obeyChild)
108 	{
109 		auto p = gtk_aspect_frame_new(Str.toStringz(label), xalign, yalign, ratio, obeyChild);
110 		
111 		if(p is null)
112 		{
113 			throw new ConstructionException("null returned by new");
114 		}
115 		
116 		this(cast(GtkAspectFrame*) p);
117 	}
118 
119 	/**
120 	 * Set parameters for an existing #GtkAspectFrame.
121 	 *
122 	 * Params:
123 	 *     xalign = Horizontal alignment of the child within the allocation of
124 	 *         the #GtkAspectFrame. This ranges from 0.0 (left aligned)
125 	 *         to 1.0 (right aligned)
126 	 *     yalign = Vertical alignment of the child within the allocation of
127 	 *         the #GtkAspectFrame. This ranges from 0.0 (top aligned)
128 	 *         to 1.0 (bottom aligned)
129 	 *     ratio = The desired aspect ratio.
130 	 *     obeyChild = If %TRUE, @ratio is ignored, and the aspect
131 	 *         ratio is taken from the requistion of the child.
132 	 */
133 	public void set(float xalign, float yalign, float ratio, bool obeyChild)
134 	{
135 		gtk_aspect_frame_set(gtkAspectFrame, xalign, yalign, ratio, obeyChild);
136 	}
137 }