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