icon theme Functions

Functions that deal with freedesktop.org icon themes. More...

Functions

EAPI char * ecore_desktop_icon_find (const char *icon, const char *icon_size, const char *icon_theme)
 Find the path to an icon.
EAPI int ecore_desktop_icon_init ()
 Setup what ever needs to be setup to support ecore_desktop_icon.
EAPI int ecore_desktop_icon_shutdown ()
 Tear down what ever needs to be torn down to support ecore_desktop_ycon.
Ecore_Desktop_Icon_Theme * ecore_desktop_icon_theme_get (const char *icon_theme, const char *lang __UNUSED__)
 Get the contents of an index.theme file.
void ecore_desktop_icon_theme_destroy (Ecore_Desktop_Icon_Theme *icon_theme)
 Free whatever resources are used by an Ecore_Desktop_Icon_Theme.

Detailed Description

Functions that deal with freedesktop.org icon themes.

This conforms with the freedesktop.org XDG Icon Theme Specification version 0.11


Function Documentation

EAPI char* ecore_desktop_icon_find ( const char *  icon,
const char *  icon_size,
const char *  icon_theme 
)

Find the path to an icon.

Using the search algorithm specified by freedesktop.org, search for an icon in the currently installed set of icon themes.

The returned string needs to be freed eventually.

Parameters:
icon The name of the required icon.
icon_size The size of the required icon.
icon_theme The theme of the required icon.
Returns:
The full path to an icon file, or NULL.

EAPI int ecore_desktop_icon_init ( void   ) 

Setup what ever needs to be setup to support ecore_desktop_icon.

There are internal structures that are needed for ecore_desktop_icon functions to operate, this sets them up.

EAPI int ecore_desktop_icon_shutdown ( void   ) 

Tear down what ever needs to be torn down to support ecore_desktop_ycon.

There are internal structures that are needed for ecore_desktop_icon functions to operate, this tears them down.

void ecore_desktop_icon_theme_destroy ( Ecore_Desktop_Icon_Theme *  icon_theme  ) 

Free whatever resources are used by an Ecore_Desktop_Icon_Theme.

There are internal resources used by each Ecore_Desktop_Icon_Theme This releases those resources.

Parameters:
icon_theme An Ecore_Desktop_Icon_Theme.

Ecore_Desktop_Icon_Theme* ecore_desktop_icon_theme_get ( const char *  icon_theme,
const char *lang  __UNUSED__ 
)

Get the contents of an index.theme file.

Everything that is in the index.theme file is returned in the data member of the Ecore_Desktop_Icon_Theme structure, it's an Ecore_Hash as returned by ecore_desktop_ini_get(). Some of the data in the index.theme file is decoded into specific members of the returned structure.

Use ecore_desktop_icon_theme_destroy() to free this structure.

Parameters:
icon_theme Name of the icon theme, or full path to the index.theme file.
lang Language to use, or NULL for default.
Returns:
An Ecore_Desktop_Icon_Theme containing the files contents.