Foundry.FileSearchMatch¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`dup_after_context` ()
	`dup_before_context` ()
	`dup_file` ()
	`dup_icon` ()
	`dup_text` ()
	`get_length` ()
	`get_line` ()
	`get_line_offset` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_dup_after_context` ()
	`do_dup_before_context` ()
	`do_dup_file` ()
	`do_dup_text` ()
	`do_get_length` ()
	`do_get_line` ()
	`do_get_line_offset` ()

Properties¶

Name	Type	Flags
`after-context`	`str`	r
`before-context`	`str`	r
`file`	`Gio.File`	r
`icon`	`Gio.Icon`	r
`length`	`int`	r
`line`	`int`	r
`line-offset`	`int`	r
`text`	`str`	r
`uri`	`str`	r

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Foundry.FileSearchMatch(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Foundry.FileSearchMatchClass

A file search match result.

[class`Foundry`.FileSearchMatch] represents a search match result containing information about where a search term was found in a file, including the file location, line number, character offset, and text length.

New in version 1.1.

dup_after_context()¶

Returns:: the text after the match, or None
Return type:: str or None

Gets the text after the search text.

New in version 1.1.

dup_before_context()¶

Returns:: the text before the match, or None
Return type:: str or None

Gets the text before the search text.

New in version 1.1.

dup_file()¶

Returns:: a Gio.File
Return type:: Gio.File

Gets a copy of the file associated with the search match.

New in version 1.1.

dup_icon()¶

Returns:: a Gio.Icon or None
Return type:: Gio.Icon or None

Gets the icon for the file associated with the search match.

New in version 1.1.

dup_text()¶

Returns:: the matched text, or None
Return type:: str or None

Gets the matched text.

New in version 1.1.

get_length()¶

Returns:: the length of the text in characters
Return type:: int

Gets the length of the search text in characters.

New in version 1.1.

get_line()¶

Returns:: the line number (0-based)
Return type:: int

Gets the line number where the search match was found.

New in version 1.1.

get_line_offset()¶

Returns:: the character offset within the line (0-based)
Return type:: int

Gets the character offset within the line where the search match starts.

New in version 1.1.

do_dup_after_context() virtual¶

Returns:: the text after the match, or None
Return type:: str or None

Gets the text after the search text.

New in version 1.1.

do_dup_before_context() virtual¶

Returns:: the text before the match, or None
Return type:: str or None

Gets the text before the search text.

New in version 1.1.

do_dup_file() virtual¶

Returns:: a Gio.File
Return type:: Gio.File

Gets a copy of the file associated with the search match.

New in version 1.1.

do_dup_text() virtual¶

Returns:: the matched text, or None
Return type:: str or None

Gets the matched text.

New in version 1.1.

do_get_length() virtual¶

Returns:: the length of the text in characters
Return type:: int

Gets the length of the search text in characters.

New in version 1.1.

do_get_line() virtual¶

Returns:: the line number (0-based)
Return type:: int

Gets the line number where the search match was found.

New in version 1.1.

do_get_line_offset() virtual¶

Returns:: the character offset within the line (0-based)
Return type:: int

Gets the character offset within the line where the search match starts.

New in version 1.1.

Property Details¶

Foundry.FileSearchMatch.props.after_context¶

Name:: after-context
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.FileSearchMatch.props.before_context¶

Name:: before-context
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.FileSearchMatch.props.file¶

Name:: file
Type:: Gio.File
Default Value:: None
Flags:: READABLE

Foundry.FileSearchMatch.props.icon¶

Name:: icon
Type:: Gio.Icon
Default Value:: None
Flags:: READABLE

Foundry.FileSearchMatch.props.length¶

Name:: length
Type:: int
Default Value:: 0
Flags:: READABLE

Foundry.FileSearchMatch.props.line¶

Name:: line
Type:: int
Default Value:: 0
Flags:: READABLE

Foundry.FileSearchMatch.props.line_offset¶

Name:: line-offset
Type:: int
Default Value:: 0
Flags:: READABLE

Foundry.FileSearchMatch.props.text¶

Name:: text
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.FileSearchMatch.props.uri¶

Name:: uri
Type:: str
Default Value:: None
Flags:: READABLE