CodeSlayerCompletion

CodeSlayerCompletion — The completion window.

Synopsis

#include <codeslayer/codeslayer-completion.h>

struct              CodeSlayerCompletion;
CodeSlayerCompletion * codeslayer_completion_new        (GtkWindow *window);
void                codeslayer_completion_add_provider  (CodeSlayerCompletion *completion,
                                                         CodeSlayerCompletionProvider *provider);
void                codeslayer_completion_show          (CodeSlayerCompletion *completion,
                                                         GtkTextView *text_view,
                                                         GtkTextIter iter);
void                codeslayer_completion_filter        (CodeSlayerCompletion *completion,
                                                         GtkTextView *text_view,
                                                         GtkTextIter iter);
void                codeslayer_completion_select        (CodeSlayerCompletion *completion,
                                                         GtkTextView *text_view,
                                                         GtkTextIter iter);
void                codeslayer_completion_hide          (CodeSlayerCompletion *completion);
gboolean            codeslayer_completion_get_visible   (CodeSlayerCompletion *completion);
gboolean            codeslayer_completion_toggle_up     (CodeSlayerCompletion *completion);
gboolean            codeslayer_completion_toggle_down   (CodeSlayerCompletion *completion);
gboolean            codeslayer_completion_mouse_within_popup
                                                        (CodeSlayerCompletion *completion);

Object Hierarchy

  GObject
   +----CodeSlayerCompletion

Signals

  "row-selected"                                   : No Hooks

Description

Details

struct CodeSlayerCompletion

struct CodeSlayerCompletion;

codeslayer_completion_new ()

CodeSlayerCompletion * codeslayer_completion_new        (GtkWindow *window);

Creates a new CodeSlayerCompletion.

window :

 a GtkWindow.

Returns :

 a new CodeSlayerCompletion.

codeslayer_completion_add_provider ()

void                codeslayer_completion_add_provider  (CodeSlayerCompletion *completion,
                                                         CodeSlayerCompletionProvider *provider);

Add a CodeSlayerCompletionProvider to the completion window.

completion :

 a CodeSlayerCompletion.

provider :

 a CodeSlayerCompletionProvider.

codeslayer_completion_show ()

void                codeslayer_completion_show          (CodeSlayerCompletion *completion,
                                                         GtkTextView *text_view,
                                                         GtkTextIter iter);

completion :

 a CodeSlayerCompletion.

text_view :

 a GtkTextView.

iter :

 a GtkTextIter.

codeslayer_completion_filter ()

void                codeslayer_completion_filter        (CodeSlayerCompletion *completion,
                                                         GtkTextView *text_view,
                                                         GtkTextIter iter);

completion :

 a CodeSlayerCompletion.

text_view :

 a GtkTextView.

iter :

 a GtkTextIter.

codeslayer_completion_select ()

void                codeslayer_completion_select        (CodeSlayerCompletion *completion,
                                                         GtkTextView *text_view,
                                                         GtkTextIter iter);

completion :

 a CodeSlayerCompletion.

text_view :

 a GtkTextView.

iter :

 a GtkTextIter.

codeslayer_completion_hide ()

void                codeslayer_completion_hide          (CodeSlayerCompletion *completion);

completion :

 a CodeSlayerCompletion.

Returns :

 is TRUE if the mouse is within the completion window.

codeslayer_completion_get_visible ()

gboolean            codeslayer_completion_get_visible   (CodeSlayerCompletion *completion);

codeslayer_completion_toggle_up ()

gboolean            codeslayer_completion_toggle_up     (CodeSlayerCompletion *completion);

codeslayer_completion_toggle_down ()

gboolean            codeslayer_completion_toggle_down   (CodeSlayerCompletion *completion);

codeslayer_completion_mouse_within_popup ()

gboolean            codeslayer_completion_mouse_within_popup
                                                        (CodeSlayerCompletion *completion);

Signal Details

The "row-selected" signal

void                user_function                      (CodeSlayerCompletion *completion,
                                                        gpointer              user_data)       : No Hooks

The ::row-selected signal enables the current selection to be set in the editor.

completion :

 the completion that received the signal

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.18