Foundry.TextDocumentAddin¶

Subclasses:: None

Methods¶

Inherited:: Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)
Structs:: GObject.ObjectClass (5)

	`dup_document` ()
	`list_code_actions` ()
	`load` ()
	`post_load` ()
	`post_save` ()
	`pre_load` ()
	`pre_save` ()
	`unload` ()

Virtual Methods¶

Inherited:: GObject.Object (7), Json.Serializable (5)

	`do_list_code_actions` ()
	`do_load` ()
	`do_post_load` ()
	`do_post_save` ()
	`do_pre_load` ()
	`do_pre_save` ()
	`do_unload` ()

Properties¶

Inherited:: Foundry.Contextual (1)

Name	Type	Flags	Short Description
`document`	`Foundry.TextDocument`	r/w/co

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Foundry.Contextual`	r

Class Details¶

class Foundry.TextDocumentAddin(**kwargs)¶

Bases:: Foundry.Contextual
Abstract:: Yes
Structure:: Foundry.TextDocumentAddinClass

Abstract base class for plugins to alter how documents work.

dup_document()¶

Return type:: Foundry.TextDocument

list_code_actions()¶

Returns:: a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.CodeAction] or rejects with error
Return type:: Dex.Future

load()¶

Return type:: Dex.Future

post_load()¶

Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Called after the document is loadd.

post_save()¶

Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Called after the document is saved.

pre_load()¶

Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Called before the document is loadd.

pre_save()¶

Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Called before the document is saved.

unload()¶

Return type:: Dex.Future

do_list_code_actions() virtual¶

Returns:: a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.CodeAction] or rejects with error
Return type:: Dex.Future

do_load() virtual¶

Return type:: Dex.Future

do_post_load() virtual¶

Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Called after the document is loadd.

do_post_save() virtual¶

Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Called after the document is saved.

do_pre_load() virtual¶

Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Called before the document is loadd.

do_pre_save() virtual¶

Returns:: a [class`Dex`.Future] that resolves to any value or rejects with error.
Return type:: Dex.Future

Called before the document is saved.

do_unload() virtual¶

Return type:: Dex.Future

Property Details¶

Foundry.TextDocumentAddin.props.document¶

Name:: document
Type:: Foundry.TextDocument
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY