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 gsv.SourceGutter; 26 27 private import gdk.Window; 28 private import gobject.ObjectG; 29 private import gsv.SourceGutterRenderer; 30 private import gsv.SourceView; 31 private import gsvc.gsv; 32 public import gsvc.gsvtypes; 33 34 35 /** */ 36 public class SourceGutter : ObjectG 37 { 38 /** the main Gtk struct */ 39 protected GtkSourceGutter* gtkSourceGutter; 40 41 /** Get the main Gtk struct */ 42 public GtkSourceGutter* getSourceGutterStruct() 43 { 44 return gtkSourceGutter; 45 } 46 47 /** the main Gtk struct as a void* */ 48 protected override void* getStruct() 49 { 50 return cast(void*)gtkSourceGutter; 51 } 52 53 protected override void setStruct(GObject* obj) 54 { 55 gtkSourceGutter = cast(GtkSourceGutter*)obj; 56 super.setStruct(obj); 57 } 58 59 /** 60 * Sets our main struct and passes it to the parent class. 61 */ 62 public this (GtkSourceGutter* gtkSourceGutter, bool ownedRef = false) 63 { 64 this.gtkSourceGutter = gtkSourceGutter; 65 super(cast(GObject*)gtkSourceGutter, ownedRef); 66 } 67 68 69 /** */ 70 public static GType getType() 71 { 72 return gtk_source_gutter_get_type(); 73 } 74 75 /** 76 * 77 * 78 * Deprecated: Use gtk_source_gutter_renderer_get_padding() instead. 79 */ 80 public void getPadding(int* xpad, int* ypad) 81 { 82 gtk_source_gutter_get_padding(gtkSourceGutter, xpad, ypad); 83 } 84 85 /** 86 * Finds the #GtkSourceGutterRenderer at (x, y). 87 * 88 * Params: 89 * x = The x position to get identified. 90 * y = The y position to get identified. 91 * 92 * Returns: the renderer at (x, y) or %NULL. 93 */ 94 public SourceGutterRenderer getRendererAtPos(int x, int y) 95 { 96 auto p = gtk_source_gutter_get_renderer_at_pos(gtkSourceGutter, x, y); 97 98 if(p is null) 99 { 100 return null; 101 } 102 103 return ObjectG.getDObject!(SourceGutterRenderer)(cast(GtkSourceGutterRenderer*) p); 104 } 105 106 /** 107 * Returns: the associated #GtkSourceView. 108 * 109 * Since: 3.24 110 */ 111 public SourceView getView() 112 { 113 auto p = gtk_source_gutter_get_view(gtkSourceGutter); 114 115 if(p is null) 116 { 117 return null; 118 } 119 120 return ObjectG.getDObject!(SourceView)(cast(GtkSourceView*) p); 121 } 122 123 /** 124 * Get the #GdkWindow of the gutter. The window will only be available when the 125 * gutter has at least one, non-zero width, cell renderer packed. 126 * 127 * Deprecated: Use gtk_text_view_get_window() instead. 128 * 129 * Returns: the #GdkWindow of the gutter, or %NULL 130 * if the gutter has no window. 131 * 132 * Since: 2.8 133 */ 134 public Window getWindow() 135 { 136 auto p = gtk_source_gutter_get_window(gtkSourceGutter); 137 138 if(p is null) 139 { 140 return null; 141 } 142 143 return ObjectG.getDObject!(Window)(cast(GdkWindow*) p); 144 } 145 146 /** 147 * Returns: the #GtkTextWindowType of @gutter. 148 * 149 * Since: 3.24 150 */ 151 public GtkTextWindowType getWindowType() 152 { 153 return gtk_source_gutter_get_window_type(gtkSourceGutter); 154 } 155 156 /** 157 * Insert @renderer into the gutter. If @renderer is yet unowned then gutter 158 * claims its ownership. Otherwise just increases renderer's reference count. 159 * @renderer cannot be already inserted to another gutter. 160 * 161 * Params: 162 * renderer = a gutter renderer (must inherit from #GtkSourceGutterRenderer). 163 * position = the renderer position. 164 * 165 * Returns: %TRUE if operation succeeded. Otherwise %FALSE. 166 * 167 * Since: 3.0 168 */ 169 public bool insert(SourceGutterRenderer renderer, int position) 170 { 171 return gtk_source_gutter_insert(gtkSourceGutter, (renderer is null) ? null : renderer.getSourceGutterRendererStruct(), position) != 0; 172 } 173 174 /** 175 * Invalidates the drawable area of the gutter. You can use this to force a 176 * redraw of the gutter if something has changed and needs to be redrawn. 177 * 178 * Since: 2.8 179 */ 180 public void queueDraw() 181 { 182 gtk_source_gutter_queue_draw(gtkSourceGutter); 183 } 184 185 /** 186 * Removes @renderer from @gutter. 187 * 188 * Params: 189 * renderer = a #GtkSourceGutterRenderer. 190 * 191 * Since: 2.8 192 */ 193 public void remove(SourceGutterRenderer renderer) 194 { 195 gtk_source_gutter_remove(gtkSourceGutter, (renderer is null) ? null : renderer.getSourceGutterRendererStruct()); 196 } 197 198 /** 199 * Reorders @renderer in @gutter to new @position. 200 * 201 * Params: 202 * renderer = a #GtkCellRenderer. 203 * position = the new renderer position. 204 * 205 * Since: 2.8 206 */ 207 public void reorder(SourceGutterRenderer renderer, int position) 208 { 209 gtk_source_gutter_reorder(gtkSourceGutter, (renderer is null) ? null : renderer.getSourceGutterRendererStruct(), position); 210 } 211 212 /** 213 * 214 * 215 * Deprecated: Use gtk_source_gutter_renderer_set_padding() instead. 216 */ 217 public void setPadding(int xpad, int ypad) 218 { 219 gtk_source_gutter_set_padding(gtkSourceGutter, xpad, ypad); 220 } 221 }