gtk.ColorChooserIF 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.ColorChooserIF;
26 
27 private import gdk.RGBA;
28 private import gobject.ObjectG;
29 private import gobject.Signals;
30 public  import gtkc.gdktypes;
31 private import gtkc.gtk;
32 public  import gtkc.gtktypes;
33 
34 
35 /**
36  * #GtkColorChooser is an interface that is implemented by widgets
37  * for choosing colors. Depending on the situation, colors may be
38  * allowed to have alpha (translucency).
39  * 
40  * In GTK+, the main widgets that implement this interface are
41  * #GtkColorChooserWidget, #GtkColorChooserDialog and #GtkColorButton.
42  */
43 public interface ColorChooserIF{
44 	/** Get the main Gtk struct */
45 	public GtkColorChooser* getColorChooserStruct();
46 
47 	/** the main Gtk struct as a void* */
48 	protected void* getStruct();
49 
50 
51 	/**
52 	 * Adds a palette to the color chooser. If @orientation is horizontal,
53 	 * the colors are grouped in rows, with @colors_per_line colors
54 	 * in each row. If @horizontal is %FALSE, the colors are grouped
55 	 * in columns instead.
56 	 *
57 	 * The default color palette of #GtkColorChooserWidget has
58 	 * 27 colors, organized in columns of 3 colors. The default gray
59 	 * palette has 9 grays in a single row.
60 	 *
61 	 * The layout of the color chooser widget works best when the
62 	 * palettes have 9-10 columns.
63 	 *
64 	 * Calling this function for the first time has the
65 	 * side effect of removing the default color and gray palettes
66 	 * from the color chooser.
67 	 *
68 	 * If @colors is %NULL, removes all previously added palettes.
69 	 *
70 	 * Params:
71 	 *     orientation = %GTK_ORIENTATION_HORIZONTAL if the palette should
72 	 *         be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns
73 	 *     colorsPerLine = the number of colors to show in each row/column
74 	 *     nColors = the total number of elements in @colors
75 	 *     colors = the colors of the palette, or %NULL
76 	 *
77 	 * Since: 3.4
78 	 */
79 	public void addPalette(GtkOrientation orientation, int colorsPerLine, RGBA[] colors);
80 
81 	/**
82 	 * Gets the currently-selected color.
83 	 *
84 	 * Params:
85 	 *     color = a #GdkRGBA to fill in with the current color
86 	 *
87 	 * Since: 3.4
88 	 */
89 	public void getRgba(out RGBA color);
90 
91 	/**
92 	 * Returns whether the color chooser shows the alpha channel.
93 	 *
94 	 * Return: %TRUE if the color chooser uses the alpha channel,
95 	 *     %FALSE if not
96 	 *
97 	 * Since: 3.4
98 	 */
99 	public bool getUseAlpha();
100 
101 	/**
102 	 * Sets the color.
103 	 *
104 	 * Params:
105 	 *     color = the new color
106 	 *
107 	 * Since: 3.4
108 	 */
109 	public void setRgba(RGBA color);
110 
111 	/**
112 	 * Sets whether or not the color chooser should use the alpha channel.
113 	 *
114 	 * Params:
115 	 *     useAlpha = %TRUE if color chooser should use alpha channel, %FALSE if not
116 	 *
117 	 * Since: 3.4
118 	 */
119 	public void setUseAlpha(bool useAlpha);
120 	@property void delegate(RGBA, ColorChooserIF)[] onColorActivatedListeners();
121 	/**
122 	 * Emitted when a color is activated from the color chooser.
123 	 * This usually happens when the user clicks a color swatch,
124 	 * or a color is selected and the user presses one of the keys
125 	 * Space, Shift+Space, Return or Enter.
126 	 *
127 	 * Params:
128 	 *     color = the color
129 	 *
130 	 * Since: 3.4
131 	 */
132 	void addOnColorActivated(void delegate(RGBA, ColorChooserIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
133 
134 }