GscDocumentwordsProvider

GscDocumentwordsProvider

Synopsis

#define             GSC_DOCUMENTWORDS_PROVIDER_NAME
                    GscDocumentwordsProviderPrivate;
                    GscDocumentwordsProvider;
enum                GscDocumentwordsProviderSortType;
GscDocumentwordsProvider* gsc_documentwords_provider_new
                                                        (GtkTextView *view);
void                gsc_documentwords_provider_set_sort_type
                                                        (GscDocumentwordsProvider *prov,
                                                         GscDocumentwordsProviderSortType sort_type);
GscDocumentwordsProviderSortType gsc_documentwords_provider_get_sort_type
                                                        (GscDocumentwordsProvider *prov);

Object Hierarchy

  GObject
   +----GscDocumentwordsProvider

Implemented Interfaces

GscDocumentwordsProvider implements GscProvider.

Description

Details

GSC_DOCUMENTWORDS_PROVIDER_NAME

#define GSC_DOCUMENTWORDS_PROVIDER_NAME "GscDocumentwordsProvider"


GscDocumentwordsProviderPrivate

typedef struct _GscDocumentwordsProviderPrivate GscDocumentwordsProviderPrivate;


GscDocumentwordsProvider

typedef struct _GscDocumentwordsProvider GscDocumentwordsProvider;


enum GscDocumentwordsProviderSortType

typedef enum{
	GSC_DOCUMENTWORDS_PROVIDER_SORT_NONE,
	GSC_DOCUMENTWORDS_PROVIDER_SORT_BY_LENGTH
} GscDocumentwordsProviderSortType;

GSC_DOCUMENTWORDS_PROVIDER_SORT_NONE

Does not sort the proposals

GSC_DOCUMENTWORDS_PROVIDER_SORT_BY_LENGTH

Sort the proposals by label lenght. Sets the small words first an large words last.

gsc_documentwords_provider_new ()

GscDocumentwordsProvider* gsc_documentwords_provider_new
                                                        (GtkTextView *view);

view :

GtkTextView where the provider must search for words Returns The new GscDocumentwordsProvider

Returns :


gsc_documentwords_provider_set_sort_type ()

void                gsc_documentwords_provider_set_sort_type
                                                        (GscDocumentwordsProvider *prov,
                                                         GscDocumentwordsProviderSortType sort_type);

This method sets the sort type for the completion proposals list.

prov :

The GscDocumentwordsProvider

sort_type :

The GscDocumentwordsProviderSortType for the completion proposal.

gsc_documentwords_provider_get_sort_type ()

GscDocumentwordsProviderSortType gsc_documentwords_provider_get_sort_type
                                                        (GscDocumentwordsProvider *prov);

prov :

The GscDocumentwordsProvider

Returns :

The current sort type.