Interface
GtkSourceCompletionProvider
since: 5
Description [src]
interface GtkSource.CompletionProvider : GObject.Object
Completion provider interface.
You must implement this interface to provide proposals to GtkSourceCompletion
.
In most cases, implementations of this interface will want to use
GtkSource.CompletionProviderInterface.populate_async
to asynchronously populate the results
to avoid blocking the main loop.
Available since: 5
Prerequisite
In order to implement CompletionProvider, your type must inherit fromGObject
.
Instance methods
gtk_source_completion_provider_activate
This function requests proposal
to be activated by the
GtkSourceCompletionProvider
.
since: 5
gtk_source_completion_provider_display
This function requests that the GtkSourceCompletionProvider
prepares
cell
to display the contents of proposal
.
since: 5
gtk_source_completion_provider_get_priority
This function should return the priority of self
in context
.
since: 5
gtk_source_completion_provider_get_title
Gets the title of the completion provider, if any.
since: 5
gtk_source_completion_provider_is_trigger
This function is used to determine of a character inserted into the text editor should cause a new completion request to be triggered.
since: 5
gtk_source_completion_provider_key_activates
This function is used to determine if a key typed by the user should
activate proposal
(resulting in committing the text to the editor).
since: 5
gtk_source_completion_provider_list_alternates
Providers should return a list of alternates to proposal
or NULL
if
there are no alternates available.
since: 5
gtk_source_completion_provider_populate_async
Asynchronously requests that the provider populates the completion
results for context
.
since: 5
gtk_source_completion_provider_populate_finish
Completes an asynchronous operation to populate a completion provider.
since: 5
gtk_source_completion_provider_refilter
This function can be used to filter results previously provided to
the GtkSourceCompletionContext
by the GtkSourceCompletionProvider
.
since: 5
Interface structure
struct GtkSourceCompletionProviderInterface {
GTypeInterface parent_iface;
char* (* get_title) (
GtkSourceCompletionProvider* self
);
int (* get_priority) (
GtkSourceCompletionProvider* self,
GtkSourceCompletionContext* context
);
gboolean (* is_trigger) (
GtkSourceCompletionProvider* self,
const GtkTextIter* iter,
gunichar ch
);
gboolean (* key_activates) (
GtkSourceCompletionProvider* self,
GtkSourceCompletionContext* context,
GtkSourceCompletionProposal* proposal,
guint keyval,
GdkModifierType state
);
GListModel* (* populate) (
GtkSourceCompletionProvider* self,
GtkSourceCompletionContext* context,
GError** error
);
void (* populate_async) (
GtkSourceCompletionProvider* self,
GtkSourceCompletionContext* context,
GCancellable* cancellable,
GAsyncReadyCallback callback,
gpointer user_data
);
GListModel* (* populate_finish) (
GtkSourceCompletionProvider* self,
GAsyncResult* result,
GError** error
);
void (* refilter) (
GtkSourceCompletionProvider* self,
GtkSourceCompletionContext* context,
GListModel* model
);
void (* display) (
GtkSourceCompletionProvider* self,
GtkSourceCompletionContext* context,
GtkSourceCompletionProposal* proposal,
GtkSourceCompletionCell* cell
);
void (* activate) (
GtkSourceCompletionProvider* self,
GtkSourceCompletionContext* context,
GtkSourceCompletionProposal* proposal
);
GPtrArray* (* list_alternates) (
GtkSourceCompletionProvider* self,
GtkSourceCompletionContext* context,
GtkSourceCompletionProposal* proposal
);
}
Interface members
parent_iface |
|
No description available. | |
get_title |
|
No description available. | |
get_priority |
|
No description available. | |
is_trigger |
|
No description available. | |
key_activates |
|
No description available. | |
populate |
|
No description available. | |
populate_async |
|
No description available. | |
populate_finish |
|
No description available. | |
refilter |
|
No description available. | |
display |
|
No description available. | |
activate |
|
No description available. | |
list_alternates |
|
No description available. |
Virtual methods
GtkSource.CompletionProvider.activate
This function requests proposal
to be activated by the
GtkSourceCompletionProvider
.
since: 5
GtkSource.CompletionProvider.display
This function requests that the GtkSourceCompletionProvider
prepares
cell
to display the contents of proposal
.
since: 5
GtkSource.CompletionProvider.get_priority
This function should return the priority of self
in context
.
since: 5
GtkSource.CompletionProvider.is_trigger
This function is used to determine of a character inserted into the text editor should cause a new completion request to be triggered.
since: 5
GtkSource.CompletionProvider.key_activates
This function is used to determine if a key typed by the user should
activate proposal
(resulting in committing the text to the editor).
since: 5
GtkSource.CompletionProvider.list_alternates
Providers should return a list of alternates to proposal
or NULL
if
there are no alternates available.
since: 5
GtkSource.CompletionProvider.populate_async
Asynchronously requests that the provider populates the completion
results for context
.
since: 5
GtkSource.CompletionProvider.populate_finish
Completes an asynchronous operation to populate a completion provider.
since: 5
GtkSource.CompletionProvider.refilter
This function can be used to filter results previously provided to
the GtkSourceCompletionContext
by the GtkSourceCompletionProvider
.
since: 5