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.SeparatorToolItem;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.ToolItem;
30 private import gtk.c.functions;
31 public  import gtk.c.types;
32 public  import gtkc.gtktypes;
33 
34 
35 /**
36  * A #GtkSeparatorToolItem is a #GtkToolItem that separates groups of other
37  * #GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will
38  * often look like a vertical line on horizontally docked toolbars.
39  * 
40  * If the #GtkToolbar child property “expand” is %TRUE and the property
41  * #GtkSeparatorToolItem:draw is %FALSE, a #GtkSeparatorToolItem will act as
42  * a “spring” that forces other items to the ends of the toolbar.
43  * 
44  * Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem.
45  * 
46  * # CSS nodes
47  * 
48  * GtkSeparatorToolItem has a single CSS node with name separator.
49  */
50 public class SeparatorToolItem : ToolItem
51 {
52 	/** the main Gtk struct */
53 	protected GtkSeparatorToolItem* gtkSeparatorToolItem;
54 
55 	/** Get the main Gtk struct */
56 	public GtkSeparatorToolItem* getSeparatorToolItemStruct(bool transferOwnership = false)
57 	{
58 		if (transferOwnership)
59 			ownedRef = false;
60 		return gtkSeparatorToolItem;
61 	}
62 
63 	/** the main Gtk struct as a void* */
64 	protected override void* getStruct()
65 	{
66 		return cast(void*)gtkSeparatorToolItem;
67 	}
68 
69 	/**
70 	 * Sets our main struct and passes it to the parent class.
71 	 */
72 	public this (GtkSeparatorToolItem* gtkSeparatorToolItem, bool ownedRef = false)
73 	{
74 		this.gtkSeparatorToolItem = gtkSeparatorToolItem;
75 		super(cast(GtkToolItem*)gtkSeparatorToolItem, ownedRef);
76 	}
77 
78 
79 	/** */
80 	public static GType getType()
81 	{
82 		return gtk_separator_tool_item_get_type();
83 	}
84 
85 	/**
86 	 * Create a new #GtkSeparatorToolItem
87 	 *
88 	 * Returns: the new #GtkSeparatorToolItem
89 	 *
90 	 * Since: 2.4
91 	 *
92 	 * Throws: ConstructionException GTK+ fails to create the object.
93 	 */
94 	public this()
95 	{
96 		auto p = gtk_separator_tool_item_new();
97 
98 		if(p is null)
99 		{
100 			throw new ConstructionException("null returned by new");
101 		}
102 
103 		this(cast(GtkSeparatorToolItem*) p);
104 	}
105 
106 	/**
107 	 * Returns whether @item is drawn as a line, or just blank.
108 	 * See gtk_separator_tool_item_set_draw().
109 	 *
110 	 * Returns: %TRUE if @item is drawn as a line, or just blank.
111 	 *
112 	 * Since: 2.4
113 	 */
114 	public bool getDraw()
115 	{
116 		return gtk_separator_tool_item_get_draw(gtkSeparatorToolItem) != 0;
117 	}
118 
119 	/**
120 	 * Whether @item is drawn as a vertical line, or just blank.
121 	 * Setting this to %FALSE along with gtk_tool_item_set_expand() is useful
122 	 * to create an item that forces following items to the end of the toolbar.
123 	 *
124 	 * Params:
125 	 *     draw = whether @item is drawn as a vertical line
126 	 *
127 	 * Since: 2.4
128 	 */
129 	public void setDraw(bool draw)
130 	{
131 		gtk_separator_tool_item_set_draw(gtkSeparatorToolItem, draw);
132 	}
133 }