Efreet_Icon: The FDO Icon Theme

Data Structures
struct	Efreet_Icon
	Contains all the information about a given icon. More...
struct	Efreet_Icon_Point
	Stores an x, y point. More...
struct	Efreet_Icon_Theme
	contains all of the known information about a given theme More...
struct	Efreet_Icon_Theme_Directory
	Contains all the information about a sub-directory of a theme. More...
Typedefs
typedef struct Efreet_Icon	Efreet_Icon
typedef struct Efreet_Icon_Point	Efreet_Icon_Point
typedef enum Efreet_Icon_Size_Type	Efreet_Icon_Size_Type
typedef struct Efreet_Icon_Theme	Efreet_Icon_Theme
typedef enum Efreet_Icon_Theme_Context	Efreet_Icon_Theme_Context
typedef struct Efreet_Icon_Theme_Directory	Efreet_Icon_Theme_Directory
Enumerations
enum	Efreet_Icon_Size_Type { EFREET_ICON_SIZE_TYPE_NONE, EFREET_ICON_SIZE_TYPE_FIXED, EFREET_ICON_SIZE_TYPE_SCALABLE, EFREET_ICON_SIZE_TYPE_THRESHOLD }
enum	Efreet_Icon_Theme_Context { EFREET_ICON_THEME_CONTEXT_NONE, EFREET_ICON_THEME_CONTEXT_ACTIONS, EFREET_ICON_THEME_CONTEXT_DEVICES, EFREET_ICON_THEME_CONTEXT_FILESYSTEMS, EFREET_ICON_THEME_CONTEXT_MIMETYPES }
Functions
EAPI const char *	efreet_icon_deprecated_user_dir_get (void)
	Returns the deprecated user icon directory.
EAPI void	efreet_icon_extension_add (const char *ext)
	Adds the given extension to the list of possible icon extensions.
EAPI Eina_List **	efreet_icon_extra_list_get (void)
	Gets the list of all extra directories to look for icons. These directories are used to look for icons after looking in the user icon dir and before looking in standard system directories. The order of search is from first to last directory in this list. the strings in the list should be created with eina_stringshare_add().
EAPI Efreet_Icon *	efreet_icon_find (const char theme_name, const char icon, unsigned int size)
	Retrieves all of the information about the given icon.
EAPI void	efreet_icon_free (Efreet_Icon *icon)
	Free's the given icon and all its internal data.
EAPI const char *	efreet_icon_list_find (const char theme_name, Eina_List icons, unsigned int size)
	Retrieves all of the information about the first found icon in the list.
EAPI const char *	efreet_icon_path_find (const char theme_name, const char icon, unsigned int size)
	Retrives the path to the given icon.
EAPI Efreet_Icon_Theme *	efreet_icon_theme_find (const char *theme_name)
	Tries to get the icon theme structure for the given theme name.
EAPI Eina_List *	efreet_icon_theme_list_get (void)
	Retrieves all of the non-hidden icon themes available on the system. The returned list must be freed. Do not free the list data.
EAPI const char *	efreet_icon_user_dir_get (void)
	Returns the user icon directory.
Variables
EAPI int	EFREET_EVENT_ICON_CACHE_UPDATE

Detailed Description

Specification functions and structures

Typedef Documentation

typedef struct Efreet_Icon Efreet_Icon

Efreet_Icon

typedef struct Efreet_Icon_Point Efreet_Icon_Point

Efreet_Icon_Point

typedef enum Efreet_Icon_Size_Type Efreet_Icon_Size_Type

The possible size types for an icon directory

typedef struct Efreet_Icon_Theme Efreet_Icon_Theme

Efreet_Icon_Theme

typedef enum Efreet_Icon_Theme_Context Efreet_Icon_Theme_Context

The possible contexts for an icon directory

typedef struct Efreet_Icon_Theme_Directory Efreet_Icon_Theme_Directory

Efreet_Icon_Theme_Directory

Enumeration Type Documentation

enum Efreet_Icon_Size_Type

The possible size types for an icon directory

Enumerator:

EFREET_ICON_SIZE_TYPE_NONE
EFREET_ICON_SIZE_TYPE_FIXED
EFREET_ICON_SIZE_TYPE_SCALABLE
EFREET_ICON_SIZE_TYPE_THRESHOLD

