gtk.TearoffMenuItem 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  = GtkTearoffMenuItem.html
27  * outPack = gtk
28  * outFile = TearoffMenuItem
29  * strct   = GtkTearoffMenuItem
30  * realStrct=
31  * ctorStrct=
32  * clss    = TearoffMenuItem
33  * interf  = 
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gtk_tearoff_menu_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.TearoffMenuItem;
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.MenuItem;
65 
66 /**
67  * A GtkTearoffMenuItem is a special GtkMenuItem which is used to
68  * tear off and reattach its menu.
69  *
70  * When its menu is shown normally, the GtkTearoffMenuItem is drawn as a
71  * dotted line indicating that the menu can be torn off. Activating it
72  * causes its menu to be torn off and displayed in its own window
73  * as a tearoff menu.
74  *
75  * When its menu is shown as a tearoff menu, the GtkTearoffMenuItem is drawn
76  * as a dotted line which has a left pointing arrow graphic indicating that
77  * the tearoff menu can be reattached. Activating it will erase the tearoff
78  * menu window.
79  *
80  * Note
81  *
82  * GtkTearoffMenuItem is deprecated and should not be used in newly
83  * written code. Menus are not meant to be torn around.
84  */
85 public class TearoffMenuItem : MenuItem
86 {
87 	
88 	/** the main Gtk struct */
89 	protected GtkTearoffMenuItem* gtkTearoffMenuItem;
90 	
91 	
92 	public GtkTearoffMenuItem* getTearoffMenuItemStruct()
93 	{
94 		return gtkTearoffMenuItem;
95 	}
96 	
97 	
98 	/** the main Gtk struct as a void* */
99 	protected override void* getStruct()
100 	{
101 		return cast(void*)gtkTearoffMenuItem;
102 	}
103 	
104 	/**
105 	 * Sets our main struct and passes it to the parent class
106 	 */
107 	public this (GtkTearoffMenuItem* gtkTearoffMenuItem)
108 	{
109 		super(cast(GtkMenuItem*)gtkTearoffMenuItem);
110 		this.gtkTearoffMenuItem = gtkTearoffMenuItem;
111 	}
112 	
113 	protected override void setStruct(GObject* obj)
114 	{
115 		super.setStruct(obj);
116 		gtkTearoffMenuItem = cast(GtkTearoffMenuItem*)obj;
117 	}
118 	
119 	/**
120 	 */
121 	
122 	/**
123 	 * Warning
124 	 * gtk_tearoff_menu_item_new has been deprecated since version 3.4 and should not be used in newly-written code. GtkTearoffMenuItem is deprecated and should not be
125 	 *  used in newly written code.
126 	 * Creates a new GtkTearoffMenuItem.
127 	 * Throws: ConstructionException GTK+ fails to create the object.
128 	 */
129 	public this ()
130 	{
131 		// GtkWidget * gtk_tearoff_menu_item_new (void);
132 		auto p = gtk_tearoff_menu_item_new();
133 		if(p is null)
134 		{
135 			throw new ConstructionException("null returned by gtk_tearoff_menu_item_new()");
136 		}
137 		this(cast(GtkTearoffMenuItem*) p);
138 	}
139 }