File: Border.d

package info (click to toggle)
gtk-d 3.10.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,204 kB
  • sloc: javascript: 565; sh: 71; makefile: 23
file content (185 lines) | stat: -rw-r--r-- 3,683 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module gtk.Border;

private import glib.ConstructionException;
private import glib.MemorySlice;
private import gobject.ObjectG;
private import gtk.c.functions;
public  import gtk.c.types;
public  import gtkc.gtktypes;
private import gtkd.Loader;


/**
 * A struct that specifies a border around a rectangular area
 * that can be of different width on each side.
 */
public final class Border
{
	/** the main Gtk struct */
	protected GtkBorder* gtkBorder;
	protected bool ownedRef;

	/** Get the main Gtk struct */
	public GtkBorder* getBorderStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkBorder;
	}

	/** the main Gtk struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)gtkBorder;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GtkBorder* gtkBorder, bool ownedRef = false)
	{
		this.gtkBorder = gtkBorder;
		this.ownedRef = ownedRef;
	}

	~this ()
	{
		if ( Linker.isLoaded(LIBRARY_GTK) && ownedRef )
			gtk_border_free(gtkBorder);
	}


	/**
	 * The width of the left border
	 */
	public @property short left()
	{
		return gtkBorder.left;
	}

	/** Ditto */
	public @property void left(short value)
	{
		gtkBorder.left = value;
	}

	/**
	 * The width of the right border
	 */
	public @property short right()
	{
		return gtkBorder.right;
	}

	/** Ditto */
	public @property void right(short value)
	{
		gtkBorder.right = value;
	}

	/**
	 * The width of the top border
	 */
	public @property short top()
	{
		return gtkBorder.top;
	}

	/** Ditto */
	public @property void top(short value)
	{
		gtkBorder.top = value;
	}

	/**
	 * The width of the bottom border
	 */
	public @property short bottom()
	{
		return gtkBorder.bottom;
	}

	/** Ditto */
	public @property void bottom(short value)
	{
		gtkBorder.bottom = value;
	}

	/** */
	public static GType getType()
	{
		return gtk_border_get_type();
	}

	/**
	 * Allocates a new #GtkBorder-struct and initializes its elements to zero.
	 *
	 * Returns: a newly allocated #GtkBorder-struct.
	 *     Free with gtk_border_free()
	 *
	 * Since: 2.14
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto p = gtk_border_new();

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(GtkBorder*) p);
	}

	/**
	 * Copies a #GtkBorder-struct.
	 *
	 * Returns: a copy of @border_.
	 */
	public Border copy()
	{
		auto p = gtk_border_copy(gtkBorder);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Border)(cast(GtkBorder*) p, true);
	}

	/**
	 * Frees a #GtkBorder-struct.
	 */
	public void free()
	{
		gtk_border_free(gtkBorder);
		ownedRef = false;
	}
}