SearchContext

class SearchContext : ObjectWrap {}

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this(gtksource.buffer.Buffer buffer, gtksource.search_settings.SearchSettings settings)

Creates a new search context, associated with buffer, and customized with settings. If settings is null, a new #GtkSourceSearchSettings object will be created, that you can retrieve with gtksource.search_context.SearchContext.getSettings.

Members

Functions

backward
bool backward(gtk.text_iter.TextIter iter, gtk.text_iter.TextIter matchStart, gtk.text_iter.TextIter matchEnd, bool hasWrappedAround)

Synchronous backward search. It is recommended to use the asynchronous functions instead, to not block the user interface. However, if you are sure that the buffer is small, this function is more convenient to use.

backwardAsync
void backwardAsync(gtk.text_iter.TextIter iter, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

The asynchronous version of gtksource.search_context.SearchContext.backward.

backwardFinish
bool backwardFinish(gio.async_result.AsyncResult result, gtk.text_iter.TextIter matchStart, gtk.text_iter.TextIter matchEnd, bool hasWrappedAround)

Finishes a backward search started with gtksource.search_context.SearchContext.backwardAsync.

forward
bool forward(gtk.text_iter.TextIter iter, gtk.text_iter.TextIter matchStart, gtk.text_iter.TextIter matchEnd, bool hasWrappedAround)

Synchronous forward search. It is recommended to use the asynchronous functions instead, to not block the user interface. However, if you are sure that the buffer is small, this function is more convenient to use.

forwardAsync
void forwardAsync(gtk.text_iter.TextIter iter, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

The asynchronous version of gtksource.search_context.SearchContext.forward.

forwardFinish
bool forwardFinish(gio.async_result.AsyncResult result, gtk.text_iter.TextIter matchStart, gtk.text_iter.TextIter matchEnd, bool hasWrappedAround)

Finishes a forward search started with gtksource.search_context.SearchContext.forwardAsync.

getBuffer
gtksource.buffer.Buffer getBuffer()
getHighlight
bool getHighlight()
getMatchStyle
gtksource.style.Style getMatchStyle()
getOccurrencePosition
int getOccurrencePosition(gtk.text_iter.TextIter matchStart, gtk.text_iter.TextIter matchEnd)

Gets the position of a search occurrence. If the buffer is not already fully scanned, the position may be unknown, and -1 is returned. If 0 is returned, it means that this part of the buffer has already been scanned, and that match_start and match_end don't delimit an occurrence.

getOccurrencesCount
int getOccurrencesCount()

Gets the total number of search occurrences. If the buffer is not already fully scanned, the total number of occurrences is unknown, and -1 is returned.

getRegexError
glib.error.ErrorWrap getRegexError()

Regular expression patterns must follow certain rules. If #GtkSourceSearchSettings:search-text breaks a rule, the error can be retrieved with this function. The error domain is #G_REGEX_ERROR.

getSettings
gtksource.search_settings.SearchSettings getSettings()
replace
bool replace(gtk.text_iter.TextIter matchStart, gtk.text_iter.TextIter matchEnd, string replace)

Replaces a search match by another text. If match_start and match_end doesn't correspond to a search match, false is returned.

replaceAll
uint replaceAll(string replace)

Replaces all search matches by another text. It is a synchronous function, so it can block the user interface.

self
SearchContext self()

Returns this, for use in with statements.

setHighlight
void setHighlight(bool highlight)

Enables or disables the search occurrences highlighting.

setMatchStyle
void setMatchStyle(gtksource.style.Style matchStyle)

Set the style to apply on search matches. If match_style is null, default theme's scheme 'match-style' will be used. To enable or disable the search highlighting, use gtksource.search_context.SearchContext.setHighlight.

Properties

_gType
GType _gType [@property getter]
buffer
gtksource.buffer.Buffer buffer [@property getter]

Get buffer property.

highlight
bool highlight [@property getter]

Get highlight property.

highlight
bool highlight [@property setter]

Set highlight property.

matchStyle
gtksource.style.Style matchStyle [@property getter]

Get matchStyle property.

matchStyle
gtksource.style.Style matchStyle [@property setter]

Set matchStyle property.

occurrencesCount
int occurrencesCount [@property getter]

Get occurrencesCount property.

regexError
void* regexError [@property getter]

Get regexError property.

settings
gtksource.search_settings.SearchSettings settings [@property getter]

Get settings property.

Static functions

_getGType
GType _getGType()
builder
SearchContextGidBuilder builder()

Get builder for gtksource.search_context.SearchContext

Inherited Members

From ObjectWrap

_setGObject
void _setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectWrap 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.

_getGType
GType _getGType()

Get the GType of an object.

_gType
GType _gType [@property getter]

GObject GType property.

self
ObjectWrap 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
gulong 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.ObjectWrap 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.ObjectWrap 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.ObjectWrap.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.ObjectWrap.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.ObjectWrap.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.ObjectWrap 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.ObjectWrap.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.ObjectWrap.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.ObjectWrap.ref_ and gobject.object.ObjectWrap.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
gulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.