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 
44 	/** Get the main Gtk struct */
45 	public GtkBorder* getBorderStruct()
46 	{
47 		return gtkBorder;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected void* getStruct()
52 	{
53 		return cast(void*)gtkBorder;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GtkBorder* gtkBorder)
60 	{
61 		this.gtkBorder = gtkBorder;
62 	}
63 
64 	~this ()
65 	{
66 		if ( Linker.isLoaded(LIBRARY.GTK) && gtkBorder !is null )
67 		{
68 			gtk_border_free(gtkBorder);
69 		}
70 	}
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 	 * Return: a newly allocated #GtkBorder-struct. Free with gtk_border_free()
84 	 *
85 	 * Since: 2.14
86 	 *
87 	 * Throws: ConstructionException GTK+ fails to create the object.
88 	 */
89 	public this()
90 	{
91 		auto p = gtk_border_new();
92 		
93 		if(p is null)
94 		{
95 			throw new ConstructionException("null returned by new");
96 		}
97 		
98 		this(cast(GtkBorder*) p);
99 	}
100 
101 	/**
102 	 * Copies a #GtkBorder-struct.
103 	 *
104 	 * Return: a copy of @border_.
105 	 */
106 	public Border copy()
107 	{
108 		auto p = gtk_border_copy(gtkBorder);
109 		
110 		if(p is null)
111 		{
112 			return null;
113 		}
114 		
115 		return ObjectG.getDObject!(Border)(cast(GtkBorder*) p);
116 	}
117 
118 	/**
119 	 * Frees a #GtkBorder-struct.
120 	 */
121 	public void free()
122 	{
123 		gtk_border_free(gtkBorder);
124 	}
125 }