Creates a new search context, associated with buffer, and customized with settings.
Synchronous backward search.
The asynchronous version of gtksource.search_context.SearchContext.backward.
Finishes a backward search started with gtksource.search_context.SearchContext.backwardAsync.
Synchronous forward search.
The asynchronous version of gtksource.search_context.SearchContext.forward.
Finishes a forward search started with gtksource.search_context.SearchContext.forwardAsync.
Gets the position of a search occurrence.
Gets the total number of search occurrences.
Regular expression patterns must follow certain rules. If propertySearchSettings:search-text breaks a rule, the error can be retrieved with this function.
Replaces a search match by another text. If match_start and match_end doesn't correspond to a search match, false is returned.
Replaces all search matches by another text.
Enables or disables the search occurrences highlighting.
Set the style to apply on search matches.
Set the GObject of a D ObjectG wrapper.
Get a pointer to the underlying C object.
Calls g_object_ref() on a GObject.
Calls g_object_unref() on a GObject.
Get the GType of an object.
GObject GType property.
Convenience method to return this cast to a type. For use in D with statements.
Template to get the D object from a C GObject and cast it to the given D object type.
Connect a D closure to an object signal.
Template for setting a GObject property.
Template for getting a GObject property.
Creates a binding between source_property on source and target_property on target.
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.
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.
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.
Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
Gets a property of an object.
This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
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.
Checks whether object has a floating[floating-ref] reference.
Emits a "notify" signal for the property property_name on object.
Emits a "notify" signal for the property specified by pspec on object.
Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
Releases all references to other objects. This can be used to break reference cycles.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
Sets a property on an object.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
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:
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.
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.
Connect to Notify signal.
Search context.
A gtksource.search_context.SearchContext is used for the search and replace in a class@Buffer. The search settings are represented by a class@SearchSettings object. There can be a many-to-many relationship between buffers and search settings, with the search contexts in-between: a search settings object can be shared between several search contexts; and a buffer can contain several search contexts at the same time.
The total number of search occurrences can be retrieved with gtksource.search_context.SearchContext.getOccurrencesCount. To know the position of a certain match, use gtksource.search_context.SearchContext.getOccurrencePosition.
The buffer is scanned asynchronously, so it doesn't block the user interface. For each search, the buffer is scanned at most once. After that, navigating through the occurrences doesn't require to re-scan the buffer entirely.
To search forward, use gtksource.search_context.SearchContext.forward or gtksource.search_context.SearchContext.forwardAsync for the asynchronous version. The backward search is done similarly. To replace a search match, or all matches, use gtksource.search_context.SearchContext.replace and gtksource.search_context.SearchContext.replaceAll.
The search occurrences are highlighted by default. To disable it, use gtksource.search_context.SearchContext.setHighlight. You can enable the search highlighting for several gtksource.search_context.SearchContexts attached to the same buffer. Moreover, each of those gtksource.search_context.SearchContexts can have a different text style associated. Use gtksource.search_context.SearchContext.setMatchStyle to specify the class@Style to apply on search matches.
Note that the property@SearchContext:highlight and property@SearchContext:match-style properties are in the gtksource.search_context.SearchContext class, not class@SearchSettings. Appearance settings should be tied to one, and only one buffer, as different buffers can have different style scheme associated (a class@SearchSettings object can be bound indirectly to several buffers).
The concept of "current match" doesn't exist yet. A way to highlight differently the current match is to select it.
A search occurrence's position doesn't depend on the cursor position or other parameters. Take for instance the buffer "aaaa" with the search text "aa". The two occurrences are at positions [0:2] and [2:4]. If you begin to search at position 1, you will get the occurrence [2:4], not [1:3]. This is a prerequisite for regular expression searches. The pattern ".*" matches the entire line. If the cursor is at the middle of the line, you don't want the rest of the line as the occurrence, you want an entire line. (As a side note, regular expression searches can also match multiple lines.)
In the GtkSourceView source code, there is an example of how to use the search and replace API: see the tests/test-search.c file. It is a mini application for the search and replace, with a basic user interface.