gtk.SeparatorToolItem 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  * Conversion parameters:
26  * inFile  = GtkSeparatorToolItem.html
27  * outPack = gtk
28  * outFile = SeparatorToolItem
29  * strct   = GtkSeparatorToolItem
30  * realStrct=
31  * ctorStrct=GtkToolItem
32  * clss    = SeparatorToolItem
33  * interf  = 
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gtk_separator_tool_item_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * structWrap:
47  * module aliases:
48  * local aliases:
49  * overrides:
50  */
51 
52 module gtk.SeparatorToolItem;
53 
54 public  import gtkc.gtktypes;
55 
56 private import gtkc.gtk;
57 private import glib.ConstructionException;
58 private import gobject.ObjectG;
59 
60 
61 
62 
63 
64 private import gtk.ToolItem;
65 
66 /**
67  * A GtkSeparatorToolItem is a GtkToolItem that separates groups of other
68  * GtkToolItems. Depending on the theme, a GtkSeparatorToolItem will
69  * often look like a vertical line on horizontally docked toolbars.
70  *
71  * If the GtkToolbar child property "expand" is TRUE and the property
72  * "draw" is FALSE, a GtkSeparatorToolItem will act as
73  * a "spring" that forces other items to the ends of the toolbar.
74  *
75  * Use gtk_separator_tool_item_new() to create a new GtkSeparatorToolItem.
76  */
77 public class SeparatorToolItem : ToolItem
78 {
79 	
80 	/** the main Gtk struct */
81 	protected GtkSeparatorToolItem* gtkSeparatorToolItem;
82 	
83 	
84 	public GtkSeparatorToolItem* getSeparatorToolItemStruct()
85 	{
86 		return gtkSeparatorToolItem;
87 	}
88 	
89 	
90 	/** the main Gtk struct as a void* */
91 	protected override void* getStruct()
92 	{
93 		return cast(void*)gtkSeparatorToolItem;
94 	}
95 	
96 	/**
97 	 * Sets our main struct and passes it to the parent class
98 	 */
99 	public this (GtkSeparatorToolItem* gtkSeparatorToolItem)
100 	{
101 		super(cast(GtkToolItem*)gtkSeparatorToolItem);
102 		this.gtkSeparatorToolItem = gtkSeparatorToolItem;
103 	}
104 	
105 	protected override void setStruct(GObject* obj)
106 	{
107 		super.setStruct(obj);
108 		gtkSeparatorToolItem = cast(GtkSeparatorToolItem*)obj;
109 	}
110 	
111 	/**
112 	 */
113 	
114 	/**
115 	 * Create a new GtkSeparatorToolItem
116 	 * Since 2.4
117 	 * Throws: ConstructionException GTK+ fails to create the object.
118 	 */
119 	public this ()
120 	{
121 		// GtkToolItem * gtk_separator_tool_item_new (void);
122 		auto p = gtk_separator_tool_item_new();
123 		if(p is null)
124 		{
125 			throw new ConstructionException("null returned by gtk_separator_tool_item_new()");
126 		}
127 		this(cast(GtkSeparatorToolItem*) p);
128 	}
129 	
130 	/**
131 	 * Whether item is drawn as a vertical line, or just blank.
132 	 * Setting this to FALSE along with gtk_tool_item_set_expand() is useful
133 	 * to create an item that forces following items to the end of the toolbar.
134 	 * Since 2.4
135 	 * Params:
136 	 * draw = whether item is drawn as a vertical line
137 	 */
138 	public void setDraw(int draw)
139 	{
140 		// void gtk_separator_tool_item_set_draw (GtkSeparatorToolItem *item,  gboolean draw);
141 		gtk_separator_tool_item_set_draw(gtkSeparatorToolItem, draw);
142 	}
143 	
144 	/**
145 	 * Returns whether item is drawn as a line, or just blank.
146 	 * See gtk_separator_tool_item_set_draw().
147 	 * Since 2.4
148 	 * Returns: TRUE if item is drawn as a line, or just blank.
149 	 */
150 	public int getDraw()
151 	{
152 		// gboolean gtk_separator_tool_item_get_draw (GtkSeparatorToolItem *item);
153 		return gtk_separator_tool_item_get_draw(gtkSeparatorToolItem);
154 	}
155 }