File: SeparatorToolItem.d

package info (click to toggle)
gtk-d 3.10.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,204 kB
  • sloc: javascript: 565; sh: 71; makefile: 23
file content (133 lines) | stat: -rw-r--r-- 3,725 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module gtk.SeparatorToolItem;

private import glib.ConstructionException;
private import gobject.ObjectG;
private import gtk.ToolItem;
private import gtk.c.functions;
public  import gtk.c.types;
public  import gtkc.gtktypes;


/**
 * A #GtkSeparatorToolItem is a #GtkToolItem that separates groups of other
 * #GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will
 * often look like a vertical line on horizontally docked toolbars.
 * 
 * If the #GtkToolbar child property “expand” is %TRUE and the property
 * #GtkSeparatorToolItem:draw is %FALSE, a #GtkSeparatorToolItem will act as
 * a “spring” that forces other items to the ends of the toolbar.
 * 
 * Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem.
 * 
 * # CSS nodes
 * 
 * GtkSeparatorToolItem has a single CSS node with name separator.
 */
public class SeparatorToolItem : ToolItem
{
	/** the main Gtk struct */
	protected GtkSeparatorToolItem* gtkSeparatorToolItem;

	/** Get the main Gtk struct */
	public GtkSeparatorToolItem* getSeparatorToolItemStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkSeparatorToolItem;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkSeparatorToolItem;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GtkSeparatorToolItem* gtkSeparatorToolItem, bool ownedRef = false)
	{
		this.gtkSeparatorToolItem = gtkSeparatorToolItem;
		super(cast(GtkToolItem*)gtkSeparatorToolItem, ownedRef);
	}


	/** */
	public static GType getType()
	{
		return gtk_separator_tool_item_get_type();
	}

	/**
	 * Create a new #GtkSeparatorToolItem
	 *
	 * Returns: the new #GtkSeparatorToolItem
	 *
	 * Since: 2.4
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto p = gtk_separator_tool_item_new();

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(GtkSeparatorToolItem*) p);
	}

	/**
	 * Returns whether @item is drawn as a line, or just blank.
	 * See gtk_separator_tool_item_set_draw().
	 *
	 * Returns: %TRUE if @item is drawn as a line, or just blank.
	 *
	 * Since: 2.4
	 */
	public bool getDraw()
	{
		return gtk_separator_tool_item_get_draw(gtkSeparatorToolItem) != 0;
	}

	/**
	 * Whether @item is drawn as a vertical line, or just blank.
	 * Setting this to %FALSE along with gtk_tool_item_set_expand() is useful
	 * to create an item that forces following items to the end of the toolbar.
	 *
	 * Params:
	 *     draw = whether @item is drawn as a vertical line
	 *
	 * Since: 2.4
	 */
	public void setDraw(bool draw)
	{
		gtk_separator_tool_item_set_draw(gtkSeparatorToolItem, draw);
	}
}