GtkSourceCompletionItem

GtkSourceCompletionItem — Simple implementation of GtkSourceCompletionProposal

Synopsis

#include <gtksourceview/gtksource.h>

                    GtkSourceCompletionItem;
GtkSourceCompletionItem * gtk_source_completion_item_new
                                                        (const gchar *label,
                                                         const gchar *text,
                                                         GdkPixbuf *icon,
                                                         const gchar *info);
GtkSourceCompletionItem * gtk_source_completion_item_new_with_markup
                                                        (const gchar *markup,
                                                         const gchar *text,
                                                         GdkPixbuf *icon,
                                                         const gchar *info);
GtkSourceCompletionItem * gtk_source_completion_item_new_from_stock
                                                        (const gchar *label,
                                                         const gchar *text,
                                                         const gchar *stock,
                                                         const gchar *info);

Object Hierarchy

  GObject
   +----GtkSourceCompletionItem

Implemented Interfaces

GtkSourceCompletionItem implements GtkSourceCompletionProposal.

Properties

  "icon"                     GdkPixbuf*            : Read / Write
  "info"                     gchar*                : Read / Write
  "label"                    gchar*                : Read / Write
  "markup"                   gchar*                : Read / Write
  "text"                     gchar*                : Read / Write

Description

The GtkSourceCompletionItem class is a simple implementation of the GtkSourceCompletionProposal interface.

Details

GtkSourceCompletionItem

typedef struct _GtkSourceCompletionItem GtkSourceCompletionItem;

gtk_source_completion_item_new ()

GtkSourceCompletionItem * gtk_source_completion_item_new
                                                        (const gchar *label,
                                                         const gchar *text,
                                                         GdkPixbuf *icon,
                                                         const gchar *info);

Create a new GtkSourceCompletionItem with label label, icon icon and extra information info. Both icon and info can be NULL in which case there will be no icon shown and no extra information available.

label :

 The item label.

text :

 The item text.

icon :

 The item icon. [allow-none]

info :

 The item extra information. [allow-none]

Returns :

 a new GtkSourceCompletionItem.

gtk_source_completion_item_new_with_markup ()

GtkSourceCompletionItem * gtk_source_completion_item_new_with_markup
                                                        (const gchar *markup,
                                                         const gchar *text,
                                                         GdkPixbuf *icon,
                                                         const gchar *info);

Create a new GtkSourceCompletionItem with markup label markup, icon icon and extra information info. Both icon and info can be NULL in which case there will be no icon shown and no extra information available.

markup :

 The item markup label.

text :

 The item text.

icon :

 The item icon. [allow-none]

info :

 The item extra information. [allow-none]

Returns :

 a new GtkSourceCompletionItem.

gtk_source_completion_item_new_from_stock ()

GtkSourceCompletionItem * gtk_source_completion_item_new_from_stock
                                                        (const gchar *label,
                                                         const gchar *text,
                                                         const gchar *stock,
                                                         const gchar *info);

Warning

gtk_source_completion_item_new_from_stock has been deprecated since version 3.10 and should not be used in newly-written code. Use gtk_source_completion_item_new() instead.

Creates a new GtkSourceCompletionItem from a stock item. If label is NULL, the stock label will be used.

label :

 The item label. [allow-none]

text :

 The item text.

stock :

 The stock icon.

info :

 The item extra information. [allow-none]

Returns :

 a new GtkSourceCompletionItem.

Property Details

The "icon" property

  "icon"                     GdkPixbuf*            : Read / Write

Icon to be shown for this proposal.

The "info" property

  "info"                     gchar*                : Read / Write

Optional extra information to be shown for this proposal.

Default value: NULL

The "label" property

  "label"                    gchar*                : Read / Write

Label to be shown for this proposal.

Default value: NULL

The "markup" property

  "markup"                   gchar*                : Read / Write

Label with markup to be shown for this proposal.

Default value: NULL

The "text" property

  "text"                     gchar*                : Read / Write

Proposal text.

Default value: NULL

Generated by GTK-Doc V1.19.1