beat me silly. comments. hope this helps people learn a bit. i don't know if

i can comment like this all over as it takes a fair bit of time and effort.

i'll try here and there though.


SVN revision: 5520
This commit is contained in:
Carsten Haitzler 2001-10-19 10:04:48 +00:00
parent 8e5adf71a6
commit b7fde63e68
1 changed files with 163 additions and 16 deletions

View File

@ -1,10 +1,10 @@
#include "iconbar.h"
static Evas_List iconbars = NULL;
static E_Config_Base_Type *cf_iconbar = NULL;
static E_Config_Base_Type *cf_iconbar_icon = NULL;
/* internal func (iconbar use only) prototypes */
static void ib_bits_show(void *data);
static void ib_bits_hide(void *data);
static void ib_bits_move(void *data, double x, double y);
@ -22,17 +22,38 @@ static void ib_mouse_out(void *data, Evas _e, Evas_Object _o, int _b, int _x, in
static void ib_mouse_down(void *data, Evas _e, Evas_Object _o, int _b, int _x, int _y);
static void ib_mouse_up(void *data, Evas _e, Evas_Object _o, int _b, int _x, int _y);
/* NB: comments here for illustration & helping people understand E's code */
/* This is a start of the comments. if you feel they are not quite good */
/* as you figure things out and if you think they could be more helpful */
/* please feel free to add to them to make them easier to read and be more */
/* helpful. */
/* init function - initialised the iconbar system */
void
e_iconbar_init()
{
/* we set up config structure and types so the config system can just */
/* read a db and dump it right into memory - including lists of stuff */
/* a new config type - an iconbar icon */
cf_iconbar_icon = e_config_type_new();
/* this is a member of the iconbar icon struct we want the config system */
/* to get from the db for us. the key is "exec". the type is a string */
/* the struct memebr is exec. the default value is "". see the config.h */
/* header for more info */
E_CONFIG_NODE(cf_iconbar_icon, "exec", E_CFG_TYPE_STR, NULL, E_Iconbar_Icon, exec, 0, 0, "");
/* this memebr will be replaced by the relative key path in the db as a */
/* string */
E_CONFIG_NODE(cf_iconbar_icon, "image", E_CFG_TYPE_KEY, NULL, E_Iconbar_Icon, image_path, 0, 0, "");
/* a new config type - in this case the iconbar istelf. the only thing we */
/* want the config system to do it fill it with iconbar icon members in */
/* the list */
cf_iconbar = e_config_type_new();
E_CONFIG_NODE(cf_iconbar, "icons", E_CFG_TYPE_LIST, cf_iconbar_icon, E_Iconbar, icons, 0, 0, NULL);
}
/* how do we crate a new iconbar? well... like this! */
E_Iconbar *
e_iconbar_new(E_View *v)
{
@ -40,45 +61,67 @@ e_iconbar_new(E_View *v)
char buf[PATH_MAX];
E_Iconbar *ib;
sprintf(buf, "%s/.e_iconbar.db", v->dir);
/* first we want to load the iconbar data itself - ie the config info */
/* for what icons we have and what they execute */
sprintf(buf, "%s/.e_iconbar.db", v->dir);
/* use the config system to simply load up the db and start making */
/* structs and lists and stuff for us... we told it how to in init */
ib = e_config_load(buf, "", cf_iconbar);
/* no iconbar config loaded ? return NULL */
if (!ib) return NULL;
/* now that the config system has doe the loading. we need to init the */
/* object and set up ref counts and free method */
OBJ_INIT(ib, e_iconbar_free);
/* the iconbar needs to know what view it's in */
ib->view = v;
/* now go thru all the icons that were loaded */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
ic = l->data;
/* and init the iocnbar icon object */
OBJ_INIT(ic, e_iconbar_icon_free);
/* and have the iconbar icon knwo what iconbar it belongs to */
ic->iconbar = ib;
}
sprintf(buf, "%s/.e_iconbar.bits.db", v->dir);
/* now we need to load up a bits file that tells us where in the view the */
/* iconbar is meant to go. same place. just a slightly different name */
sprintf(buf, "%s/.e_iconbar.bits.db", v->dir);
ib->bit = ebits_load(buf);
/* we didn't find one? */
if (!ib->bit)
{
/* unref the iconbar (and thus it will get freed and all icons in it */
OBJ_UNREF(ib);
/* return NULL - no iconbar worth doing here if we don't know where */
/* to put it */
return NULL;
}
/* aaah. our nicely constructed iconbar data struct with all the goodies */
/* we need. return it. she's ready for use. */
return ib;
}
/* our free method for iconbars. how do we free these pesky little urchins */
void
e_iconbar_free(E_Iconbar *ib)
{
iconbars = evas_list_remove(iconbars, ib);
/* tell the view we attached to that somehting in it changed. this way */
/* the view will now it needs to redraw */
ib->view->changed = 1;
/* free up our ebits */
if (ib->bit) ebits_free(ib->bit);
/* if we have any icons... */
if (ib->icons)
{
Evas_List l;
/* go thru the list of icon and unref each one.. ie - free it */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
@ -86,40 +129,65 @@ e_iconbar_free(E_Iconbar *ib)
ic = l->data;
OBJ_UNREF(ic);
}
/* free the list itself */
evas_list_free(ib->icons);
}
FREE(ib);
/* free the iconbar struct */
FREE(ib);
}
/* how do we free an iconbar icon... well like this */
void
e_iconbar_icon_free(E_Iconbar_Icon *ic)
{
/* if we have an imageobject. nuke it */
if (ic->image) evas_del_object(ic->iconbar->view->evas, ic->image);
/* free strings ... if they exist */
IF_FREE(ic->image_path);
IF_FREE(ic->exec);
/* nuke that struct */
FREE(ic);
}
/* turn our iconbar into more than a structure of config data. actually */
/* crate evas objcts we can do something visual with */
void
e_iconbar_realize(E_Iconbar *ib)
{
Evas_List l;
/* go thru every icon in the iconbar */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
char buf[PATH_MAX];
ic = l->data;
/* set the path of the image to load to be the iconbar db plus */
/* the path of the key to the image memebr - that is actually */
/* a lump of image data inlined in the iconbar db - so the icons */
/* themselves follow the iconbar wherever it goes */
sprintf(buf, "%s/.e_iconbar.db:%s", ib->view->dir, ic->image_path);
/* add the icon image object */
ic->image = evas_add_image_from_file(ib->view->evas, buf);
/* set it to be semi-transparent */
evas_set_color(ib->view->evas, ic->image, 255, 255, 255, 128);
/* set up callbacks on events - so the ib_* functions will be */
/* called when the corresponding event happens to the icon */
evas_callback_add(ib->view->evas, ic->image, CALLBACK_MOUSE_IN, ib_mouse_in, ic);
evas_callback_add(ib->view->evas, ic->image, CALLBACK_MOUSE_OUT, ib_mouse_out, ic);
evas_callback_add(ib->view->evas, ic->image, CALLBACK_MOUSE_DOWN, ib_mouse_down, ic);
evas_callback_add(ib->view->evas, ic->image, CALLBACK_MOUSE_UP, ib_mouse_up, ic);
}
/* add the ebit we loaded to the evas the iconbar exists in - now the */
/* ebit is more than just structures as well. */
ebits_add_to_evas(ib->bit, ib->view->evas);
/* aaaaaaaaah. the magic of being able to replace a named bit in an ebit */
/* (in this case we expect a bit called "Icons" to exist - the user will */
/* have added a bti called this into the ebit to indicate where he/she */
/* wants icons to go. we basically replace this bit with a virtual set */
/* of callbacks that ebits will call if this bit is to be moved, resized */
/* shown, hidden, raised, lowered etc. we provide the callbacks. */
ebits_set_named_bit_replace(ib->bit, "Icons",
ib_bits_show,
ib_bits_hide,
@ -133,33 +201,48 @@ e_iconbar_realize(E_Iconbar *ib)
ib_bits_get_min_size,
ib_bits_get_max_size,
ib);
/* now move this ebit to a really high layer.. so its ontop of a lot */
ebits_set_layer(ib->bit, 10000);
/* and now call "fix" - i called it fix cause it does a few things... */
/* but fixes the iconbar so its the size of the view, in the right */
/* place and arranges the icons in their right spots */
e_iconbar_fix(ib);
}
/* fix up the geometry and visibility of the iconbar gfx and icons */
void
e_iconbar_fix(E_Iconbar *ib)
{
Evas_List l;
double ix, iy, aw, ah;
/* move the ebit to 0,0 */
ebits_move(ib->bit, 0, 0);
/* resize it to fill the whole view. the internal geometry of the */
/* ebit itself will determine where things woudl go. we just tell */
/* the ebit where in the canvas its allowed to exist */
ebits_resize(ib->bit, ib->view->size.w, ib->view->size.h);
/* show it. harmless to do this all the time */
ebits_show(ib->bit);
/* tell the view we belong to something may have changed so it can draw */
ib->view->changed = 1;
/* the callbacks set up in th ebtis replace will set up what area in */
/* the canvas icons can exist in. lets extract them here */
ix = ib->icon_area.x;
iy = ib->icon_area.y;
aw = ib->icon_area.w;
ah = ib->icon_area.h;
/* not used yet... */
if (aw > ah) /* horizontal */
{
}
else /* vertical */
{
}
/* now go thru all the icons... */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
@ -168,40 +251,66 @@ e_iconbar_fix(E_Iconbar *ib)
double ox, oy;
ic = l->data;
/* find out the original image size (of the image file) */
evas_get_image_size(ic->iconbar->view->evas, ic->image, &iw, &ih);
w = iw;
h = ih;
ox = 0;
oy = 0;
/* if the area to put icons is wider that it is tall... horizonatal */
/* layout of the icons seems smart */
if (aw > ah) /* horizontal */
{
/* if the icon height is bigger than the icon space */
if (h > ah)
{
/* scale the icon down in both directions soit fits */
w = (ah * w) / h;
h = ah;
}
/* center the icon vertically if its smaller */
ox = 0;
oy = (ah - h) / 2;
/* now move and resize it */
evas_move(ic->iconbar->view->evas, ic->image, ix + ox, iy + oy);
evas_resize(ic->iconbar->view->evas, ic->image, w, h);
/* advance our position counter to the next spot */
ix += w;
}
/* taller than it is wide. might be good to be vertical */
else /* vertical */
{
/* if theicon width is bigger than the icon space */
if (w > aw)
{
/* scale it down to fit */
h = (aw * h) / w;
w = aw;
}
/* center it horizontally */
ox = (aw - w) / 2;
oy = 0;
/* now move the icona nd resize it */
evas_move(ic->iconbar->view->evas, ic->image, ix + ox, iy + oy);
evas_resize(ic->iconbar->view->evas, ic->image, w, h);
/* advance out counter to the next spot */
iy += h;
}
}
}
/* static (internal to iconbar use only) callbacks */
/* called when an ebits object bit needs to be shown */
static void
ib_bits_show(void *data)
{
@ -209,6 +318,7 @@ ib_bits_show(void *data)
Evas_List l;
ib = (E_Iconbar *)data;
/* show all the icons */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
@ -218,6 +328,7 @@ ib_bits_show(void *data)
}
}
/* called when an ebit object bit needs to hide */
static void
ib_bits_hide(void *data)
{
@ -225,6 +336,7 @@ ib_bits_hide(void *data)
Evas_List l;
ib = (E_Iconbar *)data;
/* hide all the icons */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
@ -234,6 +346,7 @@ ib_bits_hide(void *data)
}
}
/* called when an ebit objetc bit needs to move */
static void
ib_bits_move(void *data, double x, double y)
{
@ -241,10 +354,12 @@ ib_bits_move(void *data, double x, double y)
Evas_List l;
ib = (E_Iconbar *)data;
/* dont do anything.. just record the geometry. we'll deal with it later */
ib->icon_area.x = x;
ib->icon_area.y = y;
}
/* called when an ebit object bit needs to resize */
static void
ib_bits_resize(void *data, double w, double h)
{
@ -252,10 +367,12 @@ ib_bits_resize(void *data, double w, double h)
Evas_List l;
ib = (E_Iconbar *)data;
/* dont do anything.. just record the geometry. we'll deal with it later */
ib->icon_area.w = w;
ib->icon_area.h = h;
}
/* called when the ebits object bit needs to be raised */
static void
ib_bits_raise(void *data)
{
@ -263,6 +380,7 @@ ib_bits_raise(void *data)
Evas_List l;
ib = (E_Iconbar *)data;
/* raise all the icons */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
@ -272,6 +390,7 @@ ib_bits_raise(void *data)
}
}
/* called when the ebits object bit needs to be lowered */
static void
ib_bits_lower(void *data)
{
@ -279,6 +398,7 @@ ib_bits_lower(void *data)
Evas_List l;
ib = (E_Iconbar *)data;
/* lower all the icons */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
@ -288,6 +408,7 @@ ib_bits_lower(void *data)
}
}
/* called when the ebits object bit needs to change layers */
static void
ib_bits_set_layer(void *data, int lay)
{
@ -295,6 +416,7 @@ ib_bits_set_layer(void *data, int lay)
Evas_List l;
ib = (E_Iconbar *)data;
/* set the layer for all the icons */
for (l = ib->icons; l; l = l->next)
{
E_Iconbar_Icon *ic;
@ -304,16 +426,20 @@ ib_bits_set_layer(void *data, int lay)
}
}
/* not used... err.. ebits clips for us to the maximum allowed space of */
/* the ebit object bit - dont know why i have this here */
static void
ib_bits_set_clip(void *data, Evas_Object clip)
{
}
/* we arent going to recolor our icons here according to color class */
static void
ib_bits_set_color_class(void *data, char *cc, int r, int g, int b, int a)
{
}
/* our minimum size for icon space is 0x0 */
static void
ib_bits_get_min_size(void *data, double *w, double *h)
{
@ -321,6 +447,7 @@ ib_bits_get_min_size(void *data, double *w, double *h)
*h = 0;
}
/* our maximum is huge */
static void
ib_bits_get_max_size(void *data, double *w, double *h)
{
@ -328,35 +455,55 @@ ib_bits_get_max_size(void *data, double *w, double *h)
*h = 999999;
}
/* called on events on icons */
/* called when a mouse goes in on an icon object */
static void
ib_mouse_in(void *data, Evas _e, Evas_Object _o, int _b, int _x, int _y)
{
E_Iconbar_Icon *ic;
/* get he iconbaricon pointer from the data member */
ic = (E_Iconbar_Icon *)data;
/* make it more opaque */
evas_set_color(ic->iconbar->view->evas, ic->image, 255, 255, 255, 255);
/* tell the view the iconbar is in.. something changed that might mean */
/* a redraw is needed */
ic->iconbar->view->changed = 1;
}
/* called when a mouse goes out of an icon object */
static void
ib_mouse_out(void *data, Evas _e, Evas_Object _o, int _b, int _x, int _y)
{
E_Iconbar_Icon *ic;
/* get he iconbaricon pointer from the data member */
ic = (E_Iconbar_Icon *)data;
/* make it more transparent */
evas_set_color(ic->iconbar->view->evas, ic->image, 255, 255, 255, 128);
/* tell the view the iconbar is in.. something changed that might mean */
/* a redraw is needed */
ic->iconbar->view->changed = 1;
}
/* called when the mouse goes down on an icon object */
static void
ib_mouse_down(void *data, Evas _e, Evas_Object _o, int _b, int _x, int _y)
{
E_Iconbar_Icon *ic;
/* get he iconbaricon pointer from the data member */
ic = (E_Iconbar_Icon *)data;
e_exec_run(ic->exec);
/* run something! */
if (ic->exec) e_exec_run(ic->exec);
}
/* called when the mouse goes up on an icon object */
static void
ib_mouse_up(void *data, Evas _e, Evas_Object _o, int _b, int _x, int _y)
{