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 = GtkScrollable.html 27 * outPack = gtk 28 * outFile = ScrollableIF 29 * strct = GtkScrollable 30 * realStrct= 31 * ctorStrct= 32 * clss = ScrollableT 33 * interf = ScrollableIF 34 * class Code: No 35 * interface Code: No 36 * template for: 37 * extend = 38 * implements: 39 * prefixes: 40 * - gtk_scrollable_ 41 * omit structs: 42 * omit prefixes: 43 * omit code: 44 * omit signals: 45 * imports: 46 * - gtk.Adjustment 47 * structWrap: 48 * - GtkAdjustment* -> Adjustment 49 * module aliases: 50 * local aliases: 51 * overrides: 52 */ 53 54 module gtk.ScrollableIF; 55 56 public import gtkc.gtktypes; 57 58 private import gtkc.gtk; 59 private import glib.ConstructionException; 60 private import gobject.ObjectG; 61 62 private import gtk.Adjustment; 63 64 65 66 /** 67 * GtkScrollable is an interface that is implemented by widgets with native 68 * scrolling ability. 69 * 70 * To implement this interface you should override the 71 * "hadjustment" and "vadjustment" properties. 72 * 73 * Creating a scrollable widget 74 * 75 * All scrollable widgets should do the following. 76 * 77 * When a parent widget sets the scrollable child widget's adjustments, the widget should populate the adjustments' 78 * "lower", "upper", 79 * "step-increment", "page-increment" and 80 * "page-size" properties and connect to the 81 * "value-changed" signal. 82 * 83 * Because its preferred size is the size for a fully expanded widget, 84 * the scrollable widget must be able to cope with underallocations. 85 * This means that it must accept any value passed to its 86 * GtkWidgetClass.size_allocate() function. 87 * 88 * When the parent allocates space to the scrollable child widget, the widget should update 89 * the adjustments' properties with new values. 90 * 91 * When any of the adjustments emits the "value-changed" signal, 92 * the scrollable widget should scroll its contents. 93 */ 94 public interface ScrollableIF 95 { 96 97 98 /** Get the main Gtk struct */ 99 public GtkScrollable* getScrollableTStruct(); 100 101 /** the main Gtk struct as a void* */ 102 protected void* getStruct(); 103 104 105 /** 106 */ 107 108 /** 109 * Retrieves the GtkAdjustment used for horizontal scrolling. 110 * Returns: horizontal GtkAdjustment. [transfer none] Since 3.0 111 */ 112 public Adjustment getHadjustment(); 113 114 /** 115 * Sets the horizontal adjustment of the GtkScrollable. 116 * Params: 117 * hadjustment = a GtkAdjustment. [allow-none] 118 * Since 3.0 119 */ 120 public void setHadjustment(Adjustment hadjustment); 121 122 /** 123 * Retrieves the GtkAdjustment used for vertical scrolling. 124 * Returns: vertical GtkAdjustment. [transfer none] Since 3.0 125 */ 126 public Adjustment getVadjustment(); 127 128 /** 129 * Sets the vertical adjustment of the GtkScrollable. 130 * Params: 131 * vadjustment = a GtkAdjustment. [allow-none] 132 * Since 3.0 133 */ 134 public void setVadjustment(Adjustment vadjustment); 135 136 /** 137 * Gets the horizontal GtkScrollablePolicy. 138 * Returns: The horizontal GtkScrollablePolicy. Since 3.0 139 */ 140 public GtkScrollablePolicy getHscrollPolicy(); 141 142 /** 143 * Sets the GtkScrollablePolicy to determine whether 144 * horizontal scrolling should start below the minimum width or 145 * below the natural width. 146 * Params: 147 * policy = the horizontal GtkScrollablePolicy 148 * Since 3.0 149 */ 150 public void setHscrollPolicy(GtkScrollablePolicy policy); 151 152 /** 153 * Gets the vertical GtkScrollablePolicy. 154 * Returns: The vertical GtkScrollablePolicy. Since 3.0 155 */ 156 public GtkScrollablePolicy getVscrollPolicy(); 157 158 /** 159 * Sets the GtkScrollablePolicy to determine whether 160 * vertical scrolling should start below the minimum height or 161 * below the natural height. 162 * Params: 163 * policy = the vertical GtkScrollablePolicy 164 * Since 3.0 165 */ 166 public void setVscrollPolicy(GtkScrollablePolicy policy); 167 }