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