cong-text-cache

cong-text-cache

Synopsis

CongTextCacheSpan * cong_text_cache_span_new            (int original_first_byte_offset,
                                                         int stripped_first_byte_offset,
                                                         int byte_count);
CongTextCache *     cong_text_cache_new                 (gboolean strip_whitespace,
                                                         const gchar *string,
                                                         PangoAttrList *attr_list);
void                cong_text_cache_free                (CongTextCache *text_cache);
const gchar *       cong_text_cache_get_output_text     (CongTextCache *text_cache);
PangoAttrList *     cong_text_cache_get_output_attributes
                                                        (CongTextCache *text_cache);
void                cong_text_cache_set_input_text      (CongTextCache *text_cache,
                                                         const gchar *input_string);
void                cong_text_cache_set_input_attributes
                                                        (CongTextCache *text_cache,
                                                         PangoAttrList *attr_list);
gboolean            cong_text_cache_convert_stripped_byte_offset_to_original
                                                        (CongTextCache *text_cache,
                                                         int stripped_byte_offset,
                                                         int *original_byte_offset);
gboolean            cong_text_cache_convert_original_byte_offset_to_stripped
                                                        (CongTextCache *text_cache,
                                                         int original_byte_offset,
                                                         int *stripped_byte_offset);

Description

Details

cong_text_cache_span_new ()

CongTextCacheSpan * cong_text_cache_span_new            (int original_first_byte_offset,
                                                         int stripped_first_byte_offset,
                                                         int byte_count);

original_first_byte_offset :

stripped_first_byte_offset :

byte_count :

Returns :


cong_text_cache_new ()

CongTextCache *     cong_text_cache_new                 (gboolean strip_whitespace,
                                                         const gchar *string,
                                                         PangoAttrList *attr_list);

Create a new CongTextCache.

strip_whitespace :

Should whitespace be stripped ("normalised") if TRUE, or preserved if FALSE

string :

the UTF8 string, must be non-NULL

attr_list :

Pango attributes for the string; can be NULL if you don't care about them

Returns :

the new CongTextCache

cong_text_cache_free ()

void                cong_text_cache_free                (CongTextCache *text_cache);

TODO: Write me

text_cache :


cong_text_cache_get_output_text ()

const gchar *       cong_text_cache_get_output_text     (CongTextCache *text_cache);

Get the text from the cache, which will have had the appropriate operation performed on it.

text_cache :

the text cache from which to get the result

Returns :

the result of the operation as a UTF-8 string (owned by the CongTextCache)

cong_text_cache_get_output_attributes ()

PangoAttrList *     cong_text_cache_get_output_attributes
                                                        (CongTextCache *text_cache);

Get the text attributes from the cache, which will have had the appropriate operation performed on it.

text_cache :

Returns :

the attributes, which you must unref when you are finished.

cong_text_cache_set_input_text ()

void                cong_text_cache_set_input_text      (CongTextCache *text_cache,
                                                         const gchar *input_string);

TODO: Write me

text_cache :

input_string :


cong_text_cache_set_input_attributes ()

void                cong_text_cache_set_input_attributes
                                                        (CongTextCache *text_cache,
                                                         PangoAttrList *attr_list);

TODO: Write me

text_cache :

attr_list :


cong_text_cache_convert_stripped_byte_offset_to_original ()

gboolean            cong_text_cache_convert_stripped_byte_offset_to_original
                                                        (CongTextCache *text_cache,
                                                         int stripped_byte_offset,
                                                         int *original_byte_offset);

TODO: Write me

text_cache :

stripped_byte_offset :

original_byte_offset :

Returns :


cong_text_cache_convert_original_byte_offset_to_stripped ()

gboolean            cong_text_cache_convert_original_byte_offset_to_stripped
                                                        (CongTextCache *text_cache,
                                                         int original_byte_offset,
                                                         int *stripped_byte_offset);

TODO: Write me

text_cache :

original_byte_offset :

stripped_byte_offset :

Returns :