GtkSourceCompletionWords

GtkSourceCompletionWords — A GtkSourceCompletionProvider for the completion of words

Synopsis

#include <gtksourceview/completion-providers/words/gtksourcecompletionwords.h>

struct              GtkSourceCompletionWords;
GtkSourceCompletionWords * gtk_source_completion_words_new
                                                        (const gchar *name,
                                                         GdkPixbuf *icon);
void                gtk_source_completion_words_register
                                                        (GtkSourceCompletionWords *words,
                                                         GtkTextBuffer *buffer);
void                gtk_source_completion_words_unregister
                                                        (GtkSourceCompletionWords *words,
                                                         GtkTextBuffer *buffer);

Object Hierarchy

  GObject
   +----GtkSourceCompletionWords

Implemented Interfaces

GtkSourceCompletionWords implements GtkSourceCompletionProvider.

Properties

  "icon"                     GdkPixbuf*            : Read / Write / Construct
  "interactive-delay"        gint                  : Read / Write / Construct
  "minimum-word-size"        guint                 : Read / Write / Construct
  "name"                     gchar*                : Read / Write / Construct
  "priority"                 gint                  : Read / Write / Construct
  "proposals-batch-size"     guint                 : Read / Write / Construct
  "scan-batch-size"          guint                 : Read / Write / Construct

Description

The GtkSourceCompletionWords is an example of an implementation of the GtkSourceCompletionProvider interface. The proposals are words appearing in the registered GtkTextBuffers.

Details

struct GtkSourceCompletionWords

struct GtkSourceCompletionWords;

gtk_source_completion_words_new ()

GtkSourceCompletionWords * gtk_source_completion_words_new
                                                        (const gchar *name,
                                                         GdkPixbuf *icon);

name :

The name for the provider. [allow-none]

icon :

A specific icon for the provider. [allow-none]

Returns :

a new GtkSourceCompletionWords provider

gtk_source_completion_words_register ()

void                gtk_source_completion_words_register
                                                        (GtkSourceCompletionWords *words,
                                                         GtkTextBuffer *buffer);

Registers buffer in the words provider.

words :

a GtkSourceCompletionWords

buffer :

a GtkTextBuffer

gtk_source_completion_words_unregister ()

void                gtk_source_completion_words_unregister
                                                        (GtkSourceCompletionWords *words,
                                                         GtkTextBuffer *buffer);

Unregisters buffer from the words provider.

words :

a GtkSourceCompletionWords

buffer :

a GtkTextBuffer

Property Details

The "icon" property

  "icon"                     GdkPixbuf*            : Read / Write / Construct

The provider icon.


The "interactive-delay" property

  "interactive-delay"        gint                  : Read / Write / Construct

The delay before initiating interactive completion.

Allowed values: >= -1

Default value: 50


The "minimum-word-size" property

  "minimum-word-size"        guint                 : Read / Write / Construct

The minimum word size to complete.

Allowed values: >= 2

Default value: 2


The "name" property

  "name"                     gchar*                : Read / Write / Construct

The provider name.

Default value: NULL


The "priority" property

  "priority"                 gint                  : Read / Write / Construct

Provider priority.

Default value: 0


The "proposals-batch-size" property

  "proposals-batch-size"     guint                 : Read / Write / Construct

Number of proposals added in one batch.

Allowed values: >= 1

Default value: 300


The "scan-batch-size" property

  "scan-batch-size"          guint                 : Read / Write / Construct

Number of lines scanned in one batch.

Allowed values: >= 1

Default value: 50