News

Documentation

Efreet_Icon: The FDO Icon Theme


Detailed Description

Specification functions and structures


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 Efreet_Icon Efreet_Icon
typedef Efreet_Icon_Point Efreet_Icon_Point
typedef enum Efreet_Icon_Size_Type Efreet_Icon_Size_Type
typedef Efreet_Icon_Theme Efreet_Icon_Theme
typedef enum Efreet_Icon_Theme_Context Efreet_Icon_Theme_Context
typedef 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

const char * efreet_icon_dir_get (void)
 Returns the user icon directory.
void efreet_icon_extension_add (const char *ext)
 Adds the given extension to the list of possible icon extensions.
Ecore_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 ecore_string_instance().
Efreet_Iconefreet_icon_find (const char *theme_name, const char *icon, const char *size)
 Retrieves all of the information about the given icon.
const char * efreet_icon_path_find (const char *theme, const char *icon, const char *size)
 Retrives the path to the given icon.
Efreet_Icon_Themeefreet_icon_theme_find (const char *theme_name)
 Tries to get the icon theme structure for the given theme name.
Ecore_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.

Typedef Documentation

typedef struct Efreet_Icon Efreet_Icon

Efreet_Point

Efreet_Icon_Size_Type

Efreet_icon_Theme_Context


Enumeration Type Documentation

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 

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

const char* efreet_icon_dir_get ( void   ) 

Returns the user icon directory.

Returns:
Returns the user icon directory

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.

Ecore_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 ecore_string_instance().

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

Efreet_Icon* efreet_icon_find ( const char *  theme_name,
const char *  icon,
const char *  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

const char* efreet_icon_path_find ( const char *  theme,
const char *  icon,
const char *  size 
)

Retrives the path to the given icon.

Parameters:
theme,: 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

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.

Ecore_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


Copyright © Enlightenment.org

Efreet Documentation Generated: Sat Apr 7 17:55:55 2007