gtksource.search_context
Module for SearchContext class
Types 3
Search context.
A gtksource.search_context.SearchContext is used for the search and replace in a gtksource.buffer.Buffer. The search settings are represented by a gtksource.search_settings.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 gtksource.style.Style to apply on search matches.
Note that the gtksource.search_context.SearchContext.highlight and gtksource.search_context.SearchContext.matchStyle properties are in the gtksource.search_context.SearchContext class, not gtksource.search_settings.SearchSettings. Appearance settings should be tied to one, and only one buffer, as different buffers can have different style scheme associated (a gtksource.search_settings.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.
SearchContext self()Returns `this`, for use in `with` statements.SearchContextGidBuilder builder()Get builder for [gtksource.search_context.SearchContext] Returns: New builder objectgtksource.buffer.Buffer buffer() @propertyGet `buffer` property. Returns: The [gtksource.buffer.Buffer] associated to the search context.void highlight(bool propval) @propertySet `highlight` property. Params: propval = Highlight the search occurrences.gtksource.style.Style matchStyle() @propertyGet `matchStyle` property. Returns: A [gtksource.style.Style], or null for theme's scheme default style.void matchStyle(gtksource.style.Style propval) @propertySet `matchStyle` property. Params: propval = A [gtksource.style.Style], or null for theme's scheme default style.int occurrencesCount() @propertyGet `occurrencesCount` property. Returns: The total number of search occurrences. If the search is disabled, the value is 0. If the buffer is not already fully scanned, the value is -1.glib.error.ErrorWrap regexError() @propertyGet `regexError` property. Returns: If the regex search pattern doesn't follow all the rules, this #GError property will be set. If the pattern is valid, the value is null.gtksource.search_settings.SearchSettings settings() @propertyGet `settings` property. Returns: The [gtksource.search_settings.SearchSettings] associated to the search context.bool backward(gtk.text_iter.TextIter iter, out gtk.text_iter.TextIter matchStart, out gtk.text_iter.TextIter matchEnd, out bool hasWrappedAround)Synchronous backward search.void backwardAsync(gtk.text_iter.TextIter iter, gio.cancellable.Cancellable cancellable = null, gio.types.AsyncReadyCallback callback = null)The asynchronous version of [gtksource.search_context.SearchContext.backward].bool backwardFinish(gio.async_result.AsyncResult result, out gtk.text_iter.TextIter matchStart, out gtk.text_iter.TextIter matchEnd, out bool hasWrappedAround)Finishes a backward search started with [gtksource.search_context.SearchContext.backwardAsync].bool forward(gtk.text_iter.TextIter iter, out gtk.text_iter.TextIter matchStart, out gtk.text_iter.TextIter matchEnd, out bool hasWrappedAround)Synchronous forward search.void forwardAsync(gtk.text_iter.TextIter iter, gio.cancellable.Cancellable cancellable = null, gio.types.AsyncReadyCallback callback = null)The asynchronous version of [gtksource.search_context.SearchContext.forward].bool forwardFinish(gio.async_result.AsyncResult result, out gtk.text_iter.TextIter matchStart, out gtk.text_iter.TextIter matchEnd, out bool hasWrappedAround)Finishes a forward search started with [gtksource.search_context.SearchContext.forwardAsync].bool getHighlight()int getOccurrencePosition(gtk.text_iter.TextIter matchStart, gtk.text_iter.TextIter matchEnd)Gets the position of a search occurrence.int getOccurrencesCount()Gets the total number of search occurrences.glib.error.ErrorWrap getRegexError()Regular expression patterns must follow certain rules. If [gtksource.search_settings.SearchSettings.searchText] breaks a rule, the error can be retrieved with this function.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.uint replaceAll(string replace)Replaces all search matches by another text.void setHighlight(bool highlight)Enables or disables the search occurrences highlighting.void setMatchStyle(gtksource.style.Style matchStyle = null)Set the style to apply on search matches.this(gtksource.buffer.Buffer buffer, gtksource.search_settings.SearchSettings settings = null)Creates a new search context, associated with buffer, and customized with settings.Fluent builder implementation template for gtksource.search_context.SearchContext
T buffer(gtksource.buffer.Buffer propval)Set `buffer` property. Params: propval = The [gtksource.buffer.Buffer] associated to the search context. Returns: Builder instance for fluent chainingT highlight(bool propval)Set `highlight` property. Params: propval = Highlight the search occurrences. Returns: Builder instance for fluent chainingT matchStyle(gtksource.style.Style propval)Set `matchStyle` property. Params: propval = A [gtksource.style.Style], or null for theme's scheme default style. Returns: Builder instance for fluent chainingT settings(gtksource.search_settings.SearchSettings propval)Set `settings` property. Params: propval = The [gtksource.search_settings.SearchSettings] associated to the search context.Fluent builder for gtksource.search_context.SearchContext
SearchContext build()Create object from builder. Returns: New object