Class

FoundryFileSearchOptions

since: 1.1

Description [src]

final class Foundry.FileSearchOptions : GObject.Object
{
  /* No available fields */
}

Configuration options for file search operations.

This class provides configuration options for searching text within files. It supports various search modes including case sensitivity, whole word matching, regular expressions, and pattern-based file filtering. You can specify search targets, set maximum match limits, and configure context lines around matches.

Available since: 1.1

Ancestors

Constructors

foundry_file_search_options_new

Creates a new FoundryFileSearchOptions instance.

since: 1.1

Instance methods

foundry_file_search_options_add_target

Adds a file as a target for searching.

since: 1.1

foundry_file_search_options_copy

Creates a new FoundryFileSearchOptions with a copy of all the values from the original.

foundry_file_search_options_dup_excluded_patterns

Gets a copy of the excluded file patterns.

since: 1.1

foundry_file_search_options_dup_required_patterns

Gets a copy of the required file patterns.

since: 1.1

foundry_file_search_options_dup_search_text

Gets a copy of the search text.

since: 1.1

foundry_file_search_options_get_case_sensitive

Gets whether the search should be case sensitive.

since: 1.1

foundry_file_search_options_get_context_lines

Gets the number of context lines to include with each match. A value of 1 means 1 line before and 1 line after the match.

since: 1.1

foundry_file_search_options_get_match_whole_words

Gets whether the search should match whole words only.

since: 1.1

foundry_file_search_options_get_max_matches

Gets the maximum number of matches to return.

since: 1.1

foundry_file_search_options_get_recursive

Gets whether the search should be recursive.

since: 1.1

foundry_file_search_options_get_use_regex

Gets whether the search should use regular expressions.

since: 1.1

foundry_file_search_options_list_targets

Gets the list of files that are targets for searching.

since: 1.1

foundry_file_search_options_remove_target

Removes a file from the search targets.

since: 1.1

foundry_file_search_options_set_case_sensitive

Sets whether the search should be case sensitive.

since: 1.1

foundry_file_search_options_set_context_lines

Sets the number of context lines to include with each match. A value of 1 means 1 line before and 1 line after the match.

since: 1.1

foundry_file_search_options_set_excluded_patterns

Sets the excluded file patterns.

since: 1.1

foundry_file_search_options_set_match_whole_words

Sets whether the search should match whole words only.

since: 1.1

foundry_file_search_options_set_max_matches

Sets the maximum number of matches to return.

since: 1.1

foundry_file_search_options_set_recursive

Sets whether the search should be recursive.

since: 1.1

foundry_file_search_options_set_required_patterns

Sets the required file patterns.

since: 1.1

foundry_file_search_options_set_search_text

Sets the search text.

since: 1.1

foundry_file_search_options_set_use_regex

Sets whether the search should use regular expressions.

since: 1.1

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Foundry.FileSearchOptions:case-sensitive
No description available.

Foundry.FileSearchOptions:context-lines
No description available.

Foundry.FileSearchOptions:max-matches
No description available.

Foundry.FileSearchOptions:recursive
No description available.

Foundry.FileSearchOptions:search-text
No description available.

Foundry.FileSearchOptions:targets
No description available.

Foundry.FileSearchOptions:use-regex
No description available.

Signals

Signals inherited from GObject (1)
GObject::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.

Class structure

struct FoundryFileSearchOptionsClass {
  GObjectClass parent_class;
  
}

No description available.

Class members
parent_class: GObjectClass

No description available.