File: Color.d

package info (click to toggle)
gtk-d 3.10.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 20,152 kB
  • sloc: javascript: 565; sh: 71; makefile: 25
file content (295 lines) | stat: -rw-r--r-- 6,296 bytes parent folder | download | duplicates (4)
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
/*
 * 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 gdk.Color;

private import gdk.c.functions;
public  import gdk.c.types;
private import glib.MemorySlice;
private import glib.Str;
private import gobject.ObjectG;
public  import gtkc.gdktypes;
private import gtkd.Loader;


/**
 * A #GdkColor is used to describe a color,
 * similar to the XColor struct used in the X11 drawing API.
 * 
 * Deprecated: Use #GdkRGBA
 */
public final class Color
{
	/** the main Gtk struct */
	protected GdkColor* gdkColor;
	protected bool ownedRef;

	/** Get the main Gtk struct */
	public GdkColor* getColorStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gdkColor;
	}

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

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

	~this ()
	{
		if ( Linker.isLoaded(LIBRARY_GDK) && ownedRef )
			gdk_color_free(gdkColor);
	}

	/**
	 * Creates a new Color
	 */
	this()
	{
		GdkColor color;

		this(gdk_color_copy(&color));
	}

	/** ditto */
	this(ubyte red, ubyte green, ubyte blue)
	{
		GdkColor color;

		color.red = cast(ushort)(red * 257);
		color.green = cast(ushort)(green * 257);
		color.blue = cast(ushort)(blue * 257);

		this(gdk_color_copy(&color));
	}

	/** ditto */
	this(ushort red, ushort green, ushort blue)
	{
		GdkColor color;

		color.red = red;
		color.green = green;
		color.blue = blue;

		this(gdk_color_copy(&color));
	}

	private void updatePixel()
	{
		gdkColor.pixel = (gdkColor.red&0xFF00 << 8) | (gdkColor.green&0xFF00) | (gdkColor.blue >> 8) ;
	}

	/**
	 */

	/**
	 * For allocated colors, the pixel value used to
	 * draw this color on the screen. Not used anymore.
	 */
	public @property uint pixel()
	{
		return gdkColor.pixel;
	}

	/** Ditto */
	public @property void pixel(uint value)
	{
		gdkColor.pixel = value;
	}

	/**
	 * The red component of the color. This is
	 * a value between 0 and 65535, with 65535 indicating
	 * full intensity
	 */
	public @property ushort red()
	{
		return gdkColor.red;
	}

	/** Ditto */
	public @property void red(ushort value)
	{
		gdkColor.red = value;
	}

	/**
	 * The green component of the color
	 */
	public @property ushort green()
	{
		return gdkColor.green;
	}

	/** Ditto */
	public @property void green(ushort value)
	{
		gdkColor.green = value;
	}

	/**
	 * The blue component of the color
	 */
	public @property ushort blue()
	{
		return gdkColor.blue;
	}

	/** Ditto */
	public @property void blue(ushort value)
	{
		gdkColor.blue = value;
	}

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

	/**
	 * Makes a copy of a #GdkColor.
	 *
	 * The result must be freed using gdk_color_free().
	 *
	 * Deprecated: Use #GdkRGBA
	 *
	 * Returns: a copy of @color
	 */
	public Color copy()
	{
		auto p = gdk_color_copy(gdkColor);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Color)(cast(GdkColor*) p, true);
	}

	/**
	 * Compares two colors.
	 *
	 * Deprecated: Use #GdkRGBA
	 *
	 * Params:
	 *     colorb = another #GdkColor
	 *
	 * Returns: %TRUE if the two colors compare equal
	 */
	public bool equal(Color colorb)
	{
		return gdk_color_equal(gdkColor, (colorb is null) ? null : colorb.getColorStruct()) != 0;
	}

	/**
	 * Frees a #GdkColor created with gdk_color_copy().
	 *
	 * Deprecated: Use #GdkRGBA
	 */
	public void free()
	{
		gdk_color_free(gdkColor);
		ownedRef = false;
	}

	/**
	 * A hash function suitable for using for a hash
	 * table that stores #GdkColors.
	 *
	 * Deprecated: Use #GdkRGBA
	 *
	 * Returns: The hash function applied to @color
	 */
	public uint hash()
	{
		return gdk_color_hash(gdkColor);
	}

	/**
	 * Returns a textual specification of @color in the hexadecimal
	 * form “\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits
	 * representing the red, green and blue components respectively.
	 *
	 * The returned string can be parsed by gdk_color_parse().
	 *
	 * Deprecated: Use #GdkRGBA
	 *
	 * Returns: a newly-allocated text string
	 *
	 * Since: 2.12
	 */
	public override string toString()
	{
		auto retStr = gdk_color_to_string(gdkColor);

		scope(exit) Str.freeString(retStr);
		return Str.toString(retStr);
	}

	/**
	 * Parses a textual specification of a color and fill in the
	 * @red, @green, and @blue fields of a #GdkColor.
	 *
	 * The string can either one of a large set of standard names
	 * (taken from the X11 `rgb.txt` file), or it can be a hexadecimal
	 * value in the form “\#rgb” “\#rrggbb”, “\#rrrgggbbb” or
	 * “\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits of
	 * the red, green, and blue components of the color, respectively.
	 * (White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff”
	 * and “\#ffffffffffff”).
	 *
	 * Deprecated: Use #GdkRGBA
	 *
	 * Params:
	 *     spec = the string specifying the color
	 *     color = the #GdkColor to fill in
	 *
	 * Returns: %TRUE if the parsing succeeded
	 */
	public static bool parse(string spec, out Color color)
	{
		GdkColor* outcolor = sliceNew!GdkColor();

		auto p = gdk_color_parse(Str.toStringz(spec), outcolor) != 0;

		color = ObjectG.getDObject!(Color)(outcolor, true);

		return p;
	}
}