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