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 private import gtk.ToolItem;
63 
64 /**
65  * A GtkSeparatorToolItem is a GtkToolItem that separates groups of other
66  * GtkToolItems. Depending on the theme, a GtkSeparatorToolItem will
67  * often look like a vertical line on horizontally docked toolbars.
68  *
69  * If the GtkToolbar child property "expand" is TRUE and the property
70  * "draw" is FALSE, a GtkSeparatorToolItem will act as
71  * a "spring" that forces other items to the ends of the toolbar.
72  *
73  * Use gtk_separator_tool_item_new() to create a new GtkSeparatorToolItem.
74  */
75 public class SeparatorToolItem : ToolItem
76 {
77 	
78 	/** the main Gtk struct */
79 	protected GtkSeparatorToolItem* gtkSeparatorToolItem;
80 	
81 	
82 	/** Get the main Gtk struct */
83 	public GtkSeparatorToolItem* getSeparatorToolItemStruct()
84 	{
85 		return gtkSeparatorToolItem;
86 	}
87 	
88 	
89 	/** the main Gtk struct as a void* */
90 	protected override void* getStruct()
91 	{
92 		return cast(void*)gtkSeparatorToolItem;
93 	}
94 	
95 	/**
96 	 * Sets our main struct and passes it to the parent class
97 	 */
98 	public this (GtkSeparatorToolItem* gtkSeparatorToolItem)
99 	{
100 		super(cast(GtkToolItem*)gtkSeparatorToolItem);
101 		this.gtkSeparatorToolItem = gtkSeparatorToolItem;
102 	}
103 	
104 	protected override void setStruct(GObject* obj)
105 	{
106 		super.setStruct(obj);
107 		gtkSeparatorToolItem = cast(GtkSeparatorToolItem*)obj;
108 	}
109 	
110 	/**
111 	 */
112 	
113 	/**
114 	 * Create a new GtkSeparatorToolItem
115 	 * Since 2.4
116 	 * Throws: ConstructionException GTK+ fails to create the object.
117 	 */
118 	public this ()
119 	{
120 		// GtkToolItem * gtk_separator_tool_item_new (void);
121 		auto p = gtk_separator_tool_item_new();
122 		if(p is null)
123 		{
124 			throw new ConstructionException("null returned by gtk_separator_tool_item_new()");
125 		}
126 		this(cast(GtkSeparatorToolItem*) p);
127 	}
128 	
129 	/**
130 	 * Whether item is drawn as a vertical line, or just blank.
131 	 * Setting this to FALSE along with gtk_tool_item_set_expand() is useful
132 	 * to create an item that forces following items to the end of the toolbar.
133 	 * Since 2.4
134 	 * Params:
135 	 * draw = whether item is drawn as a vertical line
136 	 */
137 	public void setDraw(int draw)
138 	{
139 		// void gtk_separator_tool_item_set_draw (GtkSeparatorToolItem *item,  gboolean draw);
140 		gtk_separator_tool_item_set_draw(gtkSeparatorToolItem, draw);
141 	}
142 	
143 	/**
144 	 * Returns whether item is drawn as a line, or just blank.
145 	 * See gtk_separator_tool_item_set_draw().
146 	 * Since 2.4
147 	 * Returns: TRUE if item is drawn as a line, or just blank.
148 	 */
149 	public int getDraw()
150 	{
151 		// gboolean gtk_separator_tool_item_get_draw (GtkSeparatorToolItem *item);
152 		return gtk_separator_tool_item_get_draw(gtkSeparatorToolItem);
153 	}
154 }