Functions that deals with fonts. More...

Modules
	Font Path Functions
	Functions that edit the paths being used to load fonts.

Typedefs
typedef enum _Evas_Font_Hinting_Flags	Evas_Font_Hinting_Flags
	Flags for Font Hinting. More...

Enumerations
enum	_Evas_Font_Hinting_Flags { EVAS_FONT_HINTING_NONE, EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE }
	Flags for Font Hinting. More...

Functions
EOAPI void	evas_canvas_font_cache_set (int size)
	Changes the size of font cache of the given evas. More...

EOAPI int	evas_canvas_font_cache_get (void)
	Changes the size of font cache of the given evas. More...

EOAPI void	evas_canvas_font_hinting_set (Evas_Font_Hinting_Flags hinting)
	Changes the font hinting for the given evas. More...

EOAPI Evas_Font_Hinting_Flags	evas_canvas_font_hinting_get (void)
	Retrieves the font hinting used by the given evas. More...

EOAPI void	evas_canvas_font_cache_flush (void)
	Force the given evas and associated engine to flush its font cache.

EOAPI Eina_Bool	evas_canvas_font_hinting_can_hint (Evas_Font_Hinting_Flags hinting)
	Checks if the font hinting is supported by the given evas. More...

EOAPI Eina_List *	evas_canvas_font_available_list (void)
	List of available font descriptions known or found by this evas. More...

void	eo_cxx::evas::canvas::font_cache_flush () const
	Force the given evas and associated engine to flush its font cache.

bool	eo_cxx::evas::canvas::font_hinting_can_hint (Evas_Font_Hinting_Flags hinting_) const
	Checks if the font hinting is supported by the given evas. More...

::efl::eina::optional< ::efl::eina::range_list< std::string > >	eo_cxx::evas::canvas::font_available_list () const
	List of available font descriptions known or found by this evas. More...

int	eo_cxx::evas::canvas::font_cache_get () const
	Changes the size of font cache of the given evas. More...

void	eo_cxx::evas::canvas::font_cache_set (int size_) const
	Changes the size of font cache of the given evas. More...

Evas_Font_Hinting_Flags	eo_cxx::evas::canvas::font_hinting_get () const
	Retrieves the font hinting used by the given evas. More...

void	eo_cxx::evas::canvas::font_hinting_set (Evas_Font_Hinting_Flags hinting_) const
	Changes the font hinting for the given evas. More...

void	evas::canvas::font_cache_flush () const
	Force the given evas and associated engine to flush its font cache.

bool	evas::canvas::font_hinting_can_hint (Evas_Font_Hinting_Flags hinting_) const
	Checks if the font hinting is supported by the given evas. More...

::efl::eina::optional< ::efl::eina::range_list< std::string > >	evas::canvas::font_available_list () const
	List of available font descriptions known or found by this evas. More...

int	evas::canvas::font_cache_get () const
	Changes the size of font cache of the given evas. More...

void	evas::canvas::font_cache_set (int size_) const
	Changes the size of font cache of the given evas. More...

Evas_Font_Hinting_Flags	evas::canvas::font_hinting_get () const
	Retrieves the font hinting used by the given evas. More...

void	evas::canvas::font_hinting_set (Evas_Font_Hinting_Flags hinting_) const
	Changes the font hinting for the given evas. More...

void	evas_font_cache_set (Evas_Canvas *obj, int size)
	Changes the size of font cache of the given evas. More...

int	evas_font_cache_get (const Evas_Canvas *obj)
	Changes the size of font cache of the given evas. More...

void	evas_font_hinting_set (Evas_Canvas *obj, Evas_Font_Hinting_Flags hinting)
	Changes the font hinting for the given evas. More...

Evas_Font_Hinting_Flags	evas_font_hinting_get (const Evas_Canvas *obj)
	Retrieves the font hinting used by the given evas. More...

void	evas_font_cache_flush (Evas_Canvas *obj)
	Force the given evas and associated engine to flush its font cache.

