Foundry.OnTypeFormatter

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	indent (document, iter)
	is_trigger (document, iter, state, keyval)

Virtual Methods

Inherited:

GObject.Object (7)

	do_indent (document, iter)
	do_is_trigger (document, iter, state, keyval)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	GObject.Object	r

Class Details

class Foundry.OnTypeFormatter(**kwargs)

Bases:

GObject.Object

Abstract:

Yes

Structure:

Foundry.OnTypeFormatterClass

Abstract base class for plugins to implement formatting as you type.

indent(document, iter)

Parameters:

• document (Foundry.TextDocument)

• iter (Foundry.TextIter)

Return type:

iter: Foundry.TextIter

Indents the text at iter.

iter should be set to the cursor location after the indent when exiting this function.

is_trigger(document, iter, state, keyval)

Parameters:

• document (Foundry.TextDocument)

• iter (Foundry.TextIter)

• state (Foundry.ModifierType)

• keyval (int)

Return type:

bool

do_indent(document, iter) virtual

Parameters:

• document (Foundry.TextDocument)

• iter (Foundry.TextIter)

Return type:

iter: Foundry.TextIter

Indents the text at iter.

iter should be set to the cursor location after the indent when exiting this function.

do_is_trigger(document, iter, state, keyval) virtual

Parameters:

• document (Foundry.TextDocument)

• iter (Foundry.TextIter)

• state (Foundry.ModifierType)

• keyval (int)

Return type:

bool