Struct sourceview5::CompletionContext

pub struct CompletionContext { /* private fields */ }

The context of a completion.

CompletionContext contains information about an attept to display completion proposals to the user based on typed text in the View.

When typing, Completion may use registered CompletionProvider to determine if there may be results which could be displayed. If so, a CompletionContext is created with information that is provided to the CompletionProvider to populate results which might be useful to the user.

CompletionProvider are expected to provide gio::ListModel with CompletionProposal which may be joined together in a list of results for the user. They are also responsible for how the contents are displayed using CompletionCell which allows for some level of customization.

Properties

busy

The “busy” property is true while the completion context is populating completion proposals.

Readable

completion

The “completion” is the #GtkSourceCompletion that was used to create the context.

Readable | Writeable | Construct Only

empty

The “empty” property is true when there are no results.

It will be notified when the first result is added or the last result is removed.

Readable

Signals

provider-model-changed

Emitted when a provider changes a model.

This signal is primarily useful for #GtkSourceCompletionProvider’s that want to track other providers in context. For example, it can be used to create a “top results” provider.

ListModel

items-changed

This signal is emitted whenever items were added to or removed from @list. At @position, @removed items were removed and @added items were added in their place.

Note: If removed != added, the positions of all later items in the model change.

Implements

[trait@glib::ObjectExt], gio::prelude::ListModelExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl CompletionContext

pub fn builder() -> CompletionContextBuilder

Creates a new builder-pattern struct instance to construct CompletionContext objects.

This method returns an instance of CompletionContextBuilder which can be used to create CompletionContext objects.

pub fn activation(&self) -> CompletionActivation

Gets the mode for which the context was activated.

pub fn bounds(&self) -> Option<(TextIter, TextIter)>

Gets the bounds for the completion, which is the beginning of the current word (taking break characters into account) to the current insertion cursor.

If @begin is non-None, it will be set to the start position of the current word being completed.

If @end is non-None, it will be set to the insertion cursor for the current word being completed.

Returns

true if the marks are still valid and @begin or @end was set.

begin

a #GtkTextIter

end

a #GtkTextIter

pub fn buffer(&self) -> Option<Buffer>

Gets the underlying buffer used by the context.

This is a convenience function to get the buffer via the #GtkSourceCompletion property.

Returns

a #GtkTextBuffer or None

pub fn is_busy(&self) -> bool

Gets the “busy” property. This is set to true while the completion context is actively fetching proposals from registered #GtkSourceCompletionProvider’s.

Returns

true if the context is busy

pub fn completion(&self) -> Option<Completion>

Gets the #GtkSourceCompletion that created the context.

Returns

an #GtkSourceCompletion or None

pub fn is_empty(&self) -> bool

Checks if any proposals have been provided to the context.

Out of convenience, this function will return true if @self is None.

Returns

true if there are no proposals in the context

pub fn language(&self) -> Option<Language>

Gets the language of the underlying buffer, if any.

Returns

a #GtkSourceLanguage or None

pub fn proposals_for_provider( &self, provider: &impl IsA<CompletionProvider>, ) -> Option<ListModel>

Gets the #GListModel associated with the provider.

You can connect to #GtkSourceCompletionContext::model-changed to receive notifications about when the model has been replaced by a new model.

provider

a #GtkSourceCompletionProvider

Returns

a #GListModel or None

pub fn view(&self) -> Option<View>

Gets the text view for the context.

Returns

a #GtkSourceView or None

pub fn word(&self) -> GString

Gets the word that is being completed up to the position of the insert mark.

Returns

a string containing the current word

pub fn list_providers(&self) -> ListModel

Gets the providers that are associated with the context.

Returns

a #GListModel of #GtkSourceCompletionProvider

pub fn set_proposals_for_provider( &self, provider: &impl IsA<CompletionProvider>, results: Option<&impl IsA<ListModel>>, )

This function allows providers to update their results for a context outside of a call to CompletionProviderExt::populate_async().

This can be used to immediately return results for a provider while it does additional asynchronous work. Doing so will allow the completions to update while the operation is in progress.

provider

an #GtkSourceCompletionProvider

results

a #GListModel or None

pub fn connect_provider_model_changed<F: Fn(&Self, &CompletionProvider, Option<&ListModel>) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when a provider changes a model.

This signal is primarily useful for #GtkSourceCompletionProvider’s that want to track other providers in context. For example, it can be used to create a “top results” provider.

provider

a #GtkSourceCompletionProvider

model

a #GListModel

pub fn connect_busy_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_empty_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for CompletionContext

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompletionContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for CompletionContext

type ParamSpec = ParamSpecObject

type SetValue = CompletionContext

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, CompletionContext>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for CompletionContext

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CompletionContext

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for CompletionContext

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for CompletionContext

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for CompletionContext

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for CompletionContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for CompletionContext

impl IsA<ListModel> for CompletionContext