GtkSourceCompletionInfo

GtkSourceCompletionInfo — Calltips object

Synopsis

#include <gtksourceview/gtksourcecompletioninfo.h>

                    GtkSourceCompletionInfo;
GtkSourceCompletionInfo * gtk_source_completion_info_new
                                                        (void);
void                gtk_source_completion_info_move_to_iter
                                                        (GtkSourceCompletionInfo *info,
                                                         GtkTextView *view,
                                                         GtkTextIter *iter);
void                gtk_source_completion_info_set_widget
                                                        (GtkSourceCompletionInfo *info,
                                                         GtkWidget *widget);
GtkWidget *         gtk_source_completion_info_get_widget
                                                        (GtkSourceCompletionInfo *info);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GtkWindow
                                 +----GtkSourceCompletionInfo

Implemented Interfaces

GtkSourceCompletionInfo implements AtkImplementorIface and GtkBuildable.

Signals

  "before-show"                                    : Action

Description

This object can be used to show a calltip or help for the current completion proposal.

Details

GtkSourceCompletionInfo

typedef struct _GtkSourceCompletionInfo GtkSourceCompletionInfo;

gtk_source_completion_info_new ()

GtkSourceCompletionInfo * gtk_source_completion_info_new
                                                        (void);

Returns :

a new GtkSourceCompletionInfo.

gtk_source_completion_info_move_to_iter ()

void                gtk_source_completion_info_move_to_iter
                                                        (GtkSourceCompletionInfo *info,
                                                         GtkTextView *view,
                                                         GtkTextIter *iter);

Moves the GtkSourceCompletionInfo to iter. If iter is NULL info is moved to the cursor position. Moving will respect the GdkGravity setting of the info window and will ensure the line at iter is not occluded by the window.

info :

a GtkSourceCompletionInfo.

view :

a GtkTextView on which the info window should be positioned.

iter :

a GtkTextIter. [allow-none]

gtk_source_completion_info_set_widget ()

void                gtk_source_completion_info_set_widget
                                                        (GtkSourceCompletionInfo *info,
                                                         GtkWidget *widget);

Sets the content widget of the info window. If widget does not fit within the size requirements of the window, a GtkScrolledWindow will automatically be created and added to the window. See that the previous widget will lose a reference and it can be destroyed, so if you do not want this to happen you must g_object_ref() before calling this method.

info :

a GtkSourceCompletionInfo.

widget :

a GtkWidget. [allow-none]

gtk_source_completion_info_get_widget ()

GtkWidget *         gtk_source_completion_info_get_widget
                                                        (GtkSourceCompletionInfo *info);

Get the current content widget.

info :

a GtkSourceCompletionInfo.

Returns :

The current content widget. [transfer none]

Signal Details

The "before-show" signal

void                user_function                      (GtkSourceCompletionInfo *info,
                                                        gpointer                 user_data)      : Action

This signal is emitted before any "show" management. You can connect to this signal if you want to change some properties or position before the real "show".

info :

The GtkSourceCompletionInfo who emits the signal

user_data :

user data set when the signal handler was connected.