enum Efreet_Icon_Theme_Context

The possible contexts for an icon directory

Enumerator:

EFREET_ICON_THEME_CONTEXT_NONE
EFREET_ICON_THEME_CONTEXT_ACTIONS
EFREET_ICON_THEME_CONTEXT_DEVICES
EFREET_ICON_THEME_CONTEXT_FILESYSTEMS
EFREET_ICON_THEME_CONTEXT_MIMETYPES

Function Documentation

EAPI const char* efreet_icon_deprecated_user_dir_get ( void )

Returns the deprecated user icon directory.

Returns:: Returns the deprecated user icon directory

References alloca(), and efreet_home_dir_get().

EAPI void efreet_icon_extension_add ( const char * ext )

Adds the given extension to the list of possible icon extensions.

Parameters:

ext

The extension to add to the list of checked extensions

Returns:: Returns no value.

EAPI Eina_List** efreet_icon_extra_list_get ( void )

Gets the list of all extra directories to look for icons. These directories are used to look for icons after looking in the user icon dir and before looking in standard system directories. The order of search is from first to last directory in this list. the strings in the list should be created with eina_stringshare_add().

Returns:: Returns a list of strings that are paths to other icon directories

EAPI Efreet_Icon* efreet_icon_find	(	const char *	theme_name,
		const char *	icon,
		unsigned int	size
	)

Retrieves all of the information about the given icon.

Parameters:

	theme_name	The icon theme to look for
	icon	The icon to look for
	size	The icon size to look for

Returns:: Returns the Efreet_Icon structure representing this icon or NULL if the icon is not found

References efreet_icon_path_find().

EAPI void efreet_icon_free ( Efreet_Icon * icon )

Free's the given icon and all its internal data.

Parameters:

icon

The Efreet_Icon to cleanup

Returns:: Returns no value.

References attach_points, FREE, IF_FREE_LIST, IF_RELEASE, name, path, and ref_count.

EAPI const char* efreet_icon_list_find	(	const char *	theme_name,
		Eina_List *	icons,
		unsigned int	size
	)

Retrieves all of the information about the first found icon in the list.

Parameters:

	theme_name	The icon theme to look for
	icons	List of icons to look for
	size;	The icon size to look for

Returns:: Returns the path representing first found icon or NULL if none of the icons are found

Note:: This function will search the given theme for all icons before falling back. This is useful when searching for mimetype icons.

References efreet_icon_theme_find(), Efreet_Icon_Theme::name, and NON_EXISTING.

Referenced by efreet_mime_type_icon_get().

EAPI const char* efreet_icon_path_find	(	const char *	theme_name,
		const char *	icon,
		unsigned int	size
	)

Retrives the path to the given icon.

Parameters:

	theme_name	The icon theme to look for
	icon	The icon to look for
	size;	The icon size to look for

Returns:: Returns the path to the given icon or NULL if none found

References efreet_icon_theme_find(), FREE, INFO, and NON_EXISTING.

Referenced by efreet_icon_find().

EAPI Efreet_Icon_Theme* efreet_icon_theme_find ( const char * theme_name )

Tries to get the icon theme structure for the given theme name.

Parameters:

theme_name

The theme to look for

Returns:: Returns the icon theme related to the given theme name or NULL if none exists.

References efreet_icon_themes, and Efreet_Icon_Theme::name.

Referenced by efreet_icon_list_find(), efreet_icon_path_find(), and efreet_icon_theme_list_get().

EAPI Eina_List* efreet_icon_theme_list_get ( void )

Retrieves all of the non-hidden icon themes available on the system. The returned list must be freed. Do not free the list data.

Returns:: Returns a list of Efreet_Icon structs for all the non-hidden icon themes

References efreet_icon_theme_find(), efreet_icon_themes, Efreet_Icon_Theme::hidden, Efreet_Icon_Theme::name, and Efreet_Icon_Theme::valid.

EAPI const char* efreet_icon_user_dir_get ( void )

Returns the user icon directory.

Returns:: Returns the user icon directory

References alloca(), and efreet_data_home_get().

Variable Documentation

EAPI int EFREET_EVENT_ICON_CACHE_UPDATE

Event id for cache update.

Referenced by efreet_cache_init().

Enlightenment

Beauty at your fingertips

Efreet_Icon: The FDO Icon Theme

Data Structures

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation