Foundry.DocumentationMatches¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gio.ListModel (4)
Structs:: GObject.ObjectClass (5)

	`add_section` (section)
	`await_` ()
	`dup_query` ()
	`list_sections` ()

Virtual Methods¶

Inherited:: GObject.Object (7), Gio.ListModel (3)

Properties¶

Name	Type	Flags	Short Description
`query`	`Foundry.DocumentationQuery`	r/w/co
`sections`	`Gio.ListModel`	r

Signals¶

Inherited:: GObject.Object (1), Gio.ListModel (1)

Fields¶

Inherited:: GObject.Object (1), Gio.ListModel (1)

Class Details¶

class Foundry.DocumentationMatches(**kwargs)¶

Bases:: GObject.Object, Gio.ListModel
Abstract:: No
Structure:: Foundry.DocumentationMatchesClass

Represents a set of matches from a documentation query.

add_section(section)¶

Parameters:: section (Gio.ListModel) –

await_()¶

Returns:: a [class`Dex`.Future] that resolves to any value when populating the list model has completed or rejects with error.
Return type:: Dex.Future

dup_query()¶

Return type:: Foundry.DocumentationQuery

list_sections()¶

Returns:: an [iface`Gio`.ListModel] of [class`Foundry`.Documentation]
Return type:: Gio.ListModel

Property Details¶

Foundry.DocumentationMatches.props.query¶

Name:: query
Type:: Foundry.DocumentationQuery
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.DocumentationMatches.props.sections¶

Name:: sections
Type:: Gio.ListModel
Default Value:: None
Flags:: READABLE