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