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.ColorChooserT;
26 
27 public  import gdk.RGBA;
28 public  import glib.MemorySlice;
29 public  import gobject.ObjectG;
30 public  import gobject.Signals;
31 public  import gtk.c.functions;
32 public  import gtk.c.types;
33 public  import gtkc.gtktypes;
34 public  import std.algorithm;
35 
36 
37 /**
38  * #GtkColorChooser is an interface that is implemented by widgets
39  * for choosing colors. Depending on the situation, colors may be
40  * allowed to have alpha (translucency).
41  * 
42  * In GTK+, the main widgets that implement this interface are
43  * #GtkColorChooserWidget, #GtkColorChooserDialog and #GtkColorButton.
44  */
45 public template ColorChooserT(TStruct)
46 {
47 	/** Get the main Gtk struct */
48 	public GtkColorChooser* getColorChooserStruct(bool transferOwnership = false)
49 	{
50 		if (transferOwnership)
51 			ownedRef = false;
52 		return cast(GtkColorChooser*)getStruct();
53 	}
54 
55 
56 	/**
57 	 * Adds a palette to the color chooser. If @orientation is horizontal,
58 	 * the colors are grouped in rows, with @colors_per_line colors
59 	 * in each row. If @horizontal is %FALSE, the colors are grouped
60 	 * in columns instead.
61 	 *
62 	 * The default color palette of #GtkColorChooserWidget has
63 	 * 27 colors, organized in columns of 3 colors. The default gray
64 	 * palette has 9 grays in a single row.
65 	 *
66 	 * The layout of the color chooser widget works best when the
67 	 * palettes have 9-10 columns.
68 	 *
69 	 * Calling this function for the first time has the
70 	 * side effect of removing the default color and gray palettes
71 	 * from the color chooser.
72 	 *
73 	 * If @colors is %NULL, removes all previously added palettes.
74 	 *
75 	 * Params:
76 	 *     orientation = %GTK_ORIENTATION_HORIZONTAL if the palette should
77 	 *         be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns
78 	 *     colorsPerLine = the number of colors to show in each row/column
79 	 *     colors = the colors of the palette, or %NULL
80 	 *
81 	 * Since: 3.4
82 	 */
83 	public void addPalette(GtkOrientation orientation, int colorsPerLine, RGBA[] colors)
84 	{
85 		GdkRGBA[] colorsArray = new GdkRGBA[colors.length];
86 		for ( int i = 0; i < colors.length; i++ )
87 		{
88 			colorsArray[i] = *(colors[i].getRGBAStruct());
89 		}
90 
91 		gtk_color_chooser_add_palette(getColorChooserStruct(), orientation, colorsPerLine, cast(int)colors.length, colorsArray.ptr);
92 	}
93 
94 	/**
95 	 * Gets the currently-selected color.
96 	 *
97 	 * Params:
98 	 *     color = a #GdkRGBA to fill in with the current color
99 	 *
100 	 * Since: 3.4
101 	 */
102 	public void getRgba(out RGBA color)
103 	{
104 		GdkRGBA* outcolor = sliceNew!GdkRGBA();
105 
106 		gtk_color_chooser_get_rgba(getColorChooserStruct(), outcolor);
107 
108 		color = ObjectG.getDObject!(RGBA)(outcolor, true);
109 	}
110 
111 	/**
112 	 * Returns whether the color chooser shows the alpha channel.
113 	 *
114 	 * Returns: %TRUE if the color chooser uses the alpha channel,
115 	 *     %FALSE if not
116 	 *
117 	 * Since: 3.4
118 	 */
119 	public bool getUseAlpha()
120 	{
121 		return gtk_color_chooser_get_use_alpha(getColorChooserStruct()) != 0;
122 	}
123 
124 	/**
125 	 * Sets the color.
126 	 *
127 	 * Params:
128 	 *     color = the new color
129 	 *
130 	 * Since: 3.4
131 	 */
132 	public void setRgba(RGBA color)
133 	{
134 		gtk_color_chooser_set_rgba(getColorChooserStruct(), (color is null) ? null : color.getRGBAStruct());
135 	}
136 
137 	/**
138 	 * Sets whether or not the color chooser should use the alpha channel.
139 	 *
140 	 * Params:
141 	 *     useAlpha = %TRUE if color chooser should use alpha channel, %FALSE if not
142 	 *
143 	 * Since: 3.4
144 	 */
145 	public void setUseAlpha(bool useAlpha)
146 	{
147 		gtk_color_chooser_set_use_alpha(getColorChooserStruct(), useAlpha);
148 	}
149 
150 	/**
151 	 * Emitted when a color is activated from the color chooser.
152 	 * This usually happens when the user clicks a color swatch,
153 	 * or a color is selected and the user presses one of the keys
154 	 * Space, Shift+Space, Return or Enter.
155 	 *
156 	 * Params:
157 	 *     color = the color
158 	 *
159 	 * Since: 3.4
160 	 */
161 	gulong addOnColorActivated(void delegate(RGBA, ColorChooserIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
162 	{
163 		return Signals.connect(this, "color-activated", dlg, connectFlags ^ ConnectFlags.SWAPPED);
164 	}
165 }