GtkSource.CompletionWords

g GObject.GInterface GObject.GInterface GtkSource.CompletionProvider GtkSource.CompletionProvider GObject.GInterface->GtkSource.CompletionProvider GObject.Object GObject.Object GtkSource.CompletionWords GtkSource.CompletionWords GObject.Object->GtkSource.CompletionWords GtkSource.CompletionProvider->GtkSource.CompletionWords

Subclasses:

None

Methods

Inherited:

GObject.Object (37), GtkSource.CompletionProvider (10)

Structs:

GObject.ObjectClass (5)

class

new (title)

register (buffer)

unregister (buffer)

Virtual Methods

Inherited:

GObject.Object (7), GtkSource.CompletionProvider (10)

Properties

Name

Type

Flags

Short Description

minimum-word-size

int

r/w/c

The minimum word size to complete

priority

int

r/w/c

Provider priority

proposals-batch-size

int

r/w/c

Number of proposals added in one batch

scan-batch-size

int

r/w/c

Number of lines scanned in one batch

title

str

r/w/c

The provider title

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent_instance

GObject.Object

r

Class Details

class GtkSource.CompletionWords(**kwargs)
Bases:

GObject.Object, GtkSource.CompletionProvider

Abstract:

No

Structure:

GtkSource.CompletionWordsClass

A [iface`CompletionProvider`] for the completion of words.

The GtkSourceCompletionWords is an example of an implementation of the [iface`CompletionProvider`] interface. The proposals are words appearing in the registered [class`Gtk`.TextBuffer]s.

classmethod new(title)
Parameters:

title (str or None) – The title for the provider, or None.

Returns:

a new GtkSource.CompletionWords provider

Return type:

GtkSource.CompletionWords

register(buffer)
Parameters:

buffer (Gtk.TextBuffer) – a Gtk.TextBuffer

Registers buffer in the self provider.

unregister(buffer)
Parameters:

buffer (Gtk.TextBuffer) – a Gtk.TextBuffer

Unregisters buffer from the self provider.

Property Details

GtkSource.CompletionWords.props.minimum_word_size
Name:

minimum-word-size

Type:

int

Default Value:

2

Flags:

READABLE, WRITABLE, CONSTRUCT

The minimum word size to complete

GtkSource.CompletionWords.props.priority
Name:

priority

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT

Provider priority

GtkSource.CompletionWords.props.proposals_batch_size
Name:

proposals-batch-size

Type:

int

Default Value:

300

Flags:

READABLE, WRITABLE, CONSTRUCT

Number of proposals added in one batch

GtkSource.CompletionWords.props.scan_batch_size
Name:

scan-batch-size

Type:

int

Default Value:

50

Flags:

READABLE, WRITABLE, CONSTRUCT

Number of lines scanned in one batch

GtkSource.CompletionWords.props.title
Name:

title

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT

The provider title