gtk.OrientableIF 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 module gtk.OrientableIF;
26 
27 private import gtk.c.functions;
28 public  import gtk.c.types;
29 public  import gtkc.gtktypes;
30 
31 
32 /**
33  * The #GtkOrientable interface is implemented by all widgets that can be
34  * oriented horizontally or vertically. Historically, such widgets have been
35  * realized as subclasses of a common base class (e.g #GtkBox/#GtkHBox/#GtkVBox
36  * or #GtkScale/#GtkHScale/#GtkVScale). #GtkOrientable is more flexible in that
37  * it allows the orientation to be changed at runtime, allowing the widgets
38  * to “flip”.
39  * 
40  * #GtkOrientable was introduced in GTK+ 2.16.
41  */
42 public interface OrientableIF{
43 	/** Get the main Gtk struct */
44 	public GtkOrientable* getOrientableStruct(bool transferOwnership = false);
45 
46 	/** the main Gtk struct as a void* */
47 	protected void* getStruct();
48 
49 
50 	/** */
51 	public static GType getType()
52 	{
53 		return gtk_orientable_get_type();
54 	}
55 
56 	/**
57 	 * Retrieves the orientation of the @orientable.
58 	 *
59 	 * Returns: the orientation of the @orientable.
60 	 *
61 	 * Since: 2.16
62 	 */
63 	public GtkOrientation getOrientation();
64 
65 	/**
66 	 * Sets the orientation of the @orientable.
67 	 *
68 	 * Params:
69 	 *     orientation = the orientable’s new orientation.
70 	 *
71 	 * Since: 2.16
72 	 */
73 	public void setOrientation(GtkOrientation orientation);
74 }