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 gdkpixbuf.PixbufSimpleAnimation;
26 
27 private import gdkpixbuf.Pixbuf;
28 private import gdkpixbuf.PixbufAnimation;
29 private import glib.ConstructionException;
30 private import gobject.ObjectG;
31 private import gtkc.gdkpixbuf;
32 public  import gtkc.gdkpixbuftypes;
33 
34 
35 /**
36  * An opaque struct representing a simple animation.
37  */
38 public class PixbufSimpleAnimation : PixbufAnimation
39 {
40 	/** the main Gtk struct */
41 	protected GdkPixbufSimpleAnim* gdkPixbufSimpleAnim;
42 
43 	/** Get the main Gtk struct */
44 	public GdkPixbufSimpleAnim* getPixbufSimpleAnimationStruct()
45 	{
46 		return gdkPixbufSimpleAnim;
47 	}
48 
49 	/** the main Gtk struct as a void* */
50 	protected override void* getStruct()
51 	{
52 		return cast(void*)gdkPixbufSimpleAnim;
53 	}
54 
55 	protected override void setStruct(GObject* obj)
56 	{
57 		gdkPixbufSimpleAnim = cast(GdkPixbufSimpleAnim*)obj;
58 		super.setStruct(obj);
59 	}
60 
61 	/**
62 	 * Sets our main struct and passes it to the parent class.
63 	 */
64 	public this (GdkPixbufSimpleAnim* gdkPixbufSimpleAnim, bool ownedRef = false)
65 	{
66 		this.gdkPixbufSimpleAnim = gdkPixbufSimpleAnim;
67 		super(cast(GdkPixbufAnimation*)gdkPixbufSimpleAnim, ownedRef);
68 	}
69 
70 	/**
71 	 */
72 
73 	public static GType getType()
74 	{
75 		return gdk_pixbuf_simple_anim_get_type();
76 	}
77 
78 	/**
79 	 * Creates a new, empty animation.
80 	 *
81 	 * Params:
82 	 *     width = the width of the animation
83 	 *     height = the height of the animation
84 	 *     rate = the speed of the animation, in frames per second
85 	 *
86 	 * Return: a newly allocated #GdkPixbufSimpleAnim
87 	 *
88 	 * Since: 2.8
89 	 *
90 	 * Throws: ConstructionException GTK+ fails to create the object.
91 	 */
92 	public this(int width, int height, float rate)
93 	{
94 		auto p = gdk_pixbuf_simple_anim_new(width, height, rate);
95 		
96 		if(p is null)
97 		{
98 			throw new ConstructionException("null returned by new");
99 		}
100 		
101 		this(cast(GdkPixbufSimpleAnim*) p, true);
102 	}
103 
104 	/**
105 	 * Adds a new frame to @animation. The @pixbuf must
106 	 * have the dimensions specified when the animation
107 	 * was constructed.
108 	 *
109 	 * Params:
110 	 *     pixbuf = the pixbuf to add
111 	 *
112 	 * Since: 2.8
113 	 */
114 	public void addFrame(Pixbuf pixbuf)
115 	{
116 		gdk_pixbuf_simple_anim_add_frame(gdkPixbufSimpleAnim, (pixbuf is null) ? null : pixbuf.getPixbufStruct());
117 	}
118 
119 	/**
120 	 * Gets whether @animation should loop indefinitely when it reaches the end.
121 	 *
122 	 * Return: %TRUE if the animation loops forever, %FALSE otherwise
123 	 *
124 	 * Since: 2.18
125 	 */
126 	public bool getLoop()
127 	{
128 		return gdk_pixbuf_simple_anim_get_loop(gdkPixbufSimpleAnim) != 0;
129 	}
130 
131 	/**
132 	 * Sets whether @animation should loop indefinitely when it reaches the end.
133 	 *
134 	 * Params:
135 	 *     loop = whether to loop the animation
136 	 *
137 	 * Since: 2.18
138 	 */
139 	public void setLoop(bool loop)
140 	{
141 		gdk_pixbuf_simple_anim_set_loop(gdkPixbufSimpleAnim, loop);
142 	}
143 }