gtk.StackSidebar 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.StackSidebar;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Bin;
30 private import gtk.Stack;
31 private import gtk.Widget;
32 private import gtk.c.functions;
33 public  import gtk.c.types;
34 public  import gtkc.gtktypes;
35 
36 
37 /**
38  * A GtkStackSidebar enables you to quickly and easily provide a
39  * consistent "sidebar" object for your user interface.
40  * 
41  * In order to use a GtkStackSidebar, you simply use a GtkStack to
42  * organize your UI flow, and add the sidebar to your sidebar area. You
43  * can use gtk_stack_sidebar_set_stack() to connect the #GtkStackSidebar
44  * to the #GtkStack.
45  * 
46  * # CSS nodes
47  * 
48  * GtkStackSidebar has a single CSS node with name stacksidebar and
49  * style class .sidebar.
50  * 
51  * When circumstances require it, GtkStackSidebar adds the
52  * .needs-attention style class to the widgets representing the stack
53  * pages.
54  */
55 public class StackSidebar : Bin
56 {
57 	/** the main Gtk struct */
58 	protected GtkStackSidebar* gtkStackSidebar;
59 
60 	/** Get the main Gtk struct */
61 	public GtkStackSidebar* getStackSidebarStruct(bool transferOwnership = false)
62 	{
63 		if (transferOwnership)
64 			ownedRef = false;
65 		return gtkStackSidebar;
66 	}
67 
68 	/** the main Gtk struct as a void* */
69 	protected override void* getStruct()
70 	{
71 		return cast(void*)gtkStackSidebar;
72 	}
73 
74 	/**
75 	 * Sets our main struct and passes it to the parent class.
76 	 */
77 	public this (GtkStackSidebar* gtkStackSidebar, bool ownedRef = false)
78 	{
79 		this.gtkStackSidebar = gtkStackSidebar;
80 		super(cast(GtkBin*)gtkStackSidebar, ownedRef);
81 	}
82 
83 
84 	/** */
85 	public static GType getType()
86 	{
87 		return gtk_stack_sidebar_get_type();
88 	}
89 
90 	/**
91 	 * Creates a new sidebar.
92 	 *
93 	 * Returns: the new #GtkStackSidebar
94 	 *
95 	 * Since: 3.16
96 	 *
97 	 * Throws: ConstructionException GTK+ fails to create the object.
98 	 */
99 	public this()
100 	{
101 		auto p = gtk_stack_sidebar_new();
102 
103 		if(p is null)
104 		{
105 			throw new ConstructionException("null returned by new");
106 		}
107 
108 		this(cast(GtkStackSidebar*) p);
109 	}
110 
111 	/**
112 	 * Retrieves the stack.
113 	 * See gtk_stack_sidebar_set_stack().
114 	 *
115 	 * Returns: the associated #GtkStack or
116 	 *     %NULL if none has been set explicitly
117 	 *
118 	 * Since: 3.16
119 	 */
120 	public Stack getStack()
121 	{
122 		auto p = gtk_stack_sidebar_get_stack(gtkStackSidebar);
123 
124 		if(p is null)
125 		{
126 			return null;
127 		}
128 
129 		return ObjectG.getDObject!(Stack)(cast(GtkStack*) p);
130 	}
131 
132 	/**
133 	 * Set the #GtkStack associated with this #GtkStackSidebar.
134 	 *
135 	 * The sidebar widget will automatically update according to the order
136 	 * (packing) and items within the given #GtkStack.
137 	 *
138 	 * Params:
139 	 *     stack = a #GtkStack
140 	 *
141 	 * Since: 3.16
142 	 */
143 	public void setStack(Stack stack)
144 	{
145 		gtk_stack_sidebar_set_stack(gtkStackSidebar, (stack is null) ? null : stack.getStackStruct());
146 	}
147 }