Struct sourceview5::Completion

pub struct Completion { /* private fields */ }

Main Completion Object.

The completion system helps the user when they writes some text, such as words, command names, functions, and suchlike. Proposals can be shown, to complete the text the user is writing. Each proposal can contain an additional piece of information (for example documentation), that is displayed when the “Details” button is clicked.

Proposals are created via a CompletionProvider. There can be for example a provider to complete words (see CompletionWords), another provider for the completion of function names, etc. To add a provider, call add_provider().

The CompletionProposal interface represents a proposal.

If a proposal contains extra information (see CompletionColumn::Details), it will be displayed in a supplemental details window, which appears when the “Details” button is clicked.

Each View object is associated with a Completion instance. This instance can be obtained with ViewExt::completion(). The View class contains also the show-completion signal.

A same CompletionProvider object can be used for several Completion’s.

Properties

buffer

The #GtkTextBuffer for the #GtkSourceCompletion:view. This is a convenience property for providers.

Readable

page-size

The number of rows to display to the user before scrolling.

Readable | Writeable

remember-info-visibility

Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.

Readable | Writeable

select-on-show

Determines whether the first proposal should be selected when the completion is first shown.

Readable | Writeable

show-icons

The “show-icons” property denotes if icons should be displayed within the list of completions presented to the user.

Readable | Writeable

view

The “view” property is the #GtkTextView for which this #GtkSourceCompletion is providing completion features.

Readable | Writeable | Construct Only

Signals

hide

The “hide” signal is emitted when the completion window should be hidden.

Action

provider-added

The “provided-added” signal is emitted when a new provider is added to the completion.

provider-removed

The “provided-removed” signal is emitted when a provider has been removed from the completion.

show

The “show” signal is emitted when the completion window should be shown.

Action

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Completion

pub fn builder() -> CompletionBuilder

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

This method returns an instance of CompletionBuilder which can be used to create Completion objects.

pub fn add_provider(&self, provider: &impl IsA<CompletionProvider>)

Adds a CompletionProvider to the list of providers to be queried for completion results.

provider

a #GtkSourceCompletionProvider

pub fn block_interactive(&self)

pub fn buffer(&self) -> Buffer

Gets the connected View’s Buffer

Returns

A #GtkSourceBuffer

pub fn page_size(&self) -> u32

pub fn view(&self) -> View

Gets the View that owns the Completion.

Returns

A #GtkSourceView

pub fn hide(&self)

Emits the “hide” signal.

When the “hide” signal is emitted, the completion window will be dismissed.

pub fn remove_provider(&self, provider: &impl IsA<CompletionProvider>)

Removes a CompletionProvider previously added with add_provider().

provider

a #GtkSourceCompletionProvider

pub fn set_page_size(&self, page_size: u32)

pub fn show(&self)

Emits the “show” signal.

When the “show” signal is emitted, the completion window will be displayed if there are any results available.

pub fn unblock_interactive(&self)

pub fn is_remember_info_visibility(&self) -> bool

Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.

pub fn set_remember_info_visibility(&self, remember_info_visibility: bool)

Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.

pub fn selects_on_show(&self) -> bool

Determines whether the first proposal should be selected when the completion is first shown.

pub fn set_select_on_show(&self, select_on_show: bool)

Determines whether the first proposal should be selected when the completion is first shown.

pub fn shows_icons(&self) -> bool

The “show-icons” property denotes if icons should be displayed within the list of completions presented to the user.

pub fn set_show_icons(&self, show_icons: bool)

The “show-icons” property denotes if icons should be displayed within the list of completions presented to the user.

pub fn fuzzy_highlight(haystack: &str, casefold_query: &str) -> Option<AttrList>

This will add <b> tags around matched characters in @haystack based on @casefold_query.

haystack

the string to be highlighted

casefold_query

the typed-text used to highlight @haystack

Returns

a #PangoAttrList or None

pub fn fuzzy_match(haystack: Option<&str>, casefold_needle: &str) -> Option<u32>

This helper function can do a fuzzy match for you giving a haystack and casefolded needle.

Casefold your needle using utf8_casefold() before running the query.

Score will be set with the score of the match upon success. Otherwise, it will be set to zero.

haystack

the string to be searched.

casefold_needle

A g_utf8_casefold() version of the needle.

Returns

true if @haystack matched @casefold_needle, otherwise false.

priority

An optional location for the score of the match

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

The “hide” signal is emitted when the completion window should be hidden.

pub fn emit_hide(&self)

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

The “provided-added” signal is emitted when a new provider is added to the completion.

provider

a #GtkSourceCompletionProvider

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

The “provided-removed” signal is emitted when a provider has been removed from the completion.

provider

a #GtkSourceCompletionProvider

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

The “show” signal is emitted when the completion window should be shown.

pub fn emit_show(&self)

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

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

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

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

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

Trait Implementations

impl Clone for Completion

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 Completion

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

Formats the value using the given formatter.

impl HasParamSpec for Completion

type ParamSpec = ParamSpecObject

type SetValue = Completion

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Completion

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 Completion

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 Completion

type Parent = Object

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

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 Completion

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 Completion

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Completion