| libeasyfc Documentation | ||||
|---|---|---|---|---|
| Top | Description | ||||
gboolean ezfc_font_add_family (ezfc_font_t *font,const gchar *font_name,GError **error); gboolean ezfc_font_add_feature (ezfc_font_t *font,const gchar *feature); GList * ezfc_font_canonicalize (ezfc_font_t *font,GError **error); void ezfc_font_check_existence (ezfc_font_t *font,gboolean flag); gboolean ezfc_font_find (ezfc_font_t *font,const gchar *font_name); GList * ezfc_font_get_alias_name_from_pattern (const FcPattern *pattern); gboolean ezfc_font_get_antialiasing (ezfc_font_t *font); gboolean ezfc_font_get_autohinting (ezfc_font_t *font); GList * ezfc_font_get_available_features (ezfc_font_t *font); gboolean ezfc_font_get_embedded_bitmap (ezfc_font_t *font); GList * ezfc_font_get_families (ezfc_font_t *font); const gchar * ezfc_font_get_family (ezfc_font_t *font); GList * ezfc_font_get_features (ezfc_font_t *font); gboolean ezfc_font_get_hinting (ezfc_font_t *font); ezfc_font_hintstyle_t ezfc_font_get_hintstyle (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); gint ezfc_font_get_rgba (ezfc_font_t *font); ezfc_font_subpixel_render_t ezfc_font_get_subpixel_rendering (ezfc_font_t *font); enum ezfc_font_hintstyle_t; 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_remove (ezfc_font_t *font,GError **error); gboolean ezfc_font_remove_family (ezfc_font_t *font,const gchar *font_name,GError **error); gboolean ezfc_font_remove_feature (ezfc_font_t *font,const gchar *feature); void ezfc_font_set_antialiasing (ezfc_font_t *font,gboolean flag); void ezfc_font_set_autohinting (ezfc_font_t *font,gboolean flag); void ezfc_font_set_embedded_bitmap (ezfc_font_t *font,gboolean flag); gboolean ezfc_font_set_family (ezfc_font_t *font,const gchar *font_name,GError **error); void ezfc_font_set_hinting (ezfc_font_t *font,gboolean flag); void ezfc_font_set_hintstyle (ezfc_font_t *font,ezfc_font_hintstyle_t hintstyle); gboolean ezfc_font_set_pattern (ezfc_font_t *font,const FcPattern *pattern,GError **error); void ezfc_font_set_rgba (ezfc_font_t *font,gint val); gboolean ezfc_font_set_subpixel_rendering (ezfc_font_t *font,ezfc_font_subpixel_render_t mode); enum ezfc_font_subpixel_render_t; ezfc_font_t; void ezfc_font_unref (ezfc_font_t *font);
gboolean ezfc_font_add_family (ezfc_font_t *font,const gchar *font_name,GError **error);
Add font_name as the font family name used for the font font.
|
a ezfc_font_t. |
|
a font name. |
|
a GError. [allow-none] |
Returns : |
TRUE if it successfully is set. otherwise FALSE. |
Since 0.11
gboolean ezfc_font_add_feature (ezfc_font_t *font,const gchar *feature);
Add feature font feature to font.
|
a ezfc_font_t. |
|
feature name to be added |
Returns : |
TRUE if it's successfully completed, otherwise FALSE. |
Since 0.12
GList * ezfc_font_canonicalize (ezfc_font_t *font,GError **error);
Split up font to ezfc_font_t that has one family name only.
|
a ezfc_font_t. |
|
a GError. [allow-none] |
Returns : |
a GList contains
ezfc_font_t, otherwise NULL. [transfer full][element-type ezfc_font_t]
|
Since 0.11
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().
|
a ezfc_font_t. |
|
a boolean value. |
gboolean ezfc_font_find (ezfc_font_t *font,const gchar *font_name);
Check if font contains font_name.
|
a ezfc_font_t. |
|
a font name. |
Returns : |
TRUE if it contains, otherwise FALSE. |
Since 0.11
GList * ezfc_font_get_alias_name_from_pattern
(const FcPattern *pattern);
Analize pattern and returns a alias name string according to the result.
|
a FcPattern. |
Returns : |
a GList containing a static string for the alias name. [transfer container][element-type utf8] |
gboolean ezfc_font_get_antialiasing (ezfc_font_t *font);
Obtain a boolean value about the anti-aliasing usage in font.
|
a ezfc_font_t. |
Returns : |
TRUE if the antialiasing is enabled. otherwise FALSE. |
gboolean ezfc_font_get_autohinting (ezfc_font_t *font);
Obtain a boolean value about the auto-hinting usage in font.
|
a ezfc_font_t. |
Returns : |
TRUE if the auto-hinting is enabled. otherwise FALSE. |
GList * ezfc_font_get_available_features (ezfc_font_t *font);
Obtains available font features in font.
|
a ezfc_font_t. |
Returns : |
a GList containing
memory-allocated string of feature name that is available
in font. strings in GList has to be freed when it isn't
needed anymore. [transfer full][element-type utf8]
|
Since 0.12
gboolean ezfc_font_get_embedded_bitmap (ezfc_font_t *font);
Obtain a boolean value about the embedded bitmap usage in font.
|
a ezfc_font_t. |
Returns : |
TRUE if the embedded bitmap is enabled, otherwise FALSE. |
GList * ezfc_font_get_families (ezfc_font_t *font);
Obtains font family names in font.
|
a ezfc_font_t. |
Returns : |
a GList containing the static string of font family names. [transfer container][element-type utf8] |
Since 0.11
const gchar * ezfc_font_get_family (ezfc_font_t *font);
Obtains the font family name in first place in font.
|
a ezfc_font_t. |
Returns : |
the font name. |
GList * ezfc_font_get_features (ezfc_font_t *font);
Obtains font features list that font has.
|
a ezfc_font_t. |
Returns : |
a GList containing the static string of feature name. [transfer container][element-type utf8] |
Since 0.12
gboolean ezfc_font_get_hinting (ezfc_font_t *font);
Obtain a boolean value about the hinting usage in font.
|
a ezfc_font_t. |
Returns : |
TRUE if the hinting is enabled. otherwise FALSE. |
ezfc_font_hintstyle_t ezfc_font_get_hintstyle (ezfc_font_t *font);
Obtain the hintstyle in font.
|
a ezfc_font_t. |
Returns : |
a ezfc_font_hintstyle_t. |
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.
|
the language name fontconfig can deal with. [allow-none] |
|
the alias name to obtain the fonts list for. [allow-none] |
|
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]
|
FcPattern * ezfc_font_get_pattern (ezfc_font_t *font);
Obtains FcPattern in ezfc_font_t.
|
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. |
GList * ezfc_font_get_pattern_list (const gchar *language,const gchar *alias_name);
Obtains FcPattern list being assigned to alias_name for language.
gint ezfc_font_get_rgba (ezfc_font_t *font);
Obtains current sub-pixel ordering in font.
|
a ezfc_font_t. |
Returns : |
the sub-pixel ordering value in the integer. |
ezfc_font_subpixel_render_t ezfc_font_get_subpixel_rendering
(ezfc_font_t *font);
Obtain current status about the sub-pixel rendering in font.
|
a ezfc_font_t. |
Returns : |
current mode in the sub-pixel rendering. |
typedef enum {
EZFC_FONT_HINTSTYLE_UNKNOWN = 0,
EZFC_FONT_HINTSTYLE_NONE,
EZFC_FONT_HINTSTYLE_SLIGHT,
EZFC_FONT_HINTSTYLE_MEDIUM,
EZFC_FONT_HINTSTYLE_FULL,
EZFC_FONT_HINTSTYLE_END
} ezfc_font_hintstyle_t;
The hintstyle option to be used for ezfc_font_set_hintstyle().
| unknown state in the hintstyle. | |
| No use of autohinting | |
| Use slight autohinting | |
| Use medium autohinting | |
| Use full autohinting | |
| No real value, but just a terminator. |
gboolean ezfc_font_is_alias_font (const gchar *alias_name);
Checks if alias_name is one of sans-serif, serif, monospace, cursive or fantasy.
ezfc_font_t * ezfc_font_new (void);
Create an instance of ezfc_font_t.
Returns : |
a ezfc_font_t. |
ezfc_font_t * ezfc_font_ref (ezfc_font_t *font);
Increases the reference count of font.
|
a ezfc_font_t. |
Returns : |
the same font object. [transfer none]
|
gboolean ezfc_font_remove (ezfc_font_t *font,GError **error);
Removes all of families in font.
|
a ezfc_font_t. |
|
a GError. [allow-none] |
Returns : |
TRUE if it's successfully completed, otherwise FALSE. |
Since 0.11
gboolean ezfc_font_remove_family (ezfc_font_t *font,const gchar *font_name,GError **error);
Removes font_name from font.
|
a ezfc_font_t. |
|
a font name to be removed. |
|
a GError. [allow-none] |
Returns : |
TRUE if it's successfully completed, otherwise FALSE. |
Since 0.11
gboolean ezfc_font_remove_feature (ezfc_font_t *font,const gchar *feature);
Remove feature from font if available.
|
a ezfc_font_t. |
|
feature name to be removed |
Returns : |
TRUE if it's successfully completed, otherwise FALSE. |
Since 0.12
void ezfc_font_set_antialiasing (ezfc_font_t *font,gboolean flag);
Set a flag whether the font use the antialiasing.
|
a ezfc_font_t. |
|
a boolean value. |
void ezfc_font_set_autohinting (ezfc_font_t *font,gboolean flag);
Set a flag whether the font use the auto-hinting for rendering
|
a ezfc_font_t. |
|
a boolean value. |
void ezfc_font_set_embedded_bitmap (ezfc_font_t *font,gboolean flag);
Set a flag whether the font use the embedded bitmap. Note that Enabling the embedded bitmap may causes disabling the antialias.
|
a ezfc_font_t. |
|
a boolean value. |
gboolean ezfc_font_set_family (ezfc_font_t *font,const gchar *font_name,GError **error);
ezfc_font_set_family is deprecated and should not be used in newly-written code. 0.11. Use ezfc_font_add_family().
Set font_name as the font family name used for the font font.
|
a ezfc_font_t. |
|
a font name. |
|
a GError. [allow-none] |
Returns : |
TRUE if it successfully is set. otherwise FALSE. |
void ezfc_font_set_hinting (ezfc_font_t *font,gboolean flag);
Set a flag whether the font use the own hints for rendering
|
a ezfc_font_t. |
|
a boolean value. |
void ezfc_font_set_hintstyle (ezfc_font_t *font,ezfc_font_hintstyle_t hintstyle);
Set a hintstyle for font.
|
a ezfc_font_t. |
|
a ezfc_font_hintstyle_t. |
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.
|
a ezfc_font_t. |
|
a FcPattern. |
|
a GError. [allow-none] |
Returns : |
TRUE if it successfully is set. otherwise FALSE. |
void ezfc_font_set_rgba (ezfc_font_t *font,gint val);
Set val as the sub-pixel ordering
|
a ezfc_font_t. |
|
an integer value corresponding to FC_RGBA_*. |
gboolean ezfc_font_set_subpixel_rendering (ezfc_font_t *font,ezfc_font_subpixel_render_t mode);
This is just convenient to change the several configuration for subpixel rendering.
|
a ezfc_font_t. |
|
a ezfc_font_subpixel_render_t. |
Returns : |
TRUE if the sub-pixel rendering is enabled. otherwise FALSE. |
typedef enum {
EZFC_FONT_ANTIALIAS_UNKNOWN = 0,
EZFC_FONT_ANTIALIAS_NONE,
EZFC_FONT_ANTIALIAS_GRAY,
EZFC_FONT_ANTIALIAS_RGB,
EZFC_FONT_ANTIALIAS_BGR,
EZFC_FONT_ANTIALIAS_VRGB,
EZFC_FONT_ANTIALIAS_VBGR,
EZFC_FONT_ANTIALIAS_END
} ezfc_font_subpixel_render_t;
The sub-pixel rendering option to be used in ezfc_font_set_subpixel_rendering().
| unknown state on using the sub-pixel rendering. | |
| no use of the sub-pixel rendering | |
| Use the gray-scaled sub-pixel rendering | |
| Use the sub-pixel rendering with the sub-pixel geometry RGB. | |
| Use the sub-pixel rendering with the sub-pixel geometry BGR. | |
| Use the sub-pixel rendering with the sub-pixel geometry VRGB. | |
| Use the sub-pixel rendering with the sub-pixel geometry VBGR. | |
| No real value, but just a terminator. |
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.
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).
|
a ezfc_font_t. |