languageSet

languageSet — LanguageSet stores language setting

Stability Level

Stable, unless otherwise indicated

Synopsis




#define             ZH_SIMPLIFIED_STR
#define             ZH_TRADITIONAL_STR
LanguageSet*        languageSet_new                     ();
SupportedLanguage   languageSet_index                   (LanguageSet *self,
                                                         int index);
gboolean            languageSet_has                     (LanguageSet *self,
                                                         SupportedLanguage lang);
guint               languageSet_size                    (LanguageSet *self);
gboolean            languageSet_add                     (LanguageSet *self,
                                                         SupportedLanguage lang);
gboolean            languageSet_add_langString          (LanguageSet *self,
                                                         const gchar *langStr);
LanguageSet*        languageSet_clone                   (LanguageSet *self);
void                languageSet_copy                    (LanguageSet *self,
                                                         LanguageSet *src);
void                languageSet_reset                   (LanguageSet *self);
void                languageSet_free                    (LanguageSet *self);
gchar*              languageSet_to_string               (LanguageSet *self);
SupportedLanguage   language_parse_string               (const gchar *str);
const gchar*        language_to_string                  (SupportedLanguage lang);

Description

A language set (LanguageSet) of a character tells in which language the character is shown.

Functions of language set can be found here, while the data structures is located at (LanguageSet).

Details

ZH_SIMPLIFIED_STR

#define ZH_SIMPLIFIED_STR "zh_simplified"

Default simplified Chinese language string.

ZH_TRADITIONAL_STR

#define ZH_TRADITIONAL_STR "zh_traditional"

Default traditional Chinese language string.

languageSet_new ()

LanguageSet*        languageSet_new                     ();

Allocate a new language set.

Returns :

 A new language set.

languageSet_index ()

SupportedLanguage   languageSet_index                   (LanguageSet *self,
                                                         int index);

Return the input code record at given index.

self :

 the languageSet

index :

 index of the language in self to be returned.

Returns :

 the input code record in self at index index.

languageSet_has ()

gboolean            languageSet_has                     (LanguageSet *self,
                                                         SupportedLanguage lang);

Return whether the language set has the specified language.

self :

 the languageSet

lang :

 the lang to be found

Returns :

 TRUE if self has lang; FALSE otherwise.

languageSet_size ()

guint               languageSet_size                    (LanguageSet *self);

Returns Number of languages in the language set.

self :

 the languageSet

Returns :

 Number of languages in self.

languageSet_add ()

gboolean            languageSet_add                     (LanguageSet *self,
                                                         SupportedLanguage lang);

Add new language to the language set.

See also: languageSet_add_langString().

self :

 the languageSet

lang :

 the language to be added.

Returns :

 TRUE if lang is successfully added; FALSE otherwise.

languageSet_add_langString ()

gboolean            languageSet_add_langString          (LanguageSet *self,
                                                         const gchar *langStr);

Add new language in string format to the language set.

See also: languageSet_add()

self :

 the languageSet

langStr :

 the language (in string format) to be added.

Returns :

 TRUE if the language is successfully added; FALSE otherwise.

languageSet_clone ()

LanguageSet*        languageSet_clone                   (LanguageSet *self);

Returns a deep-copied clone of the language set. Use languageSet_free() to free the returned clone.

self :

 the languageSet

Returns :

 A deep-copied clone of self

languageSet_copy ()

void                languageSet_copy                    (LanguageSet *self,
                                                         LanguageSet *src);

Deep copy from source language set.

self :

 the language set

src :

 the source lanugage set to be copied from.

languageSet_reset ()

void                languageSet_reset                   (LanguageSet *self);

Reset the languageSet. All elements in the language set are removed.

self :

 the languageSet.

languageSet_free ()

void                languageSet_free                    (LanguageSet *self);

Free the language set.

self :

 the language set.

languageSet_to_string ()

gchar*              languageSet_to_string               (LanguageSet *self);

Returns the string representation of language set.

self :

 the language set.

Returns :

 string representation of self.

language_parse_string ()

SupportedLanguage   language_parse_string               (const gchar *str);

Parse the string to as the SupportedLanguage. If the string does not represents any supported language, LANG_UNLABELED is returned.

Note that "zh_TW" and "zh_HK" will be parsed as LANG_ZH_TRADITIONAL, while "zh_CN" will be [ared as LANG_ZH_SIMPLIFIED.

See also: SupportedLanguageString.

str :

 the string to be parse

Returns :

 the supported language represented by str

language_to_string ()

const gchar*        language_to_string                  (SupportedLanguage lang);

Return string representation of the supported language.

Note that the returned string is constance, which should not be freed.

lang :

 the language

Returns :

 String representation of supported language

See Also

WritRecogn-Types, SupportedLanguage.