SearchContext

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_source_search_context_get_type ()" ) ]
public sealed class SearchContext : Object

Search context.

A `GtkSourceSearchContext` 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 [method@SearchContext.get_occurrences_count]. To know the position of a certain match, use [method@SearchContext.get_occurrence_position].

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 [method@SearchContext.forward] or [method@SearchContext.forward_async] for the asynchronous version. The backward search is done similarly. To replace a search match, or all matches, use [method@SearchContext.replace] and [method@SearchContext.replace_all].

The search occurrences are highlighted by default. To disable it, use [method@SearchContext.set_highlight]. You can enable the search highlighting for several `GtkSourceSearchContext`s attached to the same buffer. Moreover, each of those `GtkSourceSearchContext`s can have a different text style associated. Use [method@SearchContext.set_match_style] 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 `GtkSourceSearchContext` 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.

Namespace: GtkSource

Package: gtksourceview-5

Content:

Properties:

public Buffer buffer { get; construct; }
The [class@Buffer] associated to the search context.
public bool highlight { get; set construct; }
Highlight the search occurrences.
public Style match_style { get; set construct; }
A [class@Style], or null for theme's scheme default style.
public int occurrences_count { get; }
The total number of search occurrences.
public Error regex_error { owned get; }
If the regex search pattern doesn't follow all the rules, this Error property will be set.
public SearchSettings settings { get; construct; }
The [class@SearchSettings] associated to the search context.

Creation methods:

public SearchContext (Buffer buffer, SearchSettings? settings)
Creates a new search context, associated with buffer, and customized with settings.

Methods:

public bool backward (TextIter iter, out TextIter match_start, out TextIter match_end, out bool has_wrapped_around)
Synchronous backward search.
public async bool backward_async (TextIter iter, Cancellable? cancellable, out TextIter match_start, out TextIter match_end, out bool has_wrapped_around) throws Error
The asynchronous version of [method@SearchContext.
public bool forward (TextIter iter, out TextIter match_start, out TextIter match_end, out bool has_wrapped_around)
Synchronous forward search.
public async bool forward_async (TextIter iter, Cancellable? cancellable, out TextIter match_start, out TextIter match_end, out bool has_wrapped_around) throws Error
The asynchronous version of [method@SearchContext.
public unowned Buffer get_buffer ()
public bool get_highlight ()
public unowned Style get_match_style ()
public int get_occurrence_position (TextIter match_start, TextIter match_end)
Gets the position of a search occurrence.
public int get_occurrences_count ()
Gets the total number of search occurrences.
public Error? get_regex_error ()
Regular expression patterns must follow certain rules.
public unowned SearchSettings get_settings ()
public bool replace (TextIter match_start, TextIter match_end, string replace, int replace_length) throws Error
Replaces a search match by another text.
public uint replace_all (string replace, int replace_length) throws Error
Replaces all search matches by another text.
public void set_highlight (bool highlight)
Enables or disables the search occurrences highlighting.
public void set_match_style (Style? match_style)
Set the style to apply on search matches.

Inherited Members:

All known members inherited from class GLib.Object