summaryrefslogtreecommitdiff
path: root/src/lib/evas/Evas_Common.h
diff options
context:
space:
mode:
authorNicolas Aguirre <aguirre.nicolas@gmail.com>2014-10-17 15:39:18 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:27:26 +0200
commitb9fcd48986ce3f283504149090696c7d3a21e9a8 (patch)
tree92d424d10a7db3a2eb88696c639daca8e73168f5 /src/lib/evas/Evas_Common.h
parentb5e417edc42a64fb067c3c6159393cba5dd15ac4 (diff)
evas: documentation on missing apis
Diffstat (limited to 'src/lib/evas/Evas_Common.h')
-rw-r--r--src/lib/evas/Evas_Common.h199
1 files changed, 177 insertions, 22 deletions
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index bc9a62eedd..10313fb553 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -323,7 +323,7 @@ typedef int Evas_Coord;/**< A type for coordinates */;
323typedef int Evas_Font_Size; /**< A type for font size */ 323typedef int Evas_Font_Size; /**< A type for font size */
324typedef int Evas_Angle; /**< A type for angle */ 324typedef int Evas_Angle; /**< A type for angle */
325 325
326struct _Evas_Coord_Rectangle /**< A rectangle in Evas_Coord */ 326struct _Evas_Coord_Rectangle /** A rectangle in Evas_Coord */
327{ 327{
328 Evas_Coord x; /**< top-left x co-ordinate of rectangle */ 328 Evas_Coord x; /**< top-left x co-ordinate of rectangle */
329 Evas_Coord y; /**< top-left y co-ordinate of rectangle */ 329 Evas_Coord y; /**< top-left y co-ordinate of rectangle */
@@ -331,20 +331,20 @@ struct _Evas_Coord_Rectangle /**< A rectangle in Evas_Coord */
331 Evas_Coord h; /**< height of rectangle */ 331 Evas_Coord h; /**< height of rectangle */
332}; 332};
333 333
334struct _Evas_Coord_Point 334struct _Evas_Coord_Point /** A Point in Evas_Coord */
335{ 335{
336 Evas_Coord x; /**< x co-ordinate */ 336 Evas_Coord x; /**< x co-ordinate */
337 Evas_Coord y; /**< y co-ordinate */ 337 Evas_Coord y; /**< y co-ordinate */
338}; 338};
339 339
340struct _Evas_Coord_Size /**< A size in Evas_Coord */ 340struct _Evas_Coord_Size /** A size in Evas_Coord */
341{ 341{
342 Evas_Coord w; /**< width */ 342 Evas_Coord w; /**< width */
343 Evas_Coord h; /**< height */ 343 Evas_Coord h; /**< height */
344}; 344};
345 345
346 346
347struct _Evas_Coord_Precision_Size 347struct _Evas_Coord_Precision_Size /** A size in Evas_Coord with subpixel precision*/
348{ 348{
349 Evas_Coord w; /**< width */ 349 Evas_Coord w; /**< width */
350 Evas_Coord h; /**< height */ 350 Evas_Coord h; /**< height */
@@ -352,7 +352,7 @@ struct _Evas_Coord_Precision_Size
352 double ysub; /**< subpixel precision for height */ 352 double ysub; /**< subpixel precision for height */
353}; 353};
354 354
355struct _Evas_Coord_Precision_Point 355struct _Evas_Coord_Precision_Point /** A point in Evas_Coord with subpixel precision*/
356{ 356{
357 Evas_Coord x; /**< x co-ordinate */ 357 Evas_Coord x; /**< x co-ordinate */
358 Evas_Coord y; /**< y co-ordinate */ 358 Evas_Coord y; /**< y co-ordinate */
@@ -360,19 +360,19 @@ struct _Evas_Coord_Precision_Point
360 double ysub; /**< subpixel precision for y */ 360 double ysub; /**< subpixel precision for y */
361}; 361};
362 362
363struct _Evas_Point 363struct _Evas_Point /** A point */
364{ 364{
365 int x; /**< x co-ordinate */ 365 int x; /**< x co-ordinate */
366 int y; /**< y co-ordinate */ 366 int y; /**< y co-ordinate */
367}; 367};
368 368
369struct _Evas_Position 369struct _Evas_Position /** A position */
370{ 370{
371 Evas_Point output; /**< position on the output */ 371 Evas_Point output; /**< position on the output */
372 Evas_Coord_Point canvas; /**< position on the canvas */ 372 Evas_Coord_Point canvas; /**< position on the canvas */
373}; 373};
374 374
375struct _Evas_Precision_Position 375struct _Evas_Precision_Position /** A position with precision*/
376{ 376{
377 Evas_Point output; /**< position on the output */ 377 Evas_Point output; /**< position on the output */
378 Evas_Coord_Precision_Point canvas; /**< position on the canvas */ 378 Evas_Coord_Precision_Point canvas; /**< position on the canvas */
@@ -625,12 +625,12 @@ typedef enum _Evas_Device_Subclass
625 EVAS_DEVICE_SUBCLASS_TRACKBALL, /**< A trackball style mouse @since 1.8 */ 625 EVAS_DEVICE_SUBCLASS_TRACKBALL, /**< A trackball style mouse @since 1.8 */
626} Evas_Device_Subclass; /**< A general class of device @since 1.8 */ 626} Evas_Device_Subclass; /**< A general class of device @since 1.8 */
627 627
628struct _Evas_Engine_Info /**< Generic engine information. Generic info is useless */ 628struct _Evas_Engine_Info /** Generic engine information. Generic info is useless */
629{ 629{
630 int magic; /**< Magic number */ 630 int magic; /**< Magic number */
631}; 631};
632 632
633struct _Evas_Event_Mouse_Down /**< Mouse button press event */ 633struct _Evas_Event_Mouse_Down /** Mouse button press event */
634{ 634{
635 int button; /**< Mouse button number that went down (1 - 32) */ 635 int button; /**< Mouse button number that went down (1 - 32) */
636 636
@@ -648,7 +648,7 @@ struct _Evas_Event_Mouse_Down /**< Mouse button press event */
648 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */ 648 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
649}; 649};
650 650
651struct _Evas_Event_Mouse_Up /**< Mouse button release event */ 651struct _Evas_Event_Mouse_Up /** Mouse button release event */
652{ 652{
653 int button; /**< Mouse button number that was raised (1 - 32) */ 653 int button; /**< Mouse button number that was raised (1 - 32) */
654 654
@@ -666,7 +666,7 @@ struct _Evas_Event_Mouse_Up /**< Mouse button release event */
666 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */ 666 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
667}; 667};
668 668
669struct _Evas_Event_Mouse_In /**< Mouse enter event */ 669struct _Evas_Event_Mouse_In /** Mouse enter event */
670{ 670{
671 int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */ 671 int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */
672 672
@@ -682,7 +682,7 @@ struct _Evas_Event_Mouse_In /**< Mouse enter event */
682 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */ 682 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
683}; 683};
684 684
685struct _Evas_Event_Mouse_Out /**< Mouse leave event */ 685struct _Evas_Event_Mouse_Out /** Mouse leave event */
686{ 686{
687 int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */ 687 int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */
688 688
@@ -698,7 +698,7 @@ struct _Evas_Event_Mouse_Out /**< Mouse leave event */
698 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */ 698 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
699}; 699};
700 700
701struct _Evas_Event_Mouse_Move /**< Mouse move event */ 701struct _Evas_Event_Mouse_Move /** Mouse move event */
702{ 702{
703 int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */ 703 int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */
704 704
@@ -714,7 +714,7 @@ struct _Evas_Event_Mouse_Move /**< Mouse move event */
714 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */ 714 Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
715}; 715};
716 716
717struct _Evas_Event_Mouse_Wheel /**< Wheel event */ 717struct _Evas_Event_Mouse_Wheel /** Wheel event */
718{ 718{
719 int direction; /* 0 = default up/down wheel FIXME: more wheel types */ 719 int direction; /* 0 = default up/down wheel FIXME: more wheel types */
720 int z; /* ...,-2,-1 = down, 1,2,... = up */ 720 int z; /* ...,-2,-1 = down, 1,2,... = up */
@@ -730,7 +730,7 @@ struct _Evas_Event_Mouse_Wheel /**< Wheel event */
730 Evas_Device *dev; 730 Evas_Device *dev;
731}; 731};
732 732
733struct _Evas_Event_Multi_Down /**< Multi button press event */ 733struct _Evas_Event_Multi_Down /** Multi button press event */
734{ 734{
735 int device; /**< Multi device number that went down (1 or more for extra touches) */ 735 int device; /**< Multi device number that went down (1 or more for extra touches) */
736 double radius, radius_x, radius_y; 736 double radius, radius_x, radius_y;
@@ -749,7 +749,7 @@ struct _Evas_Event_Multi_Down /**< Multi button press event */
749 Evas_Device *dev; 749 Evas_Device *dev;
750}; 750};
751 751
752struct _Evas_Event_Multi_Up /**< Multi button release event */ 752struct _Evas_Event_Multi_Up /** Multi button release event */
753{ 753{
754 int device; /**< Multi device number that went up (1 or more for extra touches) */ 754 int device; /**< Multi device number that went up (1 or more for extra touches) */
755 double radius, radius_x, radius_y; 755 double radius, radius_x, radius_y;
@@ -768,7 +768,7 @@ struct _Evas_Event_Multi_Up /**< Multi button release event */
768 Evas_Device *dev; 768 Evas_Device *dev;
769}; 769};
770 770
771struct _Evas_Event_Multi_Move /**< Multi button down event */ 771struct _Evas_Event_Multi_Move /** Multi button down event */
772{ 772{
773 int device; /**< Multi device number that moved (1 or more for extra touches) */ 773 int device; /**< Multi device number that moved (1 or more for extra touches) */
774 double radius, radius_x, radius_y; 774 double radius, radius_x, radius_y;
@@ -784,7 +784,7 @@ struct _Evas_Event_Multi_Move /**< Multi button down event */
784 Evas_Device *dev; 784 Evas_Device *dev;
785}; 785};
786 786
787struct _Evas_Event_Key_Down /**< Key press event */ 787struct _Evas_Event_Key_Down /** Key press event */
788{ 788{
789 char *keyname; /**< the name string of the key pressed */ 789 char *keyname; /**< the name string of the key pressed */
790 void *data; 790 void *data;
@@ -801,7 +801,7 @@ struct _Evas_Event_Key_Down /**< Key press event */
801 unsigned int keycode; /**< Key scan code numeric value @since 1.10 */ 801 unsigned int keycode; /**< Key scan code numeric value @since 1.10 */
802}; 802};
803 803
804struct _Evas_Event_Key_Up /**< Key release event */ 804struct _Evas_Event_Key_Up /** Key release event */
805{ 805{
806 char *keyname; /**< the name string of the key released */ 806 char *keyname; /**< the name string of the key released */
807 void *data; 807 void *data;
@@ -818,12 +818,12 @@ struct _Evas_Event_Key_Up /**< Key release event */
818 unsigned int keycode; /**< Key scan code numeric value @since 1.10 */ 818 unsigned int keycode; /**< Key scan code numeric value @since 1.10 */
819}; 819};
820 820
821struct _Evas_Event_Render_Post /**< Send when the frame rendering is done @since 1.8 */ 821struct _Evas_Event_Render_Post /** Send when the frame rendering is done @since 1.8 */
822{ 822{
823 Eina_List *updated_area; /**< A list of rectangle that were updated in the canvas */ 823 Eina_List *updated_area; /**< A list of rectangle that were updated in the canvas */
824}; 824};
825 825
826struct _Evas_Event_Hold /**< Hold change event */ 826struct _Evas_Event_Hold /** Hold change event */
827{ 827{
828 int hold; /**< The hold flag */ 828 int hold; /**< The hold flag */
829 void *data; 829 void *data;
@@ -2559,18 +2559,173 @@ EAPI void evas_map_point_color_get(const Evas_Map *m, int idx, int *r
2559 * @{ 2559 * @{
2560 */ 2560 */
2561 2561
2562/**
2563 * Function signature for the resize event of an evas object
2564 *
2565 * @param data is the pointer passed through the callback.
2566 * @param obj the object being shown.
2567 *
2568 * @see evas_object_intercept_show_callback_add()
2569 * @see evas_object_intercept_show_callback_del()
2570 *
2571 */
2562typedef void (*Evas_Object_Intercept_Show_Cb)(void *data, Evas_Object *obj); 2572typedef void (*Evas_Object_Intercept_Show_Cb)(void *data, Evas_Object *obj);
2573
2574/**
2575 * Function signature for the hide event of an evas object
2576 *
2577 * @param data is the pointer passed through the callback.
2578 * @param obj the object being hidden.
2579 *
2580 * @see evas_object_intercept_hide_callback_add()
2581 * @see evas_object_intercept_hide_callback_del()
2582 *
2583 */
2563typedef void (*Evas_Object_Intercept_Hide_Cb)(void *data, Evas_Object *obj); 2584typedef void (*Evas_Object_Intercept_Hide_Cb)(void *data, Evas_Object *obj);
2585
2586/**
2587 * Function signature for the move event of an evas object
2588 *
2589 * @param data the pointer passed through the callback.
2590 * @param obj the object being moved.
2591 * @param x move x position
2592 * @param y move y position
2593 *
2594 * @see evas_object_intercept_move_callback_add()
2595 * @see evas_object_intercept_move_callback_del()
2596 *
2597 */
2564typedef void (*Evas_Object_Intercept_Move_Cb)(void *data, Evas_Object *obj, Evas_Coord x, Evas_Coord y); 2598typedef void (*Evas_Object_Intercept_Move_Cb)(void *data, Evas_Object *obj, Evas_Coord x, Evas_Coord y);
2599
2600/**
2601 * Function signature for the resize event of an evas object
2602 *
2603 * @param data the pointer passed through the callback.
2604 * @param obj the object being resized.
2605 * @param width of the object
2606 * @param height of the object
2607 *
2608 * @see evas_object_intercept_resize_callback_add()
2609 * @see evas_object_intercept_resize_callback_del()
2610 *
2611 */
2565typedef void (*Evas_Object_Intercept_Resize_Cb)(void *data, Evas_Object *obj, Evas_Coord w, Evas_Coord h); 2612typedef void (*Evas_Object_Intercept_Resize_Cb)(void *data, Evas_Object *obj, Evas_Coord w, Evas_Coord h);
2613
2614/**
2615 * Function signature for the raise event of an evas object
2616 *
2617 * @param data the pointer passed through the callback.
2618 * @param obj the object being raised.
2619 *
2620 * @see evas_object_intercept_raise_callback_add()
2621 * @see evas_object_intercept_raise_callback_del()
2622 *
2623 */
2566typedef void (*Evas_Object_Intercept_Raise_Cb)(void *data, Evas_Object *obj); 2624typedef void (*Evas_Object_Intercept_Raise_Cb)(void *data, Evas_Object *obj);
2625
2626/**
2627 * Function signature for the lower event of an evas object
2628 *
2629 * @param data the pointer passed through the callback.
2630 * @param obj the object being lowered.
2631 *
2632 * @see evas_object_intercept_lower_callback_add()
2633 * @see evas_object_intercept_lower_callback_del()
2634 *
2635 */
2567typedef void (*Evas_Object_Intercept_Lower_Cb)(void *data, Evas_Object *obj); 2636typedef void (*Evas_Object_Intercept_Lower_Cb)(void *data, Evas_Object *obj);
2637
2638/**
2639 * Function signature for the stack above event of an evas object
2640 *
2641 * @param data the pointer passed through the callback.
2642 * @param obj the object being stacked above.
2643 * @param above the object above which the object is stacked
2644 *
2645 * @see evas_object_intercept_stack_above_callback_add()
2646 * @see evas_object_intercept_stack_above_callback_del()
2647 *
2648 */
2568typedef void (*Evas_Object_Intercept_Stack_Above_Cb)(void *data, Evas_Object *obj, Evas_Object *above); 2649typedef void (*Evas_Object_Intercept_Stack_Above_Cb)(void *data, Evas_Object *obj, Evas_Object *above);
2650
2651/**
2652 * Function signature for the stack below event of an evas object
2653 *
2654 * @param data the pointer passed through the callback.
2655 * @param obj the object being stacked below.
2656 * @param above the object below which the object is stacked
2657 *
2658 * @see evas_object_intercept_stack_below_callback_add()
2659 * @see evas_object_intercept_stack_below_callback_del()
2660 *
2661 */
2569typedef void (*Evas_Object_Intercept_Stack_Below_Cb)(void *data, Evas_Object *obj, Evas_Object *above); 2662typedef void (*Evas_Object_Intercept_Stack_Below_Cb)(void *data, Evas_Object *obj, Evas_Object *above);
2663
2664/**
2665 * Function signature for the layer event of an evas object
2666 *
2667 * @param data the pointer passed through the callback.
2668 * @param obj the object being layered
2669 * @param l the layer value
2670 *
2671 * @see evas_object_intercept_layer_callback_add()
2672 * @see evas_object_intercept_layer_callback_del()
2673 *
2674 */
2570typedef void (*Evas_Object_Intercept_Layer_Set_Cb)(void *data, Evas_Object *obj, int l); 2675typedef void (*Evas_Object_Intercept_Layer_Set_Cb)(void *data, Evas_Object *obj, int l);
2676
2677/**
2678 * Function signature for the focus set event of an evas object
2679 *
2680 * @param data the pointer passed through the callback.
2681 * @param obj the object being focused
2682 * @param focus the focus value, EINA_TRUE if the object is focused, EINA_FALSE otherwise
2683 *
2684 * @see evas_object_intercept_focus_set_callback_add()
2685 * @see evas_object_intercept_focus_set_callback_del()
2686 *
2687 */
2571typedef void (*Evas_Object_Intercept_Focus_Set_Cb)(void *data, Evas_Object *obj, Eina_Bool focus); 2688typedef void (*Evas_Object_Intercept_Focus_Set_Cb)(void *data, Evas_Object *obj, Eina_Bool focus);
2689
2690/**
2691 * Function signature for the color set event of an evas object
2692 *
2693 * @param data the pointer passed through the callback.
2694 * @param obj the object changing color
2695 * @param r the red component of the color
2696 * @param g the green component of the color
2697 * @param b the blue component of the color
2698 * @param a the alpha component of the color
2699 *
2700 * @see evas_object_intercept_color_set_callback_add()
2701 * @see evas_object_intercept_color_set_callback_del()
2702 *
2703 */
2572typedef void (*Evas_Object_Intercept_Color_Set_Cb)(void *data, Evas_Object *obj, int r, int g, int b, int a); 2704typedef void (*Evas_Object_Intercept_Color_Set_Cb)(void *data, Evas_Object *obj, int r, int g, int b, int a);
2705
2706/**
2707 * Function signature for the clip set event of an evas object
2708 *
2709 * @param data the pointer passed through the callback.
2710 * @param obj the object being clipped
2711 * @param clip the evas object on which the object is clipped
2712 *
2713 * @see evas_object_intercept_clip_set_callback_add()
2714 * @see evas_object_intercept_clip_set_callback_del()
2715 *
2716 */
2573typedef void (*Evas_Object_Intercept_Clip_Set_Cb)(void *data, Evas_Object *obj, Evas_Object *clip); 2717typedef void (*Evas_Object_Intercept_Clip_Set_Cb)(void *data, Evas_Object *obj, Evas_Object *clip);
2718
2719/**
2720 * Function signature for the clip unset event of an evas object
2721 *
2722 * @param data the pointer passed through the callback.
2723 * @param obj the object being unclipped
2724 *
2725 * @see evas_object_intercept_clip_unset_callback_add()
2726 * @see evas_object_intercept_clip_unset_callback_del()
2727 *
2728 */
2574typedef void (*Evas_Object_Intercept_Clip_Unset_Cb)(void *data, Evas_Object *obj); 2729typedef void (*Evas_Object_Intercept_Clip_Unset_Cb)(void *data, Evas_Object *obj);
2575 2730
2576/** 2731/**