Eina_Bool	evas_font_hinting_can_hint (const Evas_Canvas *obj, Evas_Font_Hinting_Flags hinting)
	Checks if the font hinting is supported by the given evas. More...

Eina_List *	evas_font_available_list (const Evas_Canvas *obj)
	List of available font descriptions known or found by this evas. More...

void	evas_font_available_list_free (Evas e, Eina_List available)
	Free list of font descriptions returned by evas_font_dir_available_list(). More...

void	evas_object_ref (Evas_Object *obj)
	Increments object reference count to defer its deletion. More...

void	evas_object_unref (Evas_Object *obj)
	Decrements object reference count. More...

int	evas_object_ref_get (const Evas_Object *obj)
	Get the object reference count. More...

void	evas_object_del (Evas_Object *obj)
	Marks the given Evas object for deletion (when Evas will free its memory). More...

void	evas_object_geometry_get (const Evas_Object obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord *h)
	Retrieves the position and (rectangular) size of the given Evas object. More...

void	evas_object_geometry_set (Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
	Set the position and (rectangular) size of the given Evas object. More...

void	evas_object_show (Evas_Object *obj)
	Makes the given Evas object visible. More...

void	evas_object_hide (Evas_Object *obj)
	Makes the given Evas object invisible. More...

Detailed Description

Functions that deals with fonts.

Typedef Documentation

typedef enum _Evas_Font_Hinting_Flags Evas_Font_Hinting_Flags

Flags for Font Hinting.

Flags for Font Hinting

Enumeration Type Documentation

enum _Evas_Font_Hinting_Flags

Flags for Font Hinting.

Enumerator
EVAS_FONT_HINTING_NONE	No font hinting.
EVAS_FONT_HINTING_AUTO	Automatic font hinting.
EVAS_FONT_HINTING_BYTECODE	Bytecode font hinting.

Function Documentation

EOAPI void evas_canvas_font_cache_set ( int size )

Changes the size of font cache of the given evas.

Parameters

[in] size The size, in bytes.

Referenced by evas_font_cache_set(), eo_cxx::evas::canvas::font_cache_set(), and evas::canvas::font_cache_set().

EOAPI int evas_canvas_font_cache_get ( void )

Changes the size of font cache of the given evas.

Returns: The size, in bytes.

Referenced by evas_font_cache_get(), eo_cxx::evas::canvas::font_cache_get(), and evas::canvas::font_cache_get().

EOAPI void evas_canvas_font_hinting_set ( Evas_Font_Hinting_Flags hinting )

Changes the font hinting for the given evas.

EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Parameters

[in] hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

Referenced by evas_font_hinting_set(), eo_cxx::evas::canvas::font_hinting_set(), and evas::canvas::font_hinting_set().

EOAPI Evas_Font_Hinting_Flags evas_canvas_font_hinting_get ( void )

Retrieves the font hinting used by the given evas.

Returns: The hinting in use, one of EVAS_FONT_HINTING_NONE, EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Referenced by evas_font_hinting_get(), eo_cxx::evas::canvas::font_hinting_get(), and evas::canvas::font_hinting_get().

EOAPI Eina_Bool evas_canvas_font_hinting_can_hint ( Evas_Font_Hinting_Flags hinting )

Checks if the font hinting is supported by the given evas.

EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Returns: EINA_TRUE if it is supported, EINA_FALSE otherwise.

Parameters

[in] hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

Referenced by evas_font_hinting_can_hint(), eo_cxx::evas::canvas::font_hinting_can_hint(), and evas::canvas::font_hinting_can_hint().

EOAPI Eina_List* evas_canvas_font_available_list ( void )

List of available font descriptions known or found by this evas.

The list depends on Evas compile time configuration, such as fontconfig support, and the paths provided at runtime as explained in Font Path Functions.

Returns: a newly allocated list of strings. Do not change the strings. Be sure to call evas_font_available_list_free() after you're done.

Referenced by evas_font_available_list(), eo_cxx::evas::canvas::font_available_list(), and evas::canvas::font_available_list().

bool eo_cxx::evas::canvas::font_hinting_can_hint ( Evas_Font_Hinting_Flags hinting_ ) const

inline

Checks if the font hinting is supported by the given evas.

EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Returns: EINA_TRUE if it is supported, EINA_FALSE otherwise.

Parameters

hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

References evas_canvas_font_hinting_can_hint().

efl::eina::optional<::efl::eina::range_list< std::string > > eo_cxx::evas::canvas::font_available_list ( ) const

inline

List of available font descriptions known or found by this evas.

The list depends on Evas compile time configuration, such as fontconfig support, and the paths provided at runtime as explained in Font Path Functions.

Returns: a newly allocated list of strings. Do not change the strings. Be sure to call evas_font_available_list_free() after you're done.

References evas_canvas_font_available_list().

int eo_cxx::evas::canvas::font_cache_get ( ) const

inline

Changes the size of font cache of the given evas.

Returns: The size, in bytes.

Parameters

size	The size, in bytes.

References evas_canvas_font_cache_get().

void eo_cxx::evas::canvas::font_cache_set ( int size_ ) const

inline

Changes the size of font cache of the given evas.

Parameters

size	The size, in bytes.

References evas_canvas_font_cache_set().

Evas_Font_Hinting_Flags eo_cxx::evas::canvas::font_hinting_get ( ) const

inline

Retrieves the font hinting used by the given evas.

Returns: The hinting in use, one of EVAS_FONT_HINTING_NONE, EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Parameters

hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

References evas_canvas_font_hinting_get().

void eo_cxx::evas::canvas::font_hinting_set ( Evas_Font_Hinting_Flags hinting_ ) const

inline

Changes the font hinting for the given evas.

EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Parameters

hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

References evas_canvas_font_hinting_set().

bool evas::canvas::font_hinting_can_hint ( Evas_Font_Hinting_Flags hinting_ ) const

inline

Checks if the font hinting is supported by the given evas.

EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Returns: EINA_TRUE if it is supported, EINA_FALSE otherwise.

Parameters

hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

References evas_canvas_font_hinting_can_hint().

efl::eina::optional<::efl::eina::range_list< std::string > > evas::canvas::font_available_list ( ) const

inline

List of available font descriptions known or found by this evas.

The list depends on Evas compile time configuration, such as fontconfig support, and the paths provided at runtime as explained in Font Path Functions.

Returns: a newly allocated list of strings. Do not change the strings. Be sure to call evas_font_available_list_free() after you're done.

References evas_canvas_font_available_list().

int evas::canvas::font_cache_get ( ) const

inline

Changes the size of font cache of the given evas.

Returns: The size, in bytes.

Parameters

size	The size, in bytes.

References evas_canvas_font_cache_get().

void evas::canvas::font_cache_set ( int size_ ) const

inline

Changes the size of font cache of the given evas.

Parameters

size	The size, in bytes.

References evas_canvas_font_cache_set().

Evas_Font_Hinting_Flags evas::canvas::font_hinting_get ( ) const

inline

Retrieves the font hinting used by the given evas.

Returns: The hinting in use, one of EVAS_FONT_HINTING_NONE, EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Parameters

hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

References evas_canvas_font_hinting_get().

void evas::canvas::font_hinting_set ( Evas_Font_Hinting_Flags hinting_ ) const

inline

Changes the font hinting for the given evas.

EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Parameters

hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

References evas_canvas_font_hinting_set().

void evas_font_cache_set	(	Evas_Canvas *	obj,
		int	size
	)

Changes the size of font cache of the given evas.

Parameters

[in] size The size, in bytes.

References evas_canvas_font_cache_set().

Referenced by ethumb_dup(), and ethumb_new().

int evas_font_cache_get ( const Evas_Canvas * obj )

Changes the size of font cache of the given evas.

Returns: The size, in bytes.

References evas_canvas_font_cache_get().

void evas_font_hinting_set	(	Evas_Canvas *	obj,
		Evas_Font_Hinting_Flags	hinting
	)

Changes the font hinting for the given evas.

EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Parameters

[in] hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

References evas_canvas_font_hinting_set().

Evas_Font_Hinting_Flags evas_font_hinting_get ( const Evas_Canvas * obj )

Retrieves the font hinting used by the given evas.

Returns: The hinting in use, one of EVAS_FONT_HINTING_NONE, EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

References evas_canvas_font_hinting_get().

Eina_Bool evas_font_hinting_can_hint	(	const Evas_Canvas *	obj,
		Evas_Font_Hinting_Flags	hinting
	)

Checks if the font hinting is supported by the given evas.

EVAS_FONT_HINTING_AUTO, EVAS_FONT_HINTING_BYTECODE.

Returns: EINA_TRUE if it is supported, EINA_FALSE otherwise.

Parameters

[in] hinting The hinting to use, one of EVAS_FONT_HINTING_NONE,

References evas_canvas_font_hinting_can_hint().

Eina_List* evas_font_available_list ( const Evas_Canvas * obj )

List of available font descriptions known or found by this evas.

The list depends on Evas compile time configuration, such as fontconfig support, and the paths provided at runtime as explained in Font Path Functions.

Returns: a newly allocated list of strings. Do not change the strings. Be sure to call evas_font_available_list_free() after you're done.

References evas_canvas_font_available_list().

void evas_font_available_list_free	(	Evas *	e,
		Eina_List *	available
	)

Free list of font descriptions returned by evas_font_dir_available_list().

Parameters

e	The evas instance that returned such list.
available	the list returned by evas_font_dir_available_list().

void evas_object_ref ( Evas_Object * obj )

Increments object reference count to defer its deletion.

Parameters

obj	The given Evas object to reference

This increments the reference count of an object, which if greater than 0 will defer deletion by evas_object_del() until all references are released back (counter back to 0). References cannot go below 0 and unreferencing past that will result in the reference count being limited to 0. References are limited to 2^32 - 1 for an object. Referencing it more than this will result in it being limited to this value.

See also: evas_object_unref(); evas_object_del()

Note: This is a very simple reference counting mechanism! For instance, Evas is not ready to check for pending references on a canvas deletion, or things like that. This is useful on scenarios where, inside a code block, callbacks exist which would possibly delete an object we are operating on afterwards. Then, one would evas_object_ref() it on the beginning of the block and evas_object_unref() it on the end. It would then be deleted at this point, if it should be.

Example:

 evas_object_ref(obj);
 
 // action here...
 evas_object_smart_callback_call(obj, SIG_SELECTED, NULL);
 // more action here...
 evas_object_unref(obj);

Since: 1.1

void evas_object_unref ( Evas_Object * obj )

Decrements object reference count.

Parameters

obj	The given Evas object to unreference

This decrements the reference count of an object. If the object has had evas_object_del() called on it while references were more than 0, it will be deleted at the time this function is called and puts the counter back to 0. See evas_object_ref() for more information.

See also: evas_object_ref() (for an example); evas_object_del()

Since: 1.1

References evas_object_del().

int evas_object_ref_get ( const Evas_Object * obj )

Get the object reference count.

Parameters

obj	The given Evas object to query

This gets the reference count for an object (normally 0 until it is referenced). Values of 1 or greater mean that someone is holding a reference to this object that needs to be unreffed before it can be deleted.

See also: evas_object_ref(); evas_object_unref(); evas_object_del()

Since: 1.2

void evas_object_del ( Evas_Object * obj )

Marks the given Evas object for deletion (when Evas will free its memory).

Parameters

obj	The given Evas object.

This call will mark obj for deletion, which will take place whenever it has no more references to it (see evas_object_ref() and evas_object_unref()).

At actual deletion time, which may or may not be just after this call, EVAS_CALLBACK_DEL and EVAS_CALLBACK_FREE callbacks will be called. If the object currently had the focus, its EVAS_CALLBACK_FOCUS_OUT callback will also be called.

See also: evas_object_ref(); evas_object_unref()

References EINA_TRUE.

Referenced by ecore_evas_ews_background_set(), edje_edit_part_source_set(), edje_perspective_free(), ethumb_free(), and evas_object_unref().

void evas_object_geometry_get	(	const Evas_Object *	obj,
		Evas_Coord *	x,
		Evas_Coord *	y,
		Evas_Coord *	w,
		Evas_Coord *	h
	)

Retrieves the position and (rectangular) size of the given Evas object.

Parameters

obj	The given Evas object.
x	Pointer to an integer in which to store the X coordinate of the object.
y	Pointer to an integer in which to store the Y coordinate of the object.
w	Pointer to an integer in which to store the width of the object.
h	Pointer to an integer in which to store the height of the object.

The position, naturally, will be relative to the top left corner of the canvas' viewport.

Note: Use NULL pointers on the geometry components you're not interested in: they'll be ignored by the function.

Example:

    int w, h, cw, ch;
 
    evas_object_geometry_get(d.img, NULL, NULL, &w, &h);
    ecore_evas_geometry_get(d.ee, NULL, NULL, &cw, &ch);
 
    if (w < cw)
      evas_object_resize(d.img, cw, ch);
    else
      evas_object_resize(d.img, cw / 2, ch / 2);
 
    return EINA_TRUE; /* re-issue the timer */

See the full example.

Referenced by emotion_object_border_set(), emotion_object_keep_aspect_set(), and evas_textblock_cursor_range_simple_geometry_get().

void evas_object_geometry_set	(	Evas_Object *	obj,
		Evas_Coord	x,
		Evas_Coord	y,
		Evas_Coord	w,
		Evas_Coord	h
	)

Set the position and (rectangular) size of the given Evas object.

Parameters

obj	The given Evas object.
x	X position to move the object to, in canvas units.
y	Y position to move the object to, in canvas units.
w	The new width of the Evas object.
h	The new height of the Evas object.

The position, naturally, will be relative to the top left corner of the canvas' viewport.

If the object get moved, the object's EVAS_CALLBACK_MOVE callback will be called.

If the object get resized, the object's EVAS_CALLBACK_RESIZE callback will be called.

See also: evas_object_move(); evas_object_resize(); evas_object_geometry_get

Since: 1.8

void evas_object_show ( Evas_Object * obj )

Makes the given Evas object visible.

Parameters

obj	The given Evas object.

Besides becoming visible, the object's EVAS_CALLBACK_SHOW callback will be called.

See also: evas_object_hide() for more on object visibility.; evas_object_visible_get()

References EINA_TRUE.

Referenced by ecore_evas_ews_background_set(), and emotion_object_bg_color_set().

void evas_object_hide ( Evas_Object * obj )

Makes the given Evas object invisible.

Parameters

obj	The given Evas object.

Hidden objects, besides not being shown at all in your canvas, won't be checked for changes on the canvas rendering process. Furthermore, they will not catch input events. Thus, they are much ligher (in processing needs) than an object that is invisible due to indirect causes, such as being clipped or out of the canvas' viewport.

Besides becoming hidden, obj object's EVAS_CALLBACK_SHOW callback will be called.

Note: All objects are created in the hidden state! If you want them shown, use evas_object_show() after their creation.

See also: evas_object_show(); evas_object_visible_get()

Example:

         if (evas_object_visible_get(d.clipper))
           {
              evas_object_hide(d.clipper);
              fprintf(stdout, "hidden\n");
           }
         else
           {
              evas_object_show(d.clipper);
              fprintf(stdout, "visible\n");
           }
         return;

See the full example.

References EINA_FALSE.

Referenced by ecore_evas_cursor_unset(), edje_edit_part_del(), and emotion_object_bg_color_set().

Modules

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation