Fonts

Fonts — A collection of the functions for fonts

Synopsis

void                ezfc_font_check_existence           (ezfc_font_t *font,
                                                         gboolean flag);
GList *             ezfc_font_get_alias_name_from_pattern
                                                        (const FcPattern *pattern);
const gchar *       ezfc_font_get_family                (ezfc_font_t *font);
GList *             ezfc_font_get_list                  (const gchar *language,
                                                         const gchar *alias_name,
                                                         gboolean localized_font_name);
FcPattern *         ezfc_font_get_pattern               (ezfc_font_t *font);
GList *             ezfc_font_get_pattern_list          (const gchar *language,
                                                         const gchar *alias_name);
gboolean            ezfc_font_is_alias_font             (const gchar *alias_name);
ezfc_font_t *       ezfc_font_new                       (void);
ezfc_font_t *       ezfc_font_ref                       (ezfc_font_t *font);
gboolean            ezfc_font_set_family                (ezfc_font_t *font,
                                                         const gchar *font_name,
                                                         GError **error);
gboolean            ezfc_font_set_pattern               (ezfc_font_t *font,
                                                         const FcPattern *pattern,
                                                         GError **error);
                    ezfc_font_t;
void                ezfc_font_unref                     (ezfc_font_t *font);

Description

This collects some functions related to fonts.

Details

ezfc_font_check_existence ()

void                ezfc_font_check_existence           (ezfc_font_t *font,
                                                         gboolean flag);

Set a flag whether checking the font existence when invoking ezfc_font_set_family().

font :

a ezfc_font_t.

flag :

a boolean value.

ezfc_font_get_alias_name_from_pattern ()

GList *             ezfc_font_get_alias_name_from_pattern
                                                        (const FcPattern *pattern);

Analize pattern and returns a alias name string according to the result.

pattern :

a FcPattern.

Returns :

a GList containing a static string for the alias name. [transfer container][element-type utf8]

ezfc_font_get_family ()

const gchar *       ezfc_font_get_family                (ezfc_font_t *font);

Obtains the font family name in font.

font :

a ezfc_font_t.

Returns :

the font name.

ezfc_font_get_list ()

GList *             ezfc_font_get_list                  (const gchar *language,
                                                         const gchar *alias_name,
                                                         gboolean localized_font_name);

Obtains the fonts list being assigned to alias_name for language.

Note that localized_font_name doesn't take effect yet. this is just a reservation for future improvement.

language :

the language name fontconfig can deal with. [allow-none]

alias_name :

the alias name to obtain the fonts list for. [allow-none]

localized_font_name :

TRUE to include the localized font name if available, FALSE for English font name only.

Returns :

a GList contains the font family name. if no valid families, NULL then. [element-type utf8][transfer full]

ezfc_font_get_pattern ()

FcPattern *         ezfc_font_get_pattern               (ezfc_font_t *font);

Obtains FcPattern in ezfc_font_t.

font :

a ezfc_font_t.

Returns :

a duplicate of FcPattern in the instance. it has to be freed. NULL if font doesn't have any font pattern.

ezfc_font_get_pattern_list ()

GList *             ezfc_font_get_pattern_list          (const gchar *language,
                                                         const gchar *alias_name);

Obtains FcPattern list being assigned to alias_name for language.

language :

the language name fontconfig can deal with. [allow-none]

alias_name :

the alias name to obtain the fonts pettern list for. [allow-none]

Returns :

a GList contains FcPattern, otherwise NULL. [element-type FcPattern][transfer full]

ezfc_font_is_alias_font ()

gboolean            ezfc_font_is_alias_font             (const gchar *alias_name);

Checks if alias_name is one of sans-serif, serif, monospace, cursive or fantasy.

alias_name :

the alias font name

Returns :

TRUE if alias_name is an alias font name, otherwise FALSE.

ezfc_font_new ()

ezfc_font_t *       ezfc_font_new                       (void);

Create an instance of ezfc_font_t.

Returns :

a ezfc_font_t.

ezfc_font_ref ()

ezfc_font_t *       ezfc_font_ref                       (ezfc_font_t *font);

Increases the reference count of font.

font :

a ezfc_font_t.

Returns :

the same font object. [transfer none]

ezfc_font_set_family ()

gboolean            ezfc_font_set_family                (ezfc_font_t *font,
                                                         const gchar *font_name,
                                                         GError **error);

Set font_name as the font family name used for the font font.

font :

a ezfc_font_t.

font_name :

a font name.

error :

a GError. [allow-none]

Returns :

TRUE if it successfully is set. otherwise FALSE.

ezfc_font_set_pattern ()

gboolean            ezfc_font_set_pattern               (ezfc_font_t *font,
                                                         const FcPattern *pattern,
                                                         GError **error);

Set pattern as the font pattern. font keeps a duplicate instance of pattern.

font :

a ezfc_font_t.

pattern :

a FcPattern.

error :

a GError. [allow-none]

Returns :

TRUE if it successfully is set. otherwise FALSE.

ezfc_font_t

typedef struct _ezfc_font_t ezfc_font_t;

All the fields in the ezfc_font_t structure are private to the ezfc_font_t implementation.


ezfc_font_unref ()

void                ezfc_font_unref                     (ezfc_font_t *font);

Decreases the reference count of font. when its reference count drops to 0, the object is finalized (i.e. its memory is freed).

font :

a ezfc_font_t.