gtk.ColorChooserWidget 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.ColorChooserWidget;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Box;
30 private import gtk.ColorChooserIF;
31 private import gtk.ColorChooserT;
32 private import gtk.Widget;
33 private import gtkc.gtk;
34 public  import gtkc.gtktypes;
35 
36 
37 /**
38  * The #GtkColorChooserWidget widget lets the user select a
39  * color. By default, the chooser presents a predefined palette
40  * of colors, plus a small number of settable custom colors.
41  * It is also possible to select a different color with the
42  * single-color editor. To enter the single-color editing mode,
43  * use the context menu of any color of the palette, or use the
44  * '+' button to add a new custom color.
45  * 
46  * The chooser automatically remembers the last selection, as well
47  * as custom colors.
48  * 
49  * To change the initially selected color, use gtk_color_chooser_set_rgba().
50  * To get the selected color use gtk_color_chooser_get_rgba().
51  * 
52  * The #GtkColorChooserWidget is used in the #GtkColorChooserDialog
53  * to provide a dialog for selecting colors.
54  */
55 public class ColorChooserWidget : Box, ColorChooserIF
56 {
57 	/** the main Gtk struct */
58 	protected GtkColorChooserWidget* gtkColorChooserWidget;
59 
60 	/** Get the main Gtk struct */
61 	public GtkColorChooserWidget* getColorChooserWidgetStruct()
62 	{
63 		return gtkColorChooserWidget;
64 	}
65 
66 	/** the main Gtk struct as a void* */
67 	protected override void* getStruct()
68 	{
69 		return cast(void*)gtkColorChooserWidget;
70 	}
71 
72 	protected override void setStruct(GObject* obj)
73 	{
74 		gtkColorChooserWidget = cast(GtkColorChooserWidget*)obj;
75 		super.setStruct(obj);
76 	}
77 
78 	/**
79 	 * Sets our main struct and passes it to the parent class.
80 	 */
81 	public this (GtkColorChooserWidget* gtkColorChooserWidget, bool ownedRef = false)
82 	{
83 		this.gtkColorChooserWidget = gtkColorChooserWidget;
84 		super(cast(GtkBox*)gtkColorChooserWidget, ownedRef);
85 	}
86 
87 	// add the ColorChooser capabilities
88 	mixin ColorChooserT!(GtkColorChooserWidget);
89 
90 	/**
91 	 */
92 
93 	public static GType getType()
94 	{
95 		return gtk_color_chooser_widget_get_type();
96 	}
97 
98 	/**
99 	 * Creates a new #GtkColorChooserWidget.
100 	 *
101 	 * Return: a new #GtkColorChooserWidget
102 	 *
103 	 * Since: 3.4
104 	 *
105 	 * Throws: ConstructionException GTK+ fails to create the object.
106 	 */
107 	public this()
108 	{
109 		auto p = gtk_color_chooser_widget_new();
110 		
111 		if(p is null)
112 		{
113 			throw new ConstructionException("null returned by new");
114 		}
115 		
116 		this(cast(GtkColorChooserWidget*) p);
117 	}
118 }