Ide.EditorSearch
Description: Reference for Ide.EditorSearch

### Class

# IdeEditorSearch

#### Description

    final class Ide.EditorSearch : GObject.Object {
      /* No available fields */
    }

No description available.

#### Hierarchy

#### Ancestors

- GObject

#### Implements

- GActionGroup

#### Constructors

###### ide_editor_search_new

Creates a new `IdeEditorSearch` instance for the `GtkSourceView`. You should only create one of these per `IdeEditorView`.

Available since: 3.32

#### Instance methods

###### ide_editor_search_begin_interactive

This function is used to track when the user begin doing an interactive search, which is one where they are typing the search query.

Available since: 3.32

###### ide_editor_search_end_interactive

This function completes an interactive search previously performed with ide_editor_search_begin_interactive().

Available since: 3.32

###### ide_editor_search_get_active

Gets the “active” property.

Available since: 3.32

###### ide_editor_search_get_at_word_boundaries

Gets the `IdeEditorSearch:at-word-boundaries` property.

Available since: 3.32

###### ide_editor_search_get_case_sensitive

Gets if the search should be case sensitive.

Available since: 3.32

###### ide_editor_search_get_extend_selection

Gets the “extend-selection” property.

Available since: 3.32

###### ide_editor_search_get_match_count

Gets the number of matches currently found in the editor. This will update as new matches are found while scanning the buffer.

Available since: 3.32

###### ide_editor_search_get_match_position

Gets the match position of the cursor within the buffer. If the cursor is within a match, this will be a 1-based index will update as new matches are found while scanning the buffer.

Available since: 3.32

###### ide_editor_search_get_regex_enabled

Gets the `IdeEditorSearch:regex-enabled` property. This is true if the search text can contain regular expressions supported by `GRegex`.

Available since: 3.32

###### ide_editor_search_get_repeat

Gets the `IdeEditorSearch:repeat` property containing the number of times to perform a move. A value of 1 performs a single move. A value of 2 performs a second move after the first.

Available since: 3.32

###### ide_editor_search_get_replacement_text

Gets the `IdeEditorSearch:replacement-text` property. This is the text that will be used when calling `ide_editor_search_replace()` or ide_editor_search_replace_all().

Available since: 3.32

###### ide_editor_search_get_replacement_text_invalid

No description available.

###### ide_editor_search_get_reverse

Checks if search movements should be reversed for relative movements such as `IDE_EDITOR_SEARCH_NEXT` and `IDE_EDITOR_SEARCH_PREVIOUS`.

Available since: 3.32

###### ide_editor_search_get_search_text

Gets the search-text currently being searched.

Available since: 3.32

###### ide_editor_search_get_search_text_invalid

Checks to see if the search text contains invalid contents, such as an invalid regex.

Available since: 3.32

###### ide_editor_search_get_visible

Gets the `IdeEditorSearch:visible` property. This is true if the current search text should be highlighted in the editor.

Available since: 3.32

###### ide_editor_search_move

This moves the insertion cursor in the buffer to the next match based upon `direction`.

Available since: 3.32

###### ide_editor_search_replace

Replaces the next occurrance of a search result with the value of `IdeEditorSearch:replacement-text`.

Available since: 3.32

###### ide_editor_search_replace_all

Replaces all the occurrances of `IdeEditorSearch:search-text` with the value of `IdeEditorSearch:replacement-text`.

Available since: 3.32

###### ide_editor_search_set_at_word_boundaries

See also: `gtk_source_search_settings_set_word_boundaries()`

Available since: 3.32

###### ide_editor_search_set_case_sensitive

See also: `GtkSourceSearchSettings:case-sensitive`.

Available since: 3.32

###### ide_editor_search_set_extend_selection

No description available.

###### ide_editor_search_set_regex_enabled

See also: `GtkSourceSearchSettings:regex-enabled`.

Available since: 3.32

###### ide_editor_search_set_repeat

Sets the repeat count. A `repeat` value of 0 indicates that the value is unset. When unset, the default value of 1 is used.

Available since: 3.32

###### ide_editor_search_set_replacement_text

This sets the text to use when performing search and replace. See `ide_editor_search_replace()` or `ide_editor_search_replace_all()` to perform one or more replacements.

Available since: 3.32

###### ide_editor_search_set_reverse

Sets the “reverse” property.

Available since: 3.32

###### ide_editor_search_set_search_text

See also: `GtkSourceSearchSettings:search-text`.

Available since: 3.32

###### ide_editor_search_set_visible

Sets the visibility of the search results. You might want to disable the visibility of search results when the user has requested them to be dismissed.

Available since: 3.32

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GActionGroup (14)

