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 * Since: 3.16 56 */ 57 public class StackSidebar : Bin 58 { 59 /** the main Gtk struct */ 60 protected GtkStackSidebar* gtkStackSidebar; 61 62 /** Get the main Gtk struct */ 63 public GtkStackSidebar* getStackSidebarStruct(bool transferOwnership = false) 64 { 65 if (transferOwnership) 66 ownedRef = false; 67 return gtkStackSidebar; 68 } 69 70 /** the main Gtk struct as a void* */ 71 protected override void* getStruct() 72 { 73 return cast(void*)gtkStackSidebar; 74 } 75 76 /** 77 * Sets our main struct and passes it to the parent class. 78 */ 79 public this (GtkStackSidebar* gtkStackSidebar, bool ownedRef = false) 80 { 81 this.gtkStackSidebar = gtkStackSidebar; 82 super(cast(GtkBin*)gtkStackSidebar, ownedRef); 83 } 84 85 86 /** */ 87 public static GType getType() 88 { 89 return gtk_stack_sidebar_get_type(); 90 } 91 92 /** 93 * Creates a new sidebar. 94 * 95 * Returns: the new #GtkStackSidebar 96 * 97 * Since: 3.16 98 * 99 * Throws: ConstructionException GTK+ fails to create the object. 100 */ 101 public this() 102 { 103 auto p = gtk_stack_sidebar_new(); 104 105 if(p is null) 106 { 107 throw new ConstructionException("null returned by new"); 108 } 109 110 this(cast(GtkStackSidebar*) p); 111 } 112 113 /** 114 * Retrieves the stack. 115 * See gtk_stack_sidebar_set_stack(). 116 * 117 * Returns: the associated #GtkStack or 118 * %NULL if none has been set explicitly 119 * 120 * Since: 3.16 121 */ 122 public Stack getStack() 123 { 124 auto p = gtk_stack_sidebar_get_stack(gtkStackSidebar); 125 126 if(p is null) 127 { 128 return null; 129 } 130 131 return ObjectG.getDObject!(Stack)(cast(GtkStack*) p); 132 } 133 134 /** 135 * Set the #GtkStack associated with this #GtkStackSidebar. 136 * 137 * The sidebar widget will automatically update according to the order 138 * (packing) and items within the given #GtkStack. 139 * 140 * Params: 141 * stack = a #GtkStack 142 * 143 * Since: 3.16 144 */ 145 public void setStack(Stack stack) 146 { 147 gtk_stack_sidebar_set_stack(gtkStackSidebar, (stack is null) ? null : stack.getStackStruct()); 148 } 149 }