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