###### g_action_group_action_added

Emits the `GActionGroup::action-added` signal on `action_group`.

Available since: 2.28

###### g_action_group_action_enabled_changed

Emits the `GActionGroup::action-enabled-changed` signal on `action_group`.

Available since: 2.28

###### g_action_group_action_removed

Emits the `GActionGroup::action-removed` signal on `action_group`.

Available since: 2.28

###### g_action_group_action_state_changed

Emits the `GActionGroup::action-state-changed` signal on `action_group`.

Available since: 2.28

###### g_action_group_activate_action

Activate the named action within `action_group`.

Available since: 2.28

###### g_action_group_change_action_state

Request for the state of the named action within `action_group` to be changed to `value`.

Available since: 2.28

###### g_action_group_get_action_enabled

Checks if the named action within `action_group` is currently enabled.

Available since: 2.28

###### g_action_group_get_action_parameter_type

Queries the type of the parameter that must be given when activating the named action within `action_group`.

Available since: 2.28

###### g_action_group_get_action_state

Queries the current state of the named action within `action_group`.

Available since: 2.28

###### g_action_group_get_action_state_hint

Requests a hint about the valid range of values for the state of the named action within `action_group`.

Available since: 2.28

###### g_action_group_get_action_state_type

Queries the type of the state of the named action within `action_group`.

Available since: 2.28

###### g_action_group_has_action

Checks if the named action exists within `action_group`.

Available since: 2.28

###### g_action_group_list_actions

Lists the actions contained within `action_group`.

Available since: 2.28

###### g_action_group_query_action

Queries all aspects of the named action within an `action_group`.

Available since: 2.32

#### Properties

###### Ide.EditorSearch:active

The “active” property is `TRUE` when there is an active search in progress.

Available since: 3.32

###### Ide.EditorSearch:at-word-boundaries

The “at-word-boundaries” property specifies if the search-text must only be matched starting from the beginning of a word.

Available since: 3.32

###### Ide.EditorSearch:case-sensitive

The “case-sensitive” property specifies if the search text should be case sensitive.

Available since: 3.32

###### Ide.EditorSearch:extend-selection

The “extend-selection” property specifies that the selection within the editor should be extended as the user navigates between search results.

Available since: 3.32

###### Ide.EditorSearch:match-count

The “match-count” property contains the number of matches that have been discovered. This is reset to zero when the `IdeEditorSearch` determines it can destroy it’s `GtkSourceSearchContext`.

Available since: 3.32

###### Ide.EditorSearch:match-position

The “match-position” property contains the position within the discovered search results for which the insertion cursor is placed.

Available since: 3.32

###### Ide.EditorSearch:regex-enabled

The “regex-enabled” property determines if `GRegex` should be used to scan for the `IdeEditorSearch:search-text`. Doing so allows the user to search using common regex values such as “foo.*bar”. It also allows for capture groups to be used in replacement text.

Available since: 3.32

###### Ide.EditorSearch:repeat

The number of times to repeat a move operation when calling ide_editor_search_move(). This allows for stateful moves which might be necessary when activating keybindings.

Available since: 3.32

###### Ide.EditorSearch:replacement-text

The “replacement-text” property determines the text to be used when performing search and replace with `ide_editor_search_replace()` or ide_editor_search_replace_all().

Available since: 3.32

###### Ide.EditorSearch:reverse

The “reverse” property determines if relative directions should be switched, so next is backward, and previous is forward.

Available since: 3.32

###### Ide.EditorSearch:search-text

The “search-text” property contains the text to search within the buffer.

Available since: 3.32

###### Ide.EditorSearch:view

The “view” property is the underlying `GtkSourceView` that is being searched. This must be set when creating the `IdeEditorSearch` and may not be changed after construction.

Available since: 3.32

###### Ide.EditorSearch:visible

The “visible” property is used to specify if the search results should be highlighted in the buffer. Generally, you’ll want this off while the interactive search is hidden as it allows the `IdeEditorSearch` to perform various optimizations.

Available since: 3.32

#### Signals

##### Signals inherited from GObject (1)

###### GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

##### Signals inherited from GActionGroup (4)

###### Gio.ActionGroup::action-added

Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.

Available since: 2.28

###### Gio.ActionGroup::action-enabled-changed

Signals that the enabled status of the named action has changed.

Available since: 2.28

###### Gio.ActionGroup::action-removed

Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

Available since: 2.28

###### Gio.ActionGroup::action-state-changed

Signals that the state of the named action has changed.

Available since: 2.28

#### Class structure

    struct IdeEditorSearchClass {
      GObjectClass parent_class;

    }

###### Class members

`parent_class` |
    GObjectClass
| No description available.