GutterLines

Collected information about visible lines.

The gtksource.gutter_lines.GutterLines object is used to collect information about visible lines.

Use this from your signal@GutterRenderer::query-data to collect the necessary information on visible lines. Doing so reduces the number of passes through the text btree allowing GtkSourceView to reach more frames-per-second while performing kinetic scrolling.

class GutterLines : ObjectG {

void addClass(uint line, string name);

void addQclass(uint line, glib.types.Quark qname);

gtk.text_buffer.TextBuffer getBuffer();

uint getFirst();

void getIterAtLine(gtk.text_iter.TextIter iter, uint line);

uint getLast();

void getLineYrange(uint line, gtksource.types.GutterRendererAlignmentMode mode, int y, int height);

gtk.text_view.TextView getView();

bool hasAnyClass(uint line);

bool hasClass(uint line, string name);

bool hasQclass(uint line, glib.types.Quark qname);

bool isCursor(uint line);

bool isPrelit(uint line);

bool isSelected(uint line);

void removeClass(uint line, string name);

void removeQclass(uint line, glib.types.Quark qname);

}

Members

Functions

addClass void addClass(uint line, string name): Adds the class name to line.
addQclass void addQclass(uint line, glib.types.Quark qname): Adds the class denoted by qname to line.
getBuffer gtk.text_buffer.TextBuffer getBuffer(): Gets the gtk.text_buffer.TextBuffer that the gtksource.gutter_lines.GutterLines represents.
getFirst uint getFirst(): Gets the line number (starting from 0) for the first line that is user visible.
getIterAtLine void getIterAtLine(gtk.text_iter.TextIter iter, uint line): Gets a #GtkTextIter for the current buffer at line
getLast uint getLast(): Gets the line number (starting from 0) for the last line that is user visible.
getLineYrange void getLineYrange(uint line, gtksource.types.GutterRendererAlignmentMode mode, int y, int height): Gets the Y range for a line based on mode.
getView gtk.text_view.TextView getView(): Gets the gtk.text_view.TextView that the gtksource.gutter_lines.GutterLines represents.
hasAnyClass bool hasAnyClass(uint line): Checks to see if the line has any GQuark classes set. This can be used to help renderer implementations avoid work if nothing has been set on the class.
hasClass bool hasClass(uint line, string name): Checks to see if gtksource.gutter_lines.GutterLines.addClass was called with the name for line.
hasQclass bool hasQclass(uint line, glib.types.Quark qname): Checks to see if gtksource.gutter_lines.GutterLines.addQclass was called with the quark denoted by qname for line.
isCursor bool isCursor(uint line): Checks to see if line contains the insertion cursor.
isPrelit bool isPrelit(uint line): Checks to see if line is marked as prelit. Generally, this means the mouse pointer is over the line within the gutter.
isSelected bool isSelected(uint line): Checks to see if the view had a selection and if that selection overlaps line in some way.
removeClass void removeClass(uint line, string name): Removes the class matching name from line.
removeQclass void removeQclass(uint line, glib.types.Quark qname): Reverses a call to gtksource.gutter_lines.GutterLines.addQclass by removing the glib.types.uint matching qname.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtksource gutter_lines classes

GutterLines