gtk.Border 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 module gtk.Border;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtkc.gtk;
30 public  import gtkc.gtktypes;
31 private import gtkd.Loader;
32 
33 
34 /**
35  * A struct that specifies a border around a rectangular area
36  * that can be of different width on each side.
37  */
38 public class Border
39 {
40 	/** the main Gtk struct */
41 	protected GtkBorder* gtkBorder;
42 	protected bool ownedRef;
43 
44 	/** Get the main Gtk struct */
45 	public GtkBorder* getBorderStruct(bool transferOwnership = false)
46 	{
47 		if (transferOwnership)
48 			ownedRef = false;
49 		return gtkBorder;
50 	}
51 
52 	/** the main Gtk struct as a void* */
53 	protected void* getStruct()
54 	{
55 		return cast(void*)gtkBorder;
56 	}
57 
58 	/**
59 	 * Sets our main struct and passes it to the parent class.
60 	 */
61 	public this (GtkBorder* gtkBorder, bool ownedRef = false)
62 	{
63 		this.gtkBorder = gtkBorder;
64 		this.ownedRef = ownedRef;
65 	}
66 
67 	~this ()
68 	{
69 		if (  Linker.isLoaded(LIBRARY_GTK) && ownedRef )
70 			gtk_border_free(gtkBorder);
71 	}
72 
73 
74 	/** */
75 	public static GType getType()
76 	{
77 		return gtk_border_get_type();
78 	}
79 
80 	/**
81 	 * Allocates a new #GtkBorder-struct and initializes its elements to zero.
82 	 *
83 	 * Returns: a newly allocated #GtkBorder-struct.
84 	 *     Free with gtk_border_free()
85 	 *
86 	 * Since: 2.14
87 	 *
88 	 * Throws: ConstructionException GTK+ fails to create the object.
89 	 */
90 	public this()
91 	{
92 		auto p = gtk_border_new();
93 		
94 		if(p is null)
95 		{
96 			throw new ConstructionException("null returned by new");
97 		}
98 		
99 		this(cast(GtkBorder*) p);
100 	}
101 
102 	/**
103 	 * Copies a #GtkBorder-struct.
104 	 *
105 	 * Returns: a copy of @border_.
106 	 */
107 	public Border copy()
108 	{
109 		auto p = gtk_border_copy(gtkBorder);
110 		
111 		if(p is null)
112 		{
113 			return null;
114 		}
115 		
116 		return ObjectG.getDObject!(Border)(cast(GtkBorder*) p, true);
117 	}
118 
119 	/**
120 	 * Frees a #GtkBorder-struct.
121 	 */
122 	public void free()
123 	{
124 		gtk_border_free(gtkBorder);
125 		ownedRef = false;
126 	}
127 }