Package: gtk

Function gtk-text-iter-forward-search

Lambda List

gtk-text-iter-forward-search (iter str flags limit)

Arguments

iter -- a gtk-text-iter instance with the start of search
str -- a search string
flags -- the gtk-text-search-flags flags affecting how the search is done
limit -- a gtk-text-iter instance which is the bound for the search, or nil for the end of the text buffer

Return Value

search-p -- a boolean whether a match was found
match-start -- a gtk-text-iter instance with the start of match, or nil
match-end -- a gtk-text-iter instance with the end of match, or nil

Details

Searches forward for str. Any match is returned by setting match-start to the first character of the match and match-end to the first character after the match. The search will not continue past limit. Note that a search is a linear or O(n) operation, so you may wish to use limit to avoid locking up your UI on large text buffers.

If the :visible-only flag is present, the match may have invisible text interspersed in str, i.e. str will be a possibly-noncontiguous subsequence of the matched range. Similarly, if you specify :text-only, the match may have pixbufs or child widgets mixed inside the matched range. If these flags are not given, the match must be exact; the special 0xFFFC character in str will match embedded pixbufs or child widgets. If you specify the :case-insensitive flag, the text will be matched regardless of what case it is in.
 

See also

2021-6-15