Etk
Main Page Object Hierarchy Data Structures Related Pages
Etk

etk_iconbox.h File Reference


Detailed Description


Data Structures

struct  Etk_Iconbox_Model
 Describes the model of an iconbox: it includes the position and the size of the cell, of the icon and of the label. An iconbox can have several models, and, at any moment, you can change the current model to change the view. More...
struct  Etk_Iconbox_Icon
 An icon of the iconbox. More...
struct  Etk_Iconbox
 [Widget] A widget that can display icons aligned on a grid More...

Defines

#define ETK_ICONBOX_TYPE   (etk_iconbox_type_get())
#define ETK_ICONBOX(obj)   (ETK_OBJECT_CAST((obj), ETK_ICONBOX_TYPE, Etk_Iconbox))
#define ETK_IS_ICONBOX(obj)   (ETK_OBJECT_CHECK_TYPE((obj), ETK_ICONBOX_TYPE))

Functions

Etk_Widget * etk_iconbox_new (void)
 Creates a new iconbox.
Etk_Iconbox_Model * etk_iconbox_model_new (Etk_Iconbox *iconbox)
 Creates a new model for the icons of the iconbox.
void etk_iconbox_model_free (Etk_Iconbox_Model *model)
 Frees the iconbox model.
void etk_iconbox_current_model_set (Etk_Iconbox *iconbox, Etk_Iconbox_Model *model)
 Sets the model used by the iconbox.
Etk_Iconbox_Model * etk_iconbox_current_model_get (Etk_Iconbox *iconbox)
 Gets the model currently used by the iconbox.
void etk_iconbox_model_geometry_set (Etk_Iconbox_Model *model, int width, int height, int xpadding, int ypadding)
 Sets the global geometry of the iconbox model.
void etk_iconbox_model_geometry_get (Etk_Iconbox_Model *model, int *width, int *height, int *xpadding, int *ypadding)
 Gets the global geometry of the iconbox model.
void etk_iconbox_model_icon_geometry_set (Etk_Iconbox_Model *model, int x, int y, int width, int height, Etk_Bool fill, Etk_Bool keep_aspect)
 Sets the icon geometry of the iconbox model.
void etk_iconbox_model_icon_geometry_get (Etk_Iconbox_Model *model, int *x, int *y, int *width, int *height, Etk_Bool *fill, Etk_Bool *keep_aspect)
 Gets the icon geometry of the iconbox model.
void etk_iconbox_model_label_geometry_set (Etk_Iconbox_Model *model, int x, int y, int width, int height, float xalign, float yalign)
 Sets the label geometry of the iconbox model.
void etk_iconbox_model_label_geometry_get (Etk_Iconbox_Model *model, int *x, int *y, int *width, int *height, float *xalign, float *yalign)
 Gets the label geometry of the iconbox model.
void etk_iconbox_freeze (Etk_Iconbox *iconbox)
 Freezes the iconbox: it will not be updated until it is thawed.
This function is useful when you want to add efficiently a lot of icons.
void etk_iconbox_thaw (Etk_Iconbox *iconbox)
 Thaws the iconbox: it will update the iconbox if it was frozen.
Etk_Iconbox_Icon * etk_iconbox_append (Etk_Iconbox *iconbox, const char *filename, const char *edje_group, const char *label)
 Appends a new icon to the iconbox.
void etk_iconbox_icon_del (Etk_Iconbox_Icon *icon)
 Removes the icon from the iconbox.
void etk_iconbox_clear (Etk_Iconbox *iconbox)
 Removes all the icons of the iconbox.
Etk_Iconbox_Icon * etk_iconbox_icon_get_at_xy (Etk_Iconbox *iconbox, int x, int y, Etk_Bool over_cell, Etk_Bool over_icon, Etk_Bool over_label)
 Gets the icon located below the position ( x, y ). The position should be relative to the canvas (TODO: relative to the icobox instead?).
void etk_iconbox_icon_file_set (Etk_Iconbox_Icon *icon, const char *filename, const char *edje_group)
 Sets the file path of the icon's image.
void etk_iconbox_icon_file_get (Etk_Iconbox_Icon *icon, const char **filename, const char **edje_group)
 Sets the file used by the icon's image.
void etk_iconbox_icon_label_set (Etk_Iconbox_Icon *icon, const char *label)
 Sets the label of the icon.
const char * etk_iconbox_icon_label_get (Etk_Iconbox_Icon *icon)
 Gets the label used for the icon image.
void etk_iconbox_icon_data_set (Etk_Iconbox_Icon *icon, void *data)
 Sets a value to the data member of an icon.
The data could be retrieved with etk_iconbox_icon_row_data_get().
void etk_iconbox_icon_data_set_full (Etk_Iconbox_Icon *icon, void *data, void(*free_cb)(void *data))
 Sets a value to the data member of an icon.
The data could be retrieved with etk_iconbox_icon_row_data_get().
void * etk_iconbox_icon_data_get (Etk_Iconbox_Icon *icon)
 Gets the value of the data member of the icon.
void etk_iconbox_select_all (Etk_Iconbox *iconbox)
 Selects all the icons of the iconbox.
void etk_iconbox_unselect_all (Etk_Iconbox *iconbox)
 Unselects all the icons of the iconbox.
void etk_iconbox_icon_select (Etk_Iconbox_Icon *icon)
 Selects the icon.
void etk_iconbox_icon_unselect (Etk_Iconbox_Icon *icon)
 Unselects the icon.
Etk_Bool etk_iconbox_is_selected (Etk_Iconbox_Icon *icon)
 Gets whether the icon is selected.
Etk_Scrolled_View * etk_iconbox_scrolled_view_get (Etk_Iconbox *iconbox)
 Gets the scrolled view of the iconbox. It can be used to change the scrollbars' policy, or to get the scroll-value.