enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 1 Projects Releases Wiki Activity

Improve documentation for Evas, Ecore, Edje and Elementary. 

Work by:
 - Thiago R. Masaki (mostly)
 - Fabiano Fidencio
 - Gustavo Lima


SVN revision: 42550
This commit is contained in:
Iván Briano 2009-09-17 22:38:10 +00:00
parent 131be821c8
commit 5c3b4fa74e
18 changed files with 890 additions and 454 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
legacy/evas/src/lib/canvas/evas_async_events.c
View File

@ -61,6 +61,28 @@ evas_async_events_shutdown(void)
#endif
/**
* @brief Get evas' internal asynchronous events read file descriptor.
*
* @return The canvas' asynchronous events read file descriptor.
*
* Evas' asynchronous events are meant to be dealt with internally,
* i. e., when building stuff to be glued together into the EFL
* infrastructure -- a module, for example. The context which demands
* its use is when calculations need to be done out of the main
* thread, asynchronously, and some action must be performed after
* that.
*
* An example of actual use of this API is for image asynchronous
* preload inside evas. If the canvas was instantiated throught
* ecore-evas usage, ecore itself will take care of calling those
* events' processing.
*
* This function returns the read file descriptor where to get the
* asynchronous events of the canvas. Naturally, other mainloops,
* apart from ecore, may make use of it.
*
*/
EAPI int
evas_async_events_fd_get(void)
{
@ -71,6 +93,18 @@ evas_async_events_fd_get(void)
#endif
}
/**
* @brief Trigger the processing of all events waiting on the file
* descriptor returned by evas_async_events_fd_get().
*
* @return The number of events processed.
*
* All asynchronous events queued up by evas_async_events_put() are
* processed here. More precisely, the callback functions, informed
* together with other event parameters, when queued, get called (with
* those parameters), in that order.
*
*/
EAPI int
evas_async_events_process(void)
{
@ -115,6 +149,20 @@ evas_async_events_process(void)
#endif
}
/**
* Insert asynchronous events on the canvas.
*
* @param target The target to be affected by the events.
* @param type The type of callback function.
* @param event_info Information about the event.
* @param func The callback function pointer.
*
* This is the way, for a routine running outside evas' main thread,
* to report an asynchronous event. A callback function is informed,
* whose call is to happen after evas_async_events_process() is
* called.
*
*/
EAPI Eina_Bool
evas_async_events_put(const void *target, Evas_Callback_Type type, void *event_info, void (*func)(void *target, Evas_Callback_Type type, void *event_info))
{

190
legacy/evas/src/lib/canvas/evas_callbacks.c
View File

@ -156,140 +156,154 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
/**
* Add a callback function to an object
*
* @param obj Object to attach a callback to
* @param type The type of event that will trigger the callback
* @param func The function to be called when the event is triggered
* @param data The data pointer to be passed to @p func
*
* This function adds a function callback to an object when the event of type
* @p type occurs on object @p obj. The function is @p func.
* This function adds a function callback to an object when the event
* of type @p type occurs on object @p obj. The function is @p func.
*
* In the event of a memory allocation error during addition of the callback to
* the object, evas_alloc_error() should be used to determine the nature of
* the error, if any, and the program should sensibly try and recover.
* In the event of a memory allocation error during addition of the
* callback to the object, evas_alloc_error() should be used to
* determine the nature of the error, if any, and the program should
* sensibly try and recover.
*
* The function will be passed the pointer @p data when it is called. A
* callback function must look like this:
* The function will be passed the pointer @p data when it is
* called. A callback function must look like this:
*
* @code
* void callback (void *data, Evas *e, Evas_Object *obj, void *event_info);
* @endcode
*
* The first parameter @p data in this function will be the same value passed
* to evas_object_event_callback_add() as the @p data parameter. The second
* parameter is a convenience for the programmer to know what evas canvas the
* event occured on. The third parameter @p obj is the Object handle on which
* the event occured. The foruth parameter @p event_info is a pointer to a
* data structure that may or may not be passed to the callback, depending on
* the event type that triggered the callback.
* The first parameter @p data in this function will be the same value
* passed to evas_object_event_callback_add() as the @p data
* parameter. The second parameter is a convenience for the programmer
* to know what evas canvas the event occured on. The third parameter
* @p obj is the Object handle on which the event occured. The foruth
* parameter @p event_info is a pointer to a data structure that may
* or may not be passed to the callback, depending on the event type
* that triggered the callback.
*
* The event type @p type to trigger the function may be one of
* EVAS_CALLBACK_MOUSE_IN, EVAS_CALLBACK_MOUSE_OUT, EVAS_CALLBACK_MOUSE_DOWN,
* EVAS_CALLBACK_MOUSE_UP, EVAS_CALLBACK_MOUSE_MOVE, EVAS_CALLBACK_MOUSE_WHEEL,
* EVAS_CALLBACK_MOUSE_IN, EVAS_CALLBACK_MOUSE_OUT,
* EVAS_CALLBACK_MOUSE_DOWN, EVAS_CALLBACK_MOUSE_UP,
* EVAS_CALLBACK_MOUSE_MOVE, EVAS_CALLBACK_MOUSE_WHEEL,
* EVAS_CALLBACK_FREE, EVAS_CALLBACK_KEY_DOWN, EVAS_CALLBACK_KEY_UP,
* EVAS_CALLBACK_FOCUS_IN, EVAS_CALLBACK_FOCUS_OUT, EVAS_CALLBACK_SHOW,
* EVAS_CALLBACK_HIDE, EVAS_CALLBACK_MOVE, EVAS_CALLBACK_RESIZE or EVAS_CALLBACK_RESTACK.
* This determines the kind of event that will trigger the callback to be called.
* The @p event_info pointer passed to the callback will be one of the
* following, depending on the event triggering it:
* EVAS_CALLBACK_FOCUS_IN, EVAS_CALLBACK_FOCUS_OUT,
* EVAS_CALLBACK_SHOW, EVAS_CALLBACK_HIDE, EVAS_CALLBACK_MOVE,
* EVAS_CALLBACK_RESIZE or EVAS_CALLBACK_RESTACK.
* This determines the kind of event that will trigger the callback to
* be called. The @p event_info pointer passed to the callback will
* be one of the following, depending on the event triggering it:
*
* EVAS_CALLBACK_MOUSE_IN: event_info = pointer to Evas_Event_Mouse_In
*
* This event is triggered when the mouse pointer enters the region of
* the object @p obj. This may occur by the mouse pointer being moved by
* evas_event_feed_mouse_move() or evas_event_feed_mouse_move_data() calls,
* or by the object being shown, raised, moved, resized, or other objects
* being moved out of the way, hidden, lowered or moved out of the way.
* the object @p obj. This may occur by the mouse pointer being moved
* by evas_event_feed_mouse_move() or
* evas_event_feed_mouse_move_data() calls, or by the object being
* shown, raised, moved, resized, or other objects being moved out of
* the way, hidden, lowered or moved out of the way.
*
* EVAS_CALLBACK_MOUSE_OUT: event_info = pointer to Evas_Event_Mouse_Out
*
* This event is triggered exactly like EVAS_CALLBACK_MOUSE_IN is, but occurs
* when the mouse pointer exits an object. Note that no out events will be
* reported if the mouse pointer is implicitly grabbed to an object (the
* mouse buttons are down at all and any were pressed on that object). An
* out event will be reported as soon as the mouse is no longer grabbed (no
* mouse buttons are depressed). Out events will be reported once all buttons
* are released, if the mouse has left the object.
* This event is triggered exactly like EVAS_CALLBACK_MOUSE_IN is, but
* occurs when the mouse pointer exits an object. Note that no out
* events will be reported if the mouse pointer is implicitly grabbed
* to an object (the mouse buttons are down at all and any were
* pressed on that object). An out event will be reported as soon as
* the mouse is no longer grabbed (no mouse buttons are
* depressed). Out events will be reported once all buttons are
* released, if the mouse has left the object.
*
* EVAS_CALLBACK_MOUSE_DOWN: event_info = pointer to Evas_Event_Mouse_Down
* EVAS_CALLBACK_MOUSE_DOWN: event_info = pointer to
* Evas_Event_Mouse_Down
*
* This event is triggered by a mouse button being depressed while over an
* object. If pointermode is EVAS_OBJECT_POINTER_MODE_AUTOGRAB (default)
* this causes this object to passively grab the mouse until all mouse
* buttons have been released.
* That means if this mouse button is the first to be pressed, all future
* mouse events will be reported to only this object until no buttons are
* down. That includes mouse move events, in and out events, and further
* button presses. When all buttons are released, event propagation occurs
* as normal.
* This event is triggered by a mouse button being depressed while
* over an object. If pointermode is EVAS_OBJECT_POINTER_MODE_AUTOGRAB
* (default) this causes this object to passively grab the mouse until
* all mouse buttons have been released. That means if this mouse
* button is the first to be pressed, all future mouse events will be
* reported to only this object until no buttons are down. That
* includes mouse move events, in and out events, and further button
* presses. When all buttons are released, event propagation occurs as
* normal.
*
* EVAS_CALLBACK_MOUSE_UP: event_info = pointer to Evas_Event_Mouse_Up
*
* This event is triggered by a mouse button being released while over an
* object or when passively grabbed to an object. If this is the last mouse
* button to be raised on an object then the passive grab is released and
* event processing will continue as normal.
* This event is triggered by a mouse button being released while over
* an object or when passively grabbed to an object. If this is the
* last mouse button to be raised on an object then the passive grab
* is released and event processing will continue as normal.
*
* EVAS_CALLBACK_MOUSE_MOVE: event_info = pointer to Evas_Event_Mouse_Move
*
* This event is triggered by the mouse pointer moving while over an object or
* passively grabbed to an object.
* This event is triggered by the mouse pointer moving while over an
* object or passively grabbed to an object.
*
* EVAS_CALLBACK_MOUSE_WHEEL: event_info = pointer to Evas_Event_Mouse_Wheel
* EVAS_CALLBACK_MOUSE_WHEEL: event_info = pointer to
* Evas_Event_Mouse_Wheel
*
* This event is triggered by the mouse wheel being rolled while over an object
* or passively grabbed to an object.
* This event is triggered by the mouse wheel being rolled while over
* an object or passively grabbed to an object.
*
* EVAS_CALLBACK_FREE: event_info = NULL
*
* This event is triggered just before Evas is about to free all memory used
* by an object and remove all references to it. This is useful for programs
* to use if they attached data to an object and want to free it when the
* object is deleted. The object is still valid when this callback is called,
* but after this callback returns, there is no guarantee on the object's
* validity.
* This event is triggered just before Evas is about to free all
* memory used by an object and remove all references to it. This is
* useful for programs to use if they attached data to an object and
* want to free it when the object is deleted. The object is still
* valid when this callback is called, but after this callback
* returns, there is no guarantee on the object's validity.
*
* EVAS_CALLBACK_KEY_DOWN: event_info = pointer to Evas_Event_Key_Down
*
* This callback is called when a key is pressed and the focus is on the
* object, or a key has been grabbed to a particular object which wants to
* intercept the key press regardless of what object has the focus.
* This callback is called when a key is pressed and the focus is on
* the object, or a key has been grabbed to a particular object which
* wants to intercept the key press regardless of what object has the
* focus.
*
* EVAS_CALLBACK_KEY_UP: event_info = pointer to Evas_Event_Key_Up
*
* This callback is called when a key is released and the focus is on the
* object, or a key has been grabbed to a particular object which wants to
* intercept the key release regardless of what object has the focus.
* This callback is called when a key is released and the focus is on
* the object, or a key has been grabbed to a particular object which
* wants to intercept the key release regardless of what object has
* the focus.
*
* EVAS_CALLBACK_FOCUS_IN: event_info = NULL
*
* This event is called when an object gains the focus. When the callback is
* called the object has already gained the focus.
* This event is called when an object gains the focus. When the
* callback is called the object has already gained the focus.
*
* EVAS_CALLBACK_FOCUS_OUT: event_info = NULL
*
* This event is triggered by an object losing the focus. When the callback is
* called the object has already lost the focus.
* This event is triggered by an object losing the focus. When the
* callback is called the object has already lost the focus.
*
* EVAS_CALLBACK_SHOW: event_info = NULL
*
* This event is triggered by the object being shown by evas_object_show().
* This event is triggered by the object being shown by
* evas_object_show().
*
* EVAS_CALLBACK_HIDE: event_info = NULL
*
* This event is triggered by an object being hidden by evas_object_hide().
* This event is triggered by an object being hidden by
* evas_object_hide().
*
* EVAS_CALLBACK_MOVE: event_info = NULL
*
* This event is triggered by an object being moved. evas_object_move() can
* trigger this, as can any object-specific manipulations that would mean the
* object's origin could move.
* This event is triggered by an object being
* moved. evas_object_move() can trigger this, as can any
* object-specific manipulations that would mean the object's origin
* could move.
*
* EVAS_CALLBACK_RESIZE: event_info = NULL
*
* This event is triggered by an object being resized. Resizes can be
* triggered by evas_object_resize() or by any object-specific calls that may
* cause the object to resize.
* triggered by evas_object_resize() or by any object-specific calls
* that may cause the object to resize.
*
* Example:
* @code
@ -343,17 +357,18 @@ evas_object_event_callback_add(Evas_Object *obj, Evas_Callback_Type type, void (
/**
* Delete a callback function from an object
*
* @param obj Object to remove a callback from
* @param type The type of event that was triggering the callback
* @param func The function that was to be called when the event was triggered
* @return The data pointer that was to be passed to the callback
*
* This function removes the most recently added callback from the object
* @p obj which was triggered by the event type @p type and was calling the
* function @p func when triggered. If the removal is successful it will also
* return the data pointer that was passed to evas_object_event_callback_add()
* when the callback was added to the object. If not successful NULL will be
* returned.
* This function removes the most recently added callback from the
* object @p obj which was triggered by the event type @p type and was
* calling the function @p func when triggered. If the removal is
* successful it will also return the data pointer that was passed to
* evas_object_event_callback_add() when the callback was added to the
* object. If not successful NULL will be returned.
*
* Example:
* @code
@ -397,19 +412,20 @@ evas_object_event_callback_del(Evas_Object *obj, Evas_Callback_Type type, void (
/**
* Delete a callback function from an object
*
* @param obj Object to remove a callback from
* @param type The type of event that was triggering the callback
* @param func The function that was to be called when the event was triggered
* @param data The data pointer that was to be passed to the callback
* @return The data pointer that was to be passed to the callback
*
* This function removes the most recently added callback from the object
* @p obj which was triggered by the event type @p type and was calling the
* function @p func with data @p data when triggered. If the removal is
* successful it will also return the data pointer that was passed to
* evas_object_event_callback_add() (that will be the same as the parameter)
* when the callback was added to the object. If not successful NULL will be
* returned.
* This function removes the most recently added callback from the
* object @p obj which was triggered by the event type @p type and was
* calling the function @p func with data @p data when triggered. If
* the removal is successful it will also return the data pointer that
* was passed to evas_object_event_callback_add() (that will be the
* same as the parameter) when the callback was added to the
* object. If not successful NULL will be returned.
*
* Example:
* @code

176
legacy/evas/src/lib/canvas/evas_events.c
View File

@ -90,17 +90,18 @@ evas_event_list_copy(Eina_List *list)
/**
* @defgroup Evas_Event_Freezing_Group Evas Event Freezing Functions
*
* Functions that deal with the freezing of event processing of an evas.
* Functions that deal with the freezing of event processing of an
* evas.
*/
/**
* Freeze all event processing
* @param e The canvas to freeze event processing on
* Freeze all event processing.
* @param e The canvas to freeze event processing on.
*
* This function will indicate to evas that the canvas @p e is to have all
* event processing frozen until a matching evas_event_thaw() function is
* called on the same canvas. Every freeze call must be matched by a thaw call
* in order to completely thaw out a canvas.
* This function will indicate to evas that the canvas @p e is to have
* all event processing frozen until a matching evas_event_thaw()
* function is called on the same canvas. Every freeze call must be
* matched by a thaw call in order to completely thaw out a canvas.
*
* Example:
* @code
@ -124,13 +125,14 @@ evas_event_freeze(Evas *e)
}
/**
* Thaw a canvas out after freezing
* @param e The canvas to thaw out
* Thaw a canvas out after freezing.
*
* This will thaw out a canvas after a matching evas_event_freeze() call. If
* this call completely thaws out a canvas, events will start being processed
* again after this call, but this call will not invole any "missed" events
* to be evaluated.
* @param e The canvas to thaw out.
*
* This will thaw out a canvas after a matching evas_event_freeze()
* call. If this call completely thaws out a canvas, events will start
* being processed again after this call, but this call will not
* invole any "missed" events to be evaluated.
*
* See evas_event_freeze() for an example.
* @ingroup Evas_Event_Freezing_Group
@ -162,14 +164,15 @@ evas_event_thaw(Evas *e)
}
/**
* Return the freeze count of a given canvas
* @param e The canvas to fetch the freeze count from
* Return the freeze count of a given canvas.
* @param e The canvas to fetch the freeze count from.
*
* This returns the number of times the canvas has been told to freeze events.
* It is possible to call evas_event_freeze() multiple times, and these must
* be matched by evas_event_thaw() calls. This call allows the program to
* discover just how many times things have been frozen in case it may want
* to break out of a deep freeze state where the count is high.
* This returns the number of times the canvas has been told to freeze
* events. It is possible to call evas_event_freeze() multiple times,
* and these must be matched by evas_event_thaw() calls. This call
* allows the program to discover just how many times things have been
* frozen in case it may want to break out of a deep freeze state
* where the count is high.
*
* Example:
* @code
@ -188,10 +191,19 @@ evas_event_freeze_get(const Evas *e)
return e->events_frozen;
}
/**
* To be documented.
* Mouse down event feed.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param b The button number.
* @param flags The evas button flags.
* @param timestamp The timestamp of the mouse down event.
* @param data The data for canvas.
*
* This function will set some evas properties that is necessary when
* the mouse button is pressed. It prepares information to be treated
* by the callback function.
*
*/
EAPI void
@ -244,9 +256,17 @@ evas_event_feed_mouse_down(Evas *e, int b, Evas_Button_Flags flags, unsigned int
}
/**
* To be documented.
* Mouse up event feed.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param b The button number.
* @param flags evas button flags.
* @param timestamp The timestamp of the mouse up event.
* @param data The data for canvas.
*
* This function will set some evas properties that is necessary when
* the mouse button is released. It prepares information to be treated
* by the callback function.
*
*/
EAPI void
@ -390,10 +410,16 @@ evas_event_feed_mouse_up(Evas *e, int b, Evas_Button_Flags flags, unsigned int t
_evas_unwalk(e);
}
/**
* To be documented.
* Mouse cancel event feed.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param timestamp The timestamp of the mouse up event.
* @param data The data for canvas.
*
* This function will call evas_event_feed_mouse_up() when a
* mouse cancel event happens.
*
*/
EAPI void
@ -417,9 +443,17 @@ evas_event_feed_mouse_cancel(Evas *e, unsigned int timestamp, const void *data)
}
/**
* To be documented.
* Mouse wheel event feed.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param direction The wheel mouse direction.
* @param z How much mouse wheel was scrolled up or down.
* @param timestamp The timestamp of the mouse up event.
* @param data The data for canvas.
*
* This function will set some evas properties that is necessary when
* the mouse wheel is scrolled up or down. It prepares information to
* be treated by the callback function.
*
*/
EAPI void
@ -463,9 +497,17 @@ evas_event_feed_mouse_wheel(Evas *e, int direction, int z, unsigned int timestam
}
/**
* To be documented.
* Mouse move event feed.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param x The horizontal position of the mouse pointer.
* @param y The vertical position of the mouse pointer.
* @param timestamp The timestamp of the mouse up event.
* @param data The data for canvas.
*
* This function will set some evas properties that is necessary when
* the mouse is moved from its last position. It prepares information
* to be treated by the callback function.
*
*/
EAPI void
@ -674,9 +716,15 @@ evas_event_feed_mouse_move(Evas *e, int x, int y, unsigned int timestamp, const
}
/**
* To be documented.
* Mouse in event feed.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param timestamp The timestamp of the mouse up event.
* @param data The data for canvas.
*
* This function will set some evas properties that is necessary when
* the mouse in event happens. It prepares information to be treated
* by the callback function.
*
*/
EAPI void
@ -731,9 +779,15 @@ evas_event_feed_mouse_in(Evas *e, unsigned int timestamp, const void *data)
}
/**
* To be documented.
* Mouse out event feed.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param timestamp Timestamp of the mouse up event.
* @param data The data for canvas.
*
* This function will set some evas properties that is necessary when
* the mouse out event happens. It prepares information to be treated
* by the callback function.
*
*/
EAPI void
@ -785,9 +839,19 @@ evas_event_feed_mouse_out(Evas *e, unsigned int timestamp, const void *data)
}
/**
* To be documented.
* Key down event feed
*
* FIXME: To be fixed.
* @param e The canvas to thaw out
* @param keyname Name of the key
* @param key The key pressed.
* @param string A String
* @param compose The compose string
* @param timestamp Timestamp of the mouse up event
* @param data Data for canvas.
*
* This function will set some evas properties that is necessary when
* a key is pressed. It prepares information to be treated by the
* callback function.
*
*/
EAPI void
@ -867,9 +931,19 @@ evas_event_feed_key_down(Evas *e, const char *keyname, const char *key, const ch
}
/**
* To be documented.
* Key up event feed
*
* FIXME: To be fixed.
* @param e The canvas to thaw out
* @param keyname Name of the key
* @param key The key released.
* @param string string
* @param compose compose
* @param timestamp Timestamp of the mouse up event
* @param data Data for canvas.
*
* This function will set some evas properties that is necessary when
* a key is released. It prepares information to be treated by the
* callback function.
*
*/
EAPI void
@ -949,9 +1023,14 @@ evas_event_feed_key_up(Evas *e, const char *keyname, const char *key, const char
}
/**
* To be documented.
* Hold event feed
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param hold The hold.
* @param timestamp The timestamp of the mouse up event.
* @param data The data for canvas.
*
* This function makes the object to stop sending events.
*
*/
EAPI void
@ -1094,7 +1173,8 @@ evas_object_repeat_events_get(const Evas_Object *obj)
}
/**
* Set whether events on a smart member object should propagate to its parent.
* Set whether events on a smart member object should propagate to its
* parent.
*
* @param obj the smart member object
* @param prop wheter to propagate events or not
@ -1146,14 +1226,16 @@ evas_object_propagate_events_get(const Evas_Object *obj)
* @param obj
* @param setting desired behavior.
*
* This function has direct effect on event callbacks related to mouse.
* This function has direct effect on event callbacks related to
* mouse.
*
* If @p setting is EVAS_OBJECT_POINTER_MODE_AUTOGRAB, then when mouse is
* down at this object, events will be restricted to it as source, mouse
* moves, for example, will be emitted even if outside this object area.
* If @p setting is EVAS_OBJECT_POINTER_MODE_AUTOGRAB, then when mouse
* is down at this object, events will be restricted to it as source,
* mouse moves, for example, will be emitted even if outside this
* object area.
*
* If @p setting is EVAS_OBJECT_POINTER_MODE_NOGRAB, then events will be
* emitted just when inside this object area.
* If @p setting is EVAS_OBJECT_POINTER_MODE_NOGRAB, then events will
* be emitted just when inside this object area.
*
* The default value is EVAS_OBJECT_POINTER_MODE_AUTOGRAB.
*/

11
legacy/evas/src/lib/canvas/evas_focus.c
View File

@ -13,12 +13,11 @@
* @param obj The object to be focused or unfocused.
* @param focus set or remove focus to the object.
*
* Changing focus only affects where key events go.
* There can be only one object focused at any time.
* <p>
* If the parameter (@p focus) is set, the passed object will be set as the
* currently focused object. It will receive all keyboard events that are not
* exclusive key grabs on other objects.
* Changing focus only affects where key events go. There can be only
* one object focused at any time. <p> If the parameter (@p focus) is
* set, the passed object will be set as the currently focused object.
* It will receive all keyboard events that are not exclusive key
* grabs on other objects.
*
* @see evas_object_focus_get
* @see evas_focus_get

48
legacy/evas/src/lib/canvas/evas_key_grab.c
View File

@ -137,26 +137,27 @@ evas_key_grab_free(Evas_Object *obj, const char *keyname, Evas_Modifier_Mask mod
/**
* Requests @p keyname key events be directed to @p obj.
*
* Key grabs allow an object to receive key events for specific key strokes
* even if another object has focus. If the grab is non-exclusive then all
* objects that have grabs on the key will get the event, however if the
* grab is exclusive, no other object can get a grab on the key and only
* that object will get the event.
* Key grabs allow an object to receive key events for specific key
* strokes even if another object has focus. If the grab is
* non-exclusive then all objects that have grabs on the key will get
* the event, however if the grab is exclusive, no other object can
* get a grab on the key and only that object will get the event.
*
* @p keyname is a platform dependent symbolic name for the key pressed.
* It is sometimes possible to convert the string to an ASCII value of the
* key, but not always for example the enter key may be returned as the
* string 'Enter'.
* @p keyname is a platform dependent symbolic name for the key
* pressed. It is sometimes possible to convert the string to an
* ASCII value of the key, but not always for example the enter key
* may be returned as the string 'Enter'.
*
* Typical platforms are Linux frame buffer (Ecore_FB) and X server (Ecore_X)
* when using Evas with Ecore and Ecore_Evas.
* Typical platforms are Linux frame buffer (Ecore_FB) and X server
* (Ecore_X) when using Evas with Ecore and Ecore_Evas.
*
* For a list of keynames for the Linux frame buffer, please refer to the
* Ecore_FB documentation.
* For a list of keynames for the Linux frame buffer, please refer to
* the Ecore_FB documentation.
*
* @p modifiers and @p not_modifiers are bit masks of all the modifiers that are required and
* not required respectively for the new grab. Modifiers can be things such as shift and ctrl
* as well as user defigned types via evas_key_modifier_add.
* @p modifiers and @p not_modifiers are bit masks of all the
* modifiers that are required and not required respectively for the
* new grab. Modifiers can be things such as shift and ctrl as well
* as user defigned types via evas_key_modifier_add.
*
* @see evas_object_key_ungrab
* @see evas_object_focus_set
@ -166,9 +167,12 @@ evas_key_grab_free(Evas_Object *obj, const char *keyname, Evas_Modifier_Mask mod
*
* @param obj the object to direct @p keyname events to.
* @param keyname the key to request events for.
* @param modifiers a mask of modifiers that should be present to trigger the event.
* @param not_modifiers a mask of modifiers that should not be present to trigger the event.
* @param exclusive request that the @p obj is the only object receiving the @p keyname events.
* @param modifiers a mask of modifiers that should be present to
* trigger the event.
* @param not_modifiers a mask of modifiers that should not be present
* to trigger the event.
* @param exclusive request that the @p obj is the only object
* receiving the @p keyname events.
* @return Boolean indicating whether the grab succeeded
*/
EAPI Eina_Bool
@ -204,8 +208,10 @@ evas_object_key_grab(Evas_Object *obj, const char *keyname, Evas_Modifier_Mask m
*
* @param obj the object that has an existing grab.
* @param keyname the key the grab is for.
* @param modifiers a mask of modifiers that should be present to trigger the event.
* @param not_modifiers a mask of modifiers that should not be present to trigger the event.
* @param modifiers a mask of modifiers that should be present to
* trigger the event.
* @param not_modifiers a mask of modifiers that should not be present
* to trigger the event.
*/
EAPI void
evas_object_key_ungrab(Evas_Object *obj, const char *keyname, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers)

188
legacy/evas/src/lib/canvas/evas_main.c
View File

@ -4,6 +4,17 @@
static int initcount = 0;
/**
* Initialize Evas
*
* @return The init counter value.
*
* This function initialize evas, increments a counter of the number
* of calls to this function and returns this value.
*
* @see evas_shutdown().
*
*/
EAPI int
evas_init(void)
{
@ -31,6 +42,18 @@ evas_init(void)
#endif
}
/**
* Shutdown Evas
*
* @return The init counter value.
*
* This function finalize evas, decrements the counter of the number
* of calls to the function evas_init() and returns this value.
*
* @see evas_init().
*
*/
EAPI int
evas_shutdown(void)
{
@ -67,12 +90,13 @@ evas_shutdown(void)
* @li Set its render method with @ref evas_output_method_set .
* @li Set its viewport size with @ref evas_output_viewport_set .
* @li Set its size of the canvas with @ref evas_output_size_set .
* @li Ensure that the render engine is given the correct settings with
* @ref evas_engine_info_set .
* @li Ensure that the render engine is given the correct settings
* with @ref evas_engine_info_set .
*
* This function should only fail if the memory allocation fails.
*
* @return A new uninitialised Evas canvas on success. Otherwise, @c NULL.
* @return A new uninitialised Evas canvas on success. Otherwise, @c
* NULL.
* @ingroup Evas_Canvas
*/
EAPI Evas *
@ -206,8 +230,8 @@ evas_free(Evas *e)
/**
* @defgroup Evas_Output_Method Evas Render Engine Functions
*
* Functions that are used to set the render engine for a given function, and
* then get that engine working.
* Functions that are used to set the render engine for a given
* function, and then get that engine working.
*
* The following code snippet shows how they can be used to
* initialise an evas that uses the X11 software engine:
@ -293,8 +317,9 @@ evas_output_method_get(const Evas *e)
/**
* Retrieves the current render engine info struct from the given evas.
*
* The returned structure is publicly modifiable. The contents are valid
* until either @ref evas_engine_info_set or @ref evas_render are called.
* The returned structure is publicly modifiable. The contents are
* valid until either @ref evas_engine_info_set or @ref evas_render
* are called.
*
* This structure does not need to be freed by the caller.
*
@ -354,9 +379,11 @@ evas_engine_info_set(Evas *e, Evas_Engine_Info *info)
}
/**
* @defgroup Evas_Output_Size Evas Output and Viewport Resizing Functions
* @defgroup Evas_Output_Size Evas Output and Viewport Resizing
* Functions
*
* Functions that set and retrieve the output and viewport size of an evas.
* Functions that set and retrieve the output and viewport size of an
* evas.
*/
/**
@ -422,9 +449,9 @@ evas_output_size_get(const Evas *e, int *w, int *h)
/**
* Sets the output viewport of the given evas in evas units.
*
* The output viewport is the area of the evas that will be visible to the
* viewer. The viewport will be stretched to fit the output target of the
* evas when rendering is performed.
* The output viewport is the area of the evas that will be visible to
* the viewer. The viewport will be stretched to fit the output
* target of the evas when rendering is performed.
*
* @note The coordinate values do not have to map 1-to-1 with the output
* target. However, it is generally advised that it is done for ease
@ -472,11 +499,12 @@ evas_output_viewport_set(Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas
* @param h The pointer to a height variable to be filled in
* @ingroup Evas_Output_Size
*
* Calling this function writes the current canvas output viewport size and
* location values into the variables pointed to by @p x, @p y, @p w and @p h.
* On success the variables have the output location and size values written to
* them in canvas units. Any of @p x, @p y, @p w or @p h that are NULL will not
* be written to. If @p e is invalid, the results are undefined.
* Calling this function writes the current canvas output viewport
* size and location values into the variables pointed to by @p x, @p
* y, @p w and @p h. On success the variables have the output
* location and size values written to them in canvas units. Any of @p
* x, @p y, @p w or @p h that are NULL will not be written to. If @p e
* is invalid, the results are undefined.
*
* Example:
* @code
@ -504,7 +532,8 @@ evas_output_viewport_get(const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord
}
/**
* @defgroup Evas_Coord_Mapping_Group Evas Coordinate Mapping Functions
* @defgroup Evas_Coord_Mapping_Group Evas Coordinate Mapping
* Functions
*
* Functions that are used to map coordinates from the canvas to the
* screen or the screen to the canvas.
@ -518,10 +547,10 @@ evas_output_viewport_get(const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord
* @return The screen co-ordinate translated to canvas unit co-ordinates
* @ingroup Evas_Coord_Mapping_Group
*
* This function takes in a horizontal co-ordinate as the @p x parameter and
* converts it into canvas units, accounting for output size, viewport size
* and location, returning it as the function return value. If @p e is
* invalid, the results are undefined.
* This function takes in a horizontal co-ordinate as the @p x
* parameter and converts it into canvas units, accounting for output
* size, viewport size and location, returning it as the function
* return value. If @p e is invalid, the results are undefined.
*
* Example:
* @code
@ -550,10 +579,10 @@ evas_coord_screen_x_to_world(const Evas *e, int x)
* @return The screen co-ordinate translated to canvas unit co-ordinates
* @ingroup Evas_Coord_Mapping_Group
*
* This function takes in a vertical co-ordinate as the @p y parameter and
* converts it into canvas units, accounting for output size, viewport size
* and location, returning it as the function return value. If @p e is
* invalid, the results are undefined.
* This function takes in a vertical co-ordinate as the @p y parameter
* and converts it into canvas units, accounting for output size,
* viewport size and location, returning it as the function return
* value. If @p e is invalid, the results are undefined.
*
* Example:
* @code
@ -582,10 +611,10 @@ evas_coord_screen_y_to_world(const Evas *e, int y)
* @return The output/screen co-ordinate translated to output co-ordinates
* @ingroup Evas_Coord_Mapping_Group
*
* This function takes in a horizontal co-ordinate as the @p x parameter and
* converts it into output units, accounting for output size, viewport size
* and location, returning it as the function return value. If @p e is
* invalid, the results are undefined.
* This function takes in a horizontal co-ordinate as the @p x
* parameter and converts it into output units, accounting for output
* size, viewport size and location, returning it as the function
* return value. If @p e is invalid, the results are undefined.
*
* Example:
* @code
@ -614,10 +643,10 @@ evas_coord_world_x_to_screen(const Evas *e, Evas_Coord x)
* @return The output/screen co-ordinate translated to output co-ordinates
* @ingroup Evas_Coord_Mapping_Group
*
* This function takes in a vertical co-ordinate as the @p x parameter and
* converts it into output units, accounting for output size, viewport size
* and location, returning it as the function return value. If @p e is
* invalid, the results are undefined.
* This function takes in a vertical co-ordinate as the @p x parameter
* and converts it into output units, accounting for output size,
* viewport size and location, returning it as the function return
* value. If @p e is invalid, the results are undefined.
*
* Example:
* @code
@ -645,15 +674,17 @@ evas_coord_world_y_to_screen(const Evas *e, Evas_Coord y)
* @return A numeric (opaque) ID for the rendering engine
* @ingroup Evas_Output_Method
*
* This function looks up a numeric return value for the named engine in the
* string @p name. This is a normal C string, NUL byte terminated. The name
* is case sensitive. If the rendering engine is available, a numeric ID for
* that engine is returned that is not 0. If the engine is not available, 0
* is returned, indicating an invalid engine.
* This function looks up a numeric return value for the named engine
* in the string @p name. This is a normal C string, NUL byte
* terminated. The name is case sensitive. If the rendering engine is
* available, a numeric ID for that engine is returned that is not
* 0. If the engine is not available, 0 is returned, indicating an
* invalid engine.
*
* The programmer should NEVER rely on the numeric ID of an engine unless it is
* returned by this function. Programs should NOT be written accessing render
* method ID's directly, without first obtaining it from this function.
* The programmer should NEVER rely on the numeric ID of an engine
* unless it is returned by this function. Programs should NOT be
* written accessing render method ID's directly, without first
* obtaining it from this function.
*
* Example:
* @code
@ -694,13 +725,13 @@ evas_render_method_lookup(const char *name)
* @return A linked list whose data members are C strings of engine names
* @ingroup Evas_Output_Method
*
* Calling this will return a handle (pointer) to an Evas linked list. Each node
* in the linked list will have the data pointer be a (char *) pointer to the
* string name of the rendering engine available. The strings should never be
* modified, neither should the list be modified. This list should be cleaned up
* as soon as the program no longer needs it using
* evas_render_method_list_free(). If no engines are available from Evas, NULL
* will be returned.
* Calling this will return a handle (pointer) to an Evas linked
* list. Each node in the linked list will have the data pointer be a
* (char *) pointer to the string name of the rendering engine
* available. The strings should never be modified, neither should the
* list be modified. This list should be cleaned up as soon as the
* program no longer needs it using evas_render_method_list_free(). If
* no engines are available from Evas, NULL will be returned.
*
* Example:
* @code
@ -789,9 +820,10 @@ evas_render_method_list(void)
* @param list The Eina_List base pointer for the engine list to be freed
* @ingroup Evas_Output_Method
*
* When this function is called it will free the engine list passed in as
* @p list. The list should only be a list of engines generated by calling
* evas_render_method_list(). If @p list is NULL, nothing will happen.
* When this function is called it will free the engine list passed in
* as @p list. The list should only be a list of engines generated by
* calling evas_render_method_list(). If @p list is NULL, nothing will
* happen.
*
* Example:
* @code
@ -830,10 +862,10 @@ evas_render_method_list_free(Eina_List *list)
* @param y The pointer to an integer to be filled in
* @ingroup Evas_Pointer_Group
*
* This function returns the current known screen/output co-ordinates of the
* mouse pointer and sets the contents of the integers pointed to by @p x
* and @p y to contain these co-ordinates. If @p e is not a valid canvas the
* results of this function are undefined.
* This function returns the current known screen/output co-ordinates
* of the mouse pointer and sets the contents of the integers pointed
* to by @p x and @p y to contain these co-ordinates. If @p e is not a
* valid canvas the results of this function are undefined.
*
* Example:
* @code
@ -864,10 +896,10 @@ evas_pointer_output_xy_get(const Evas *e, int *x, int *y)
* @param y The pointer to a Evas_Coord to be filled in
* @ingroup Evas_Pointer_Group
*
* This function returns the current known canvas unit co-ordinates of the
* mouse pointer and sets the contents of the Evas_Coords pointed to by @p x
* and @p y to contain these co-ordinates. If @p e is not a valid canvas the
* results of this function are undefined.
* This function returns the current known canvas unit co-ordinates of
* the mouse pointer and sets the contents of the Evas_Coords pointed
* to by @p x and @p y to contain these co-ordinates. If @p e is not a
* valid canvas the results of this function are undefined.
*
* Example:
* @code
@ -897,19 +929,20 @@ evas_pointer_canvas_xy_get(const Evas *e, Evas_Coord *x, Evas_Coord *y)
* @return A bitmask of the currently depressed buttons on the cavas
* @ingroup Evas_Pointer_Group
*
* Calling this function will return a 32-bit integer with the appropriate bits
* set to 1 that correspond to a mouse button being depressed. This limits
* Evas to a mouse devices with a maximum of 32 buttons, but that is generally
* in excess of any host system's pointing device abilities.
* Calling this function will return a 32-bit integer with the
* appropriate bits set to 1 that correspond to a mouse button being
* depressed. This limits Evas to a mouse devices with a maximum of 32
* buttons, but that is generally in excess of any host system's
* pointing device abilities.
*
* A canvas by default begins with no mouse buttons being pressed and only
* calls to evas_event_feed_mouse_down(), evas_event_feed_mouse_down_data(),
* evas_event_feed_mouse_up() and evas_event_feed_mouse_up_data() will alter
* that.
* A canvas by default begins with no mouse buttons being pressed and
* only calls to evas_event_feed_mouse_down(),
* evas_event_feed_mouse_down_data(), evas_event_feed_mouse_up() and
* evas_event_feed_mouse_up_data() will alter that.
*
* The least significant bit corresponds to the first mouse button (button 1)
* and the most significant bit corresponds to the last mouse button
* (button 32).
* The least significant bit corresponds to the first mouse button
* (button 1) and the most significant bit corresponds to the last
* mouse button (button 32).
*
* If @p e is not a valid canvas, the return value is undefined.
*
@ -942,13 +975,14 @@ evas_pointer_button_down_mask_get(const Evas *e)
* @return An integer that is 1 if the mouse is inside the canvas, 0 otherwise
* @ingroup Evas_Pointer_Group
*
* When this function is called it will return a value of either 0 or 1,
* depending on if evas_event_feed_mouse_in(), evas_event_feed_mouse_in_data(),
* or evas_event_feed_mouse_out(), evas_event_feed_mouse_out_data() have been
* called to feed in a mouse enter event into the canvas.
* When this function is called it will return a value of either 0 or
* 1, depending on if evas_event_feed_mouse_in(),
* evas_event_feed_mouse_in_data(), or evas_event_feed_mouse_out(),
* evas_event_feed_mouse_out_data() have been called to feed in a
* mouse enter event into the canvas.
*
* A return value of 1 indicates the mouse is logically inside the canvas, and
* 0 implies it is logically outside the canvas.
* A return value of 1 indicates the mouse is logically inside the
* canvas, and 0 implies it is logically outside the canvas.
*
* A canvas begins with the mouse being assumed outside (0).
*

2
legacy/evas/src/lib/canvas/evas_object_box.c
View File

@ -1966,7 +1966,7 @@ evas_object_box_prepend(Evas_Object *o, Evas_Object *child)
}
/**
* Prepend a new object @child to the box @o relative to element @a
* Prepend a new object @a child to the box @c o relative to element @a
* reference. If @a reference is not contained in the box or any other
* error occurs, @c NULL is returned.
*/

80
legacy/evas/src/lib/canvas/evas_object_gradient.c
View File

@ -711,8 +711,19 @@ evas_object_gradient_type_get(const Evas_Object *obj, char **name, char **params
*/
/**
FIXME: ...
**/
* Convert a given color from HSV to RGB format.
*
* @param h The Hue component of the color.
* @param s The Saturation component of the color.
* @param v The Value component of the color.
* @param r The Red component of the color.
* @param g The Green component of the color.
* @param b The Blue component of the color.
*
* This function converts a given color in HSV color format to RGB
* color format.
*
**/
EAPI void
evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int *b)
{
@ -720,8 +731,19 @@ evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int *b)
}
/**
FIXME: ...
**/
* Convert a given color from RGB to HSV format.
*
* @param r The Red component of the color.
* @param g The Green component of the color.
* @param b The Blue component of the color.
* @param h The Hue component of the color.
* @param s The Saturation component of the color.
* @param v The Value component of the color.
*
* This function converts a given color in RGB color format to HSV
* color format.
*
**/
EAPI void
evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float *v)
{
@ -729,8 +751,17 @@ evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float *v)
}
/**
FIXME: ...
**/
* Pre-multiplies a rgb triplet by an alpha factor.
*
* @param a The alpha factor.
* @param r The Red component of the color.
* @param g The Green component of the color.
* @param b The Blue component of the color.
*
* This function pre-multiplies a given rbg triplet by an alpha
* factor. Alpha factor is used to define transparency.
*
**/
EAPI void
evas_color_argb_premul(int a, int *r, int *g, int *b)
{
@ -738,8 +769,19 @@ evas_color_argb_premul(int a, int *r, int *g, int *b)
}
/**
FIXME: ...
**/
* Undo pre-multiplication of a rgb triplet by an alpha factor.
*
* @param a The alpha factor.
* @param r The Red component of the color.
* @param g The Green component of the color.
* @param b The Blue component of the color.
*
* This function undoes pre-multiplication a given rbg triplet by an
* alpha factor. Alpha factor is used to define transparency.
*
* @see evas_color_argb_premul().
*
**/
EAPI void
evas_color_argb_unpremul(int a, int *r, int *g, int *b)
{
@ -747,8 +789,15 @@ evas_color_argb_unpremul(int a, int *r, int *g, int *b)
}
/**
FIXME: ...
**/
* Pre-multiplies data by an alpha factor.
*
* @param data The data value.
* @param len The lenght value.
*
* This function pre-multiplies a given data by an alpha
* factor. Alpha factor is used to define transparency.
*
**/
EAPI void
evas_data_argb_premul(unsigned int *data, unsigned int len)
{
@ -757,8 +806,15 @@ evas_data_argb_premul(unsigned int *data, unsigned int len)
}
/**
FIXME: ...
**/
* Undo pre-multiplication data by an alpha factor.
*
* @param data The data value.
* @param len The lenght value.
*
* This function undoes pre-multiplication of a given data by an alpha
* factor. Alpha factor is used to define transparency.
*
**/
EAPI void
evas_data_argb_unpremul(unsigned int *data, unsigned int len)
{

2
legacy/evas/src/lib/canvas/evas_object_gradient2.c
View File

@ -140,6 +140,7 @@ evas_object_gradient2_fill_spread_get(const Evas_Object *obj)
return og->cur.fill.spread;
}
/* FIXME: To be documented*/
EAPI void
evas_object_gradient2_fill_transform_set (Evas_Object *obj, Evas_Transform *t)
{
@ -193,6 +194,7 @@ evas_object_gradient2_fill_transform_set (Evas_Object *obj, Evas_Transform *t)
evas_object_change(obj);
}
/* FIXME: To be documented*/
EAPI void
evas_object_gradient2_fill_transform_get (const Evas_Object *obj, Evas_Transform *t)
{

1
legacy/evas/src/lib/canvas/evas_object_gradient2_linear.c
View File

@ -140,6 +140,7 @@ evas_object_gradient2_linear_fill_set(Evas_Object *obj, float x0, float y0, floa
evas_object_change(obj);
}
/*FIXME: To be documented*/
EAPI void
evas_object_gradient2_linear_fill_get(const Evas_Object *obj, float *x0, float *y0, float *x1, float *y1)
{

350
legacy/evas/src/lib/canvas/evas_object_image.c
View File

@ -121,45 +121,50 @@ static const Evas_Object_Func object_func =
*
* Functions used to create and manipulate image objects.
*
* Note - Image objects may return or accept "image data" in multiple formats.
* This is based on the colorspace of an object. Here is a rundown on formats:
* Note - Image objects may return or accept "image data" in multiple
* formats. This is based on the colorspace of an object. Here is a
* rundown on formats:
*
* EVAS_COLORSPACE_ARGB8888:
*
* This pixel format is a linear block of pixels, starting at the top-left row
* by row until the bottom right of the image or pixel region. All pixels are
* 32-bit unsigned int's with the high-byte being alpha and the low byte being
* blue in the format ARGB. Alpha may or may not be used by evas depending on
* the alpha flag of the image, but if not used, should be set to 0xff anyway.
* This pixel format is a linear block of pixels, starting at the
* top-left row by row until the bottom right of the image or pixel
* region. All pixels are 32-bit unsigned int's with the high-byte
* being alpha and the low byte being blue in the format ARGB. Alpha
* may or may not be used by evas depending on the alpha flag of the
* image, but if not used, should be set to 0xff anyway.
*
* This colorspace uses premultiplied alpha. That means that R, G and B cannot
* exceed A in value. The conversion from non-premultiplied colorspace is:
* This colorspace uses premultiplied alpha. That means that R, G and
* B cannot exceed A in value. The conversion from non-premultiplied
* colorspace is:
*
* R = (r * a) / 255; G = (g * a) / 255; B = (b * a) / 255;
*
* So 50% transparent blue will be: 0x80000080. This will not be "dark" - just
* 50% transparent. Values are 0 == black, 255 == solid or full red, green or
* blue.
* So 50% transparent blue will be: 0x80000080. This will not be
* "dark" - just 50% transparent. Values are 0 == black, 255 == solid
* or full red, green or blue.
*
* EVAS_COLORSPACE_YCBCR422P601_PL:
*
* This is a pointer-list indirected set of YUV (YCbCr) pixel data. This means
* that the data returned or set is not actual pixel data, but pointers TO
* lines of pixel data. The list of pointers will first be N rows of pointers
* to the Y plane - pointing to the first pixel at the start of each row in
* the Y plane. N is the height of the image data in pixels. Each pixel in the
* Y, U and V planes is 1 byte exactly, packed. The next N / 2 pointers will
* point to rows in the U plane, and the next N / 2 pointers will point to
* the V plane rows. U and V planes are half the horizontal and vertical
* resolution of the U plane.
* This is a pointer-list indirected set of YUV (YCbCr) pixel
* data. This means that the data returned or set is not actual pixel
* data, but pointers TO lines of pixel data. The list of pointers
* will first be N rows of pointers to the Y plane - pointing to the
* first pixel at the start of each row in the Y plane. N is the
* height of the image data in pixels. Each pixel in the Y, U and V
* planes is 1 byte exactly, packed. The next N / 2 pointers will
* point to rows in the U plane, and the next N / 2 pointers will
* point to the V plane rows. U and V planes are half the horizontal
* and vertical resolution of the Y plane.
*
* Row order is top to bottom and row pixels are stored left to right.
*
* There is a limitation that these images MUST be a multiple of 2 pixels in
* size horizontally or vertically. This is due to the U and V planes being
* half resolution. Also note that this assumes the itu601 YUV colorspace
* specification. This is defined for standard television and mpeg streams.
* HDTV may use the itu709 specification.
* There is a limitation that these images MUST be a multiple of 2
* pixels in size horizontally or vertically. This is due to the U and
* V planes being half resolution. Also note that this assumes the
* itu601 YUV colorspace specification. This is defined for standard
* television and mpeg streams. HDTV may use the itu709
* specification.
*
* Values are 0 to 255, indicating full or no signal in that plane
* respectively.
@ -172,22 +177,25 @@ static const Evas_Object_Func object_func =
*
* In the process of being implemented in 1 engine only. This may change.
*
* This is a pointer to image data for 16-bit half-word pixel data in 16bpp
* RGB 565 format (5 bits red, 6 bits green, 5 bits blue), with the high-byte
* containing red and the low byte containing blue, per pixel. This data is
* packed row by row from the top-left to the bottom right.
* This is a pointer to image data for 16-bit half-word pixel data in
* 16bpp RGB 565 format (5 bits red, 6 bits green, 5 bits blue), with
* the high-byte containing red and the low byte containing blue, per
* pixel. This data is packed row by row from the top-left to the
* bottom right.
*
* If the image has an alpha channel enabled there will be an extra alpha plane
* after the color pixel plane. If not, then this data will not exist and
* should not be accessed in any way. This plane is a set of pixels with 1
* byte per pixel defining the alpha values of all pixels in the image from
* the top-left to the bottom right of the image, row by row. Even though
* the values of the alpha pixels can be 0 to 255, only values 0 through to 32
* are used, 32 being solid and 0 being transparent.
* If the image has an alpha channel enabled there will be an extra
* alpha plane after the color pixel plane. If not, then this data
* will not exist and should not be accessed in any way. This plane is
* a set of pixels with 1 byte per pixel defining the alpha values of
* all pixels in the image from the top-left to the bottom right of
* the image, row by row. Even though the values of the alpha pixels
* can be 0 to 255, only values 0 through to 32 are used, 32 being
* solid and 0 being transparent.
*
* RGB values can be 0 to 31 for red and blue and 0 to 63 for green, with 0
* being black and 31 or 63 being full red, green or blue respectively. This
* colorspace is also pre-multiplied like EVAS_COLORSPACE_ARGB8888 so:
* RGB values can be 0 to 31 for red and blue and 0 to 63 for green,
* with 0 being black and 31 or 63 being full red, green or blue
* respectively. This colorspace is also pre-multiplied like
* EVAS_COLORSPACE_ARGB8888 so:
*
* R = (r * a) / 32; G = (g * a) / 32; B = (b * a) / 32;
*/
@ -245,9 +253,8 @@ evas_object_image_filled_add(Evas *e)
/**
* Sets the filename and key of the given image object.
*
* If the file supports multiple data stored in it as eet,
* you can specify the key to be used as the index of the
* image in this file.
* If the file supports multiple data stored in it as eet, you can
* specify the key to be used as the index of the image in this file.
*
* @param obj The given image object.
* @param file The image filename.
@ -369,8 +376,8 @@ evas_object_image_file_get(const Evas_Object *obj, const char **file, const char
* to be scaled.
*
* When rendering, the image may be scaled to fit the size of the
* image object. This function sets what area around the border of
* the image is not to be scaled. This sort of function is useful for
* image object. This function sets what area around the border of the
* image is not to be scaled. This sort of function is useful for
* widget theming, where, for example, buttons may be of varying
* sizes, but the border size must remain constant.
*
@ -411,8 +418,8 @@ evas_object_image_border_set(Evas_Object *obj, int l, int r, int t, int b)
}
/**
* Retrieves how much of each border of the given image object is not to
* be scaled.
* Retrieves how much of each border of the given image object is not
* to be scaled.
*
* See @ref evas_object_image_border_set for more details.
*
@ -453,9 +460,9 @@ evas_object_image_border_get(const Evas_Object *obj, int *l, int *r, int *t, int
* should be drawn.
*
* When rendering, the image may be scaled to fit the size of the
* image object. This function sets if the center part of the scaled image
* is to be drawn or left completely blank, or forced to be solid. Very useful
* for frames and decorations.
* image object. This function sets if the center part of the scaled
* image is to be drawn or left completely blank, or forced to be
* solid. Very useful for frames and decorations.
*
* @param obj The given image object.
* @param fill Fill mode of the middle.
@ -546,8 +553,8 @@ evas_object_image_filled_set(Evas_Object *obj, Eina_Bool setting)
/**
* Retrieves if the center of the given image object is to be drawn
* or not.
* Retrieves if the center of the given image object is to be drawn or
* not.
*
* See @ref evas_object_image_fill_set for more details.
*
@ -570,12 +577,12 @@ evas_object_image_border_center_fill_get(const Evas_Object *obj)
}
/**
* Sets the rectangle of the given image object that the image will
* be drawn to.
* Sets the rectangle of the given image object that the image will be
* drawn to.
*
* Note that the image will be tiled around this one rectangle. To have
* only one copy of the image drawn, @p x and @p y must be 0 and @p w
* and @p h need to be the width and height of the image object
* Note that the image will be tiled around this one rectangle. To
* have only one copy of the image drawn, @p x and @p y must be 0 and
* @p w and @p h need to be the width and height of the image object
* respectively.
*
* The default values for the fill parameters is @p x = 0, @p y = 0,
@ -679,7 +686,9 @@ evas_object_image_fill_spread_set(Evas_Object *obj, int spread)
}
/**
* Retrieves the spread (tiling mode) for the given image object's fill.
* Retrieves the spread (tiling mode) for the given image object's
* fill.
*
* @param obj The given evas image object.
* @return The current spread mode of the image object.
*/
@ -751,6 +760,7 @@ evas_object_image_fill_transform_set (Evas_Object *obj, Evas_Transform *t)
evas_object_change(obj);
}
/*FIXME: To be documented*/
EAPI void
evas_object_image_fill_transform_get (const Evas_Object *obj, Evas_Transform *t)
{
@ -919,9 +929,9 @@ evas_object_image_load_error_get(const Evas_Object *obj)
* Converts the raw image data of the given image object to the
* specified colorspace.
*
* Note that this function does not modify the raw image data.
* If the requested colorspace is the same as the image colorspace
* nothing is done and NULL is returned. You should use
* Note that this function does not modify the raw image data. If the
* requested colorspace is the same as the image colorspace nothing is
* done and NULL is returned. You should use
* evas_object_image_colorspace_get() to check the current image
* colorspace.
*
@ -957,8 +967,8 @@ evas_object_image_data_convert(Evas_Object *obj, Evas_Colorspace to_cspace)
/**
* Sets the raw image data of the given image object.
*
* Note that the raw data must be of the same size and colorspace
* of the image. If data is NULL the current image data will be freed.
* Note that the raw data must be of the same size and colorspace of
* the image. If data is NULL the current image data will be freed.
*
* @param obj The given image object.
* @param data The raw data, or NULL.
@ -1021,9 +1031,10 @@ evas_object_image_data_set(Evas_Object *obj, void *data)
/**
* Get a pointer to the raw image data of the given image object.
*
* This function returns a pointer to an image object's internal pixel buffer,
* for reading only or read/write. If you request it for writing, the image
* will be marked dirty so that it gets redrawn at the next update.
* This function returns a pointer to an image object's internal pixel
* buffer, for reading only or read/write. If you request it for
* writing, the image will be marked dirty so that it gets redrawn at
* the next update.
*
* This is best suited when you want to modify an existing image,
* without changing its dimensions.
@ -1063,8 +1074,8 @@ evas_object_image_data_get(const Evas_Object *obj, Eina_Bool for_writing)
/**
* Preload image in the background
*
* This function request the preload of the data image in the background. The
* worked is queued before being processed.
* This function request the preload of the data image in the
* background. The worked is queued before being processed.
*
* If image data is already loaded, it will callback
* EVAS_CALLBACK_IMAGE_PRELOADED immediatelly and do nothing else.
@ -1104,19 +1115,19 @@ evas_object_image_preload(Evas_Object *obj, Eina_Bool cancel)
/**
* Replaces the raw image data of the given image object.
*
* This function lets the application replace an image object's internal pixel
* buffer with a user-allocated one. For best results, you should generally
* first call evas_object_image_size_set() with the width and height for the
* new buffer.
* This function lets the application replace an image object's
* internal pixel buffer with a user-allocated one. For best results,
* you should generally first call evas_object_image_size_set() with
* the width and height for the new buffer.
*
* This call is best suited for when you will be using image data with
* different dimensions than the existing image data, if any. If you only need
* to modify the existing image in some fashion, then using
* different dimensions than the existing image data, if any. If you
* only need to modify the existing image in some fashion, then using
* evas_object_image_data_get() is probably what you are after.
*
* Note that the caller is responsible for freeing the buffer when finished
* with it, as user-set image data will not be automatically freed when the
* image object is deleted.
* Note that the caller is responsible for freeing the buffer when
* finished with it, as user-set image data will not be automatically
* freed when the image object is deleted.
*
* See @ref evas_object_image_data_get for more details.
*
@ -1191,11 +1202,11 @@ evas_object_image_data_update_add(Evas_Object *obj, int x, int y, int w, int h)
/**
* Enable or disable alpha channel of the given image object.
*
* This function sets a flag on an image object indicating whether or not to
* use alpha channel data. A value of 1 indicates to use alpha channel data,
* and 0 indicates to ignore any alpha channel data. Note that this has
* nothing to do with an object's color as manipulated by
* evas_object_color_set().
* This function sets a flag on an image object indicating whether or
* not to use alpha channel data. A value of 1 indicates to use alpha
* channel data, and 0 indicates to ignore any alpha channel
* data. Note that this has nothing to do with an object's color as
* manipulated by evas_object_color_set().
*
* @param obj The given image object.
* @param has_alpha Whether to use alpha channel data or not.
@ -1226,15 +1237,15 @@ evas_object_image_alpha_set(Evas_Object *obj, Eina_Bool has_alpha)
/**
* Retrieves the alpha channel setting of the given image object.
*
* This function returns 1 if the image object's alpha channel is being used,
* or 0 otherwise.
*
* See @ref evas_object_image_alpha_set for more details.
* @brief Retrieves the alpha channel setting of the given image object.
*
* @param obj The given image object.
* @return Whether the alpha channel data is being used.
*
* This function returns 1 if the image object's alpha channel is
* being used, or 0 otherwise.
*
* See @ref evas_object_image_alpha_set for more details.
*/
EAPI Eina_Bool
evas_object_image_alpha_get(const Evas_Object *obj)
@ -1255,9 +1266,9 @@ evas_object_image_alpha_get(const Evas_Object *obj)
* Sets whether to use of high-quality image scaling algorithm
* of the given image object.
*
* When enabled, a higher quality image scaling algorithm is used when scaling
* images to sizes other than the source image. This gives better results but
* is more computationally expensive.
* When enabled, a higher quality image scaling algorithm is used when
* scaling images to sizes other than the source image. This gives
* better results but is more computationally expensive.
*
* @param obj The given image object.
* @param smooth_scale Whether to use smooth scale or not.
@ -1283,8 +1294,8 @@ evas_object_image_smooth_scale_set(Evas_Object *obj, Eina_Bool smooth_scale)
}
/**
* Retrieves whether the given image object is using use a high-quality
* image scaling algorithm.
* Retrieves whether the given image object is using use a
* high-quality image scaling algorithm.
*
* See @ref evas_object_image_smooth_scale_set for more details.
*
@ -1307,9 +1318,11 @@ evas_object_image_smooth_scale_get(const Evas_Object *obj)
}
/**
* To be documented.
* Reload a image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given image object pointer.
*
* This function reloads a image of the given canvas.
*
*/
EAPI void
@ -1339,14 +1352,13 @@ evas_object_image_reload(Evas_Object *obj)
/**
* Save the given image object to a file.
*
* Note that you should pass the filename extension when saving.
* If the file supports multiple data stored in it as eet,
* you can specify the key to be used as the index of the
* image in this file.
* Note that you should pass the filename extension when saving. If
* the file supports multiple data stored in it as eet, you can
* specify the key to be used as the index of the image in this file.
*
* You can specify some flags when saving the image.
* Currently acceptable flags are quality and compress.
* Eg.: "quality=100 compress=9"
* You can specify some flags when saving the image. Currently
* acceptable flags are quality and compress. Eg.: "quality=100
* compress=9"
*
* @param obj The given image object.
* @param file The filename to be used to save the image.
@ -1420,9 +1432,12 @@ evas_object_image_save(const Evas_Object *obj, const char *file, const char *key
}
/**
* To be documented.
* Import pixels from given source to a given canvas image object.
*
* FIXME: To be fixed.
* @param obj The given canvas object.
* @param pixels The pixel's source to be imported.
*
* This function imports pixels from a given source to a given canvas image.
*
*/
EAPI Eina_Bool
@ -1512,9 +1527,14 @@ evas_object_image_pixels_import(Evas_Object *obj, Evas_Pixel_Import_Source *pixe
}
/**
* To be documented.
* Set the callback function to get pixels from a canva's image.
*
* FIXME: To be fixed.
* @param obj The given canvas pointer.
* @param func The callback function.
* @param data The data pointer to be passed to @a func.
*
* This functions sets a function to be the callback function that get
* pixes from a image of the canvas.
*
*/
EAPI void
@ -1580,9 +1600,12 @@ evas_object_image_pixels_dirty_get(const Evas_Object *obj)
}
/**
* To be documented.
* Set the dpi resolution of a loaded image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given canvas pointer.
* @param dpi The new dpi resolution.
*
* This function set the dpi resolution of a given loaded canvas image.
*
*/
EAPI void
@ -1609,9 +1632,12 @@ evas_object_image_load_dpi_set(Evas_Object *obj, double dpi)
}
/**
* To be documented.
* Get the dpi resolution of a loaded image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given canvas pointer.
* @return The dpi resolution of the given canvas image.
*
* This function returns the dpi resolution of given canvas image.
*
*/
EAPI double
@ -1630,9 +1656,13 @@ evas_object_image_load_dpi_get(const Evas_Object *obj)
}
/**
* To be documented.
* Set the size of a loaded image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given canvas object.
* @param w The new width of the canvas image given.
* @param h Th new height of the canvas image given.
*
* This function sets a new size for the given canvas image.
*
*/
EAPI void
@ -1659,6 +1689,16 @@ evas_object_image_load_size_set(Evas_Object *obj, int w, int h)
}
}
/**
* Get the size of a loaded image of the canvas.
*
* @param obj The given canvas object.
* @param w The width of the canvas image given.
* @param h The height of the canvas image given.
*
* This function get the size of the given canvas image.
*
*/
EAPI void
evas_object_image_load_size_get(const Evas_Object *obj, int *w, int *h)
{
@ -1676,9 +1716,12 @@ evas_object_image_load_size_get(const Evas_Object *obj, int *w, int *h)
}
/**
* To be documented.
* Set the scale down of a loaded image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given canvas pointer.
* @param scale_down The scale to down value.
*
* This function sets the scale down of a given canvas image.
*
*/
EAPI void
@ -1705,9 +1748,11 @@ evas_object_image_load_scale_down_set(Evas_Object *obj, int scale_down)
}
/**
* To be documented.
* Get the scale down value of given image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given image object pointer.
*
* This function returns the scale down value of a given canvas image.
*
*/
EAPI int
@ -1725,12 +1770,6 @@ evas_object_image_load_scale_down_get(const Evas_Object *obj)
return o->load_opts.scale_down_by;
}
/**
* To be documented.
*
* FIXME: To be fixed.
*
*/
EAPI void
evas_object_image_load_region_set(Evas_Object *obj, int x, int y, int w, int h)
{
@ -1777,9 +1816,12 @@ evas_object_image_load_region_get(const Evas_Object *obj, int *x, int *y, int *w
}
/**
* To be documented.
* Set the colorspace of a given image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given image object pointer.
* @param cspace The new color space.
*
* This function sets the colorspace of given canvas image.
*
*/
EAPI void
@ -1802,9 +1844,12 @@ evas_object_image_colorspace_set(Evas_Object *obj, Evas_Colorspace cspace)
}
/**
* To be documented.
* Get the colorspace of a given image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given image object pointer.
* @return The colorspace of the image.
*
* This function returns the colorspace of given canvas image.
*
*/
EAPI Evas_Colorspace
@ -1823,9 +1868,12 @@ evas_object_image_colorspace_get(const Evas_Object *obj)
}
/**
* To be documented.
* Set the native surface of a given image of the canvas
*
* FIXME: To be fixed.
* @param obj The given canvas pointer.
* @param surf The new native surface.
*
* This function sets a native surface of a given canvas image.
*
*/
EAPI void
@ -1846,9 +1894,12 @@ evas_object_image_native_surface_set(Evas_Object *obj, Evas_Native_Surface *surf
}
/**
* To be documented.
* Get the native surface of a given image of the canvas
*
* FIXME: To be fixed.
* @param obj The given canvas pointer.
* @return The native surface of the given canvas image.
*
* This function returns the native surface of a given canvas image.
*
*/
EAPI Evas_Native_Surface *
@ -1868,9 +1919,12 @@ evas_object_image_native_surface_get(const Evas_Object *obj)
}
/**
* To be documented.
* Set the scale hint of a given image of the canvas.
*
* FIXME: To be fixed.
* @param obj The given canvas pointer.
* @param hint The scale hint value.
*
* This function sets the scale hint value of the given image of the canvas.
*
*/
EAPI void
@ -1888,6 +1942,14 @@ evas_object_image_scale_hint_set(Evas_Object *obj, Evas_Image_Scale_Hint hint)
o->scale_hint = hint;
}
/**
* Get the scale hint of a given image of the canvas.
*
* @param obj The given canvas pointer.
*
* This function returns the scale hint value of the given image of the canvas.
*
*/
EAPI Evas_Image_Scale_Hint
evas_object_image_scale_hint_get(const Evas_Object *obj)
{
@ -1904,9 +1966,11 @@ evas_object_image_scale_hint_get(const Evas_Object *obj)
}
/**
* To be documented.
* Flush the image cache of the canvas.
*
* FIXME: To be fixed.
* @param e The given evas pointer.
*
* This function flushes image cache of canvas.
*
*/
EAPI void
@ -1920,10 +1984,11 @@ evas_image_cache_flush(Evas *e)
}
/**
* To be documented.
* Reload the image cache
*
* FIXME: To be fixed.
* @param e The given evas pointer.
*
* This function reloads the image cache of canvas.
*/
EAPI void
evas_image_cache_reload(Evas *e)
@ -1972,9 +2037,12 @@ evas_image_cache_reload(Evas *e)
}
/**
* To be documented.
* Set the image cache.
*
* FIXME: To be fixed.
* @param e The given evas pointer.
* @param size The cache size.
*
* This function sets the image cache of canvas.
*
*/
EAPI void
@ -1989,9 +2057,11 @@ evas_image_cache_set(Evas *e, int size)
}
/**
* To be documented.
* Set the image cache
*
* FIXME: To be fixed.
* @param e The given evas pointer.
*
* This function returns the image cache of canvas.
*
*/
EAPI int

66
legacy/evas/src/lib/canvas/evas_object_intercept.c
View File

@ -240,9 +240,16 @@ evas_object_intercept_call_clip_unset(Evas_Object *obj)
/* public calls */
/**
* To be documented.
* Set the callback function that intercepts a show event of a object.
*
* FIXME: To be fixed.
* @param obj The given canvas object pointer.
* @param func The given function to be the callback function.
* @param data The data passed to the callback fucntion.
*
* This function sets a callback function to intercepts a show event
* of a canvas object.
*
* @see evas_object_intercept_show_callback_del().
*
*/
EAPI void
@ -261,9 +268,16 @@ evas_object_intercept_show_callback_add(Evas_Object *obj, void (*func) (void *da
}
/**
* To be documented.
* Unset the callback function that intercepts a show event of a
* object.
*
* FIXME: To be fixed.
* @param obj The given canvas object pointer.
* @param func The given callback function.
*
* This function sets a callback function to intercepts a show event
* of a canvas object.
*
* @see evas_object_intercept_show_callback_add().
*
*/
EAPI void *
@ -285,9 +299,16 @@ evas_object_intercept_show_callback_del(Evas_Object *obj, void (*func) (void *da
}
/**
* To be documented.
* Set the callback function that intercepts a hide event of a object.
*
* FIXME: To be fixed.
* @param obj The given canvas object pointer.
* @param func The given function to be the callback function.
* @param data The data passed to the callback fucntion.
*
* This function sets a callback function to intercepts a hide event
* of a canvas object.
*
* @see evas_object_intercept_hide_callback_del().
*
*/
EAPI void
@ -305,9 +326,16 @@ evas_object_intercept_hide_callback_add(Evas_Object *obj, void (*func) (void *da
}
/**
* To be documented.
* Unset the callback function that intercepts a hide event of a
* object.
*
* FIXME: To be fixed.
* @param obj The given canvas object pointer.
* @param func The given callback function.
*
* This function sets a callback function to intercepts a hide event
* of a canvas object.
*
* @see evas_object_intercept_hide_callback_add().
*
*/
EAPI void *
@ -329,9 +357,16 @@ evas_object_intercept_hide_callback_del(Evas_Object *obj, void (*func) (void *da
}
/**
* To be documented.
* Set the callback function that intercepts a move event of a object.
*
* FIXME: To be fixed.
* @param obj The given canvas object pointer.
* @param func The given function to be the callback function.
* @param data The data passed to the callback fucntion.
*
* This function sets a callback function to intercepts a move event
* of a canvas object.
*
* @see evas_object_intercept_move_callback_del().
*
*/
EAPI void
@ -349,9 +384,16 @@ evas_object_intercept_move_callback_add(Evas_Object *obj, void (*func) (void *da
}
/**
* To be documented.
* Unset the callback function that intercepts a move event of a
* object.
*
* FIXME: To be fixed.
* @param obj The given canvas object pointer.
* @param func The given callback function.
*
* This function sets a callback function to intercepts a move event
* of a canvas object.
*
* @see evas_object_intercept_move_callback_add().
*
*/
EAPI void *

64
legacy/evas/src/lib/canvas/evas_object_main.c
View File

@ -1244,9 +1244,10 @@ evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a)
}
/**
* Sets whether or not the given evas object is to be drawn anti_aliased.
* Sets whether or not the given evas object is to be drawn anti-aliased.
*
* @param obj The given evas object.
* @param anti_alias. 1 if the object is to be anti_aliased, 0 otherwise.
* @param anti_alias 1 if the object is to be anti_aliased, 0 otherwise.
* @ingroup Evas_Object_Group
*/
EAPI void
@ -1281,8 +1282,9 @@ evas_object_anti_alias_get(const Evas_Object *obj)
/**
* Sets the scaling factor for an evas object. Does not affect all objects.
*
* @param obj The given evas object.
* @param scale. The scaling factor. 1.0 == none.
* @param scale The scaling factor. 1.0 == none.
* @ingroup Evas_Object_Group
*/
EAPI void
@ -1304,6 +1306,7 @@ evas_object_scale_set(Evas_Object *obj, double scale)
* Retrieves the scaling factor for the given evas object.
* @param obj The given evas object.
* @return The scaling factor.
*
* @ingroup Evas_Object_Group
*/
EAPI double
@ -1318,8 +1321,10 @@ evas_object_scale_get(const Evas_Object *obj)
/**
* Sets the color_space to be used for linear interpolation of colors.
*
* @param obj The given evas object.
* @param color_space, one of EVAS_COLOR_SPACE_ARGB or EVAS_COLOR_SPACE_AHSV.
* @param color_space one of EVAS_COLOR_SPACE_ARGB or EVAS_COLOR_SPACE_AHSV.
*
* @ingroup Evas_Object_Group
*/
EAPI void
@ -1410,9 +1415,14 @@ evas_object_evas_get(const Evas_Object *obj)
*/
/**
* To be documented.
*
* FIXME: To be fixed.
* Retrieves the top object at the given position (x,y)
* @param e The given evas object.
* @param x The horizontal coordinate
* @param y The vertical coordinate
* @param include_pass_events_objects Boolean Flag to include or not
* pass events objects
* @param include_hidden_objects Boolean Flag to include or not hidden objects
* @return The evas object that is over all others objects at the given position.
*/
EAPI Evas_Object *
evas_object_top_at_xy_get(const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
@ -1446,9 +1456,10 @@ evas_object_top_at_xy_get(const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool i
}
/**
* To be documented.
*
* FIXME: To be fixed.
* Retrieves the top object at mouse pointer position
* @param e The given evas object.
* @return The evas object that is over all others objects at the
* pointer position.
*/
EAPI Evas_Object *
evas_object_top_at_pointer_get(const Evas *e)
@ -1458,9 +1469,16 @@ evas_object_top_at_pointer_get(const Evas *e)
}
/**
* To be documented.
* Retrieves the top object in the given rectangle region
* @param e The given evas object.
* @param x The horizontal coordinate.
* @param y The vertical coordinate.
* @param w The width size.
* @param h The height size.
* @param include_pass_events_objects Boolean Flag to include or not pass events objects
* @param include_hidden_objects Boolean Flag to include or not hidden objects
* @return The evas object that is over all others objects at the pointer position.
*
* FIXME: To be fixed.
*/
EAPI Evas_Object *
evas_object_top_in_rectangle_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
@ -1500,9 +1518,15 @@ evas_object_top_in_rectangle_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas
}
/**
* To be documented.
* Retrieves the objects at the given position
* @param e The given evas object.
* @param x The horizontal coordinate.
* @param y The vertical coordinate.
* @param include_pass_events_objects Boolean Flag to include or not
* pass events objects
* @param include_hidden_objects Boolean Flag to include or not hidden objects
* @return The list of evas objects at the pointer position.
*
* FIXME: To be fixed.
*/
EAPI Eina_List *
evas_objects_at_xy_get(const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
@ -1541,6 +1565,18 @@ evas_objects_at_xy_get(const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool incl
*
* FIXME: To be fixed.
*/
/**
* Retrieves the objects in the given rectangle region
* @param e The given evas object.
* @param x The horizontal coordinate.
* @param y The vertical coordinate.
* @param w The width size.
* @param h The height size.
* @param include_pass_events_objects Boolean Flag to include or not pass events objects
* @param include_hidden_objects Boolean Flag to include or not hidden objects
* @return The list of evas object in the rectangle region.
*
*/
EAPI Eina_List *
evas_objects_in_rectangle_get(const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
{

7
legacy/evas/src/lib/canvas/evas_object_table.c
View File

@ -1084,8 +1084,10 @@ evas_object_table_padding_get(const Evas_Object *o, Evas_Coord *horizontal, Evas
}
/**
* Add a new child to table.
* Add a new child to a table object.
*
* @param o The given table object.
* @param child The child object to add.
* @param col relative-horizontal position to place child.
* @param row relative-vertical position to place child.
* @param colspan how many relative-horizontal position to use for this child.
@ -1246,8 +1248,9 @@ evas_object_table_unpack(Evas_Object *o, Evas_Object *child)
}
/**
* Faster way to remove all child objects.
* Faster way to remove all child objects from a table object.
*
* @param o The given table object.
* @param clear if true, it will delete just removed children.
*/
void

3
legacy/evas/src/lib/canvas/evas_object_text.c
View File

@ -933,8 +933,9 @@ evas_object_text_outline_color_get(const Evas_Object *obj, int *r, int *g, int *
}
/**
* Gets the text style pad.
* Gets the text style pad of a text object.
*
* @param obj The given text object.
* @param l The left pad (or NULL).
* @param r The right pad (or NULL).
* @param t The top pad (or NULL).

27
legacy/evas/src/lib/canvas/evas_object_textblock.c
View File

@ -2422,8 +2422,7 @@ evas_textblock_style_new(void)
/**
* Destroys a textblock style.
* @param The textblock style to free.
* @return Returns no value.
* @param ts The textblock style to free.
*/
EAPI void
evas_textblock_style_free(Evas_Textblock_Style *ts)
@ -2640,9 +2639,10 @@ evas_object_textblock_style_get(const Evas_Object *obj)
}
/**
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @brief Change the charset in use inside the given textblock object.
*
* @param obj The given textblock object.
* @param ch The charset name.
*/
EAPI void
evas_object_textblock_replace_char_set(Evas_Object *obj, const char *ch)
@ -2756,7 +2756,7 @@ _escaped_char_get(const char *s, const char *s_end)
/**
* to be documented.
* @param obj to be documented.
* @param escape to be documented.
* @return to be documented.
*/
EAPI const char *
@ -2768,7 +2768,8 @@ evas_textblock_escape_string_get(const char *escape)
/**
* to be documented.
* @param obj to be documented.
* @param escape_start to be documented.
* @param escape_end to be documented.
* @return to be documented.
*/
EAPI const char *
@ -2779,7 +2780,8 @@ evas_textblock_escape_string_range_get(const char *escape_start, const char *esc
/**
* to be documented.
* @param obj to be documented.
* @param string to be documented.
* @param len_ret to be documented.
* @return to be documented.
*/
EAPI const char *
@ -2813,7 +2815,7 @@ _prepend_escaped_char(Evas_Textblock_Cursor *cur, const char *s,
/**
* to be documented.
* @param ts to be documented.
* @param obj to be documented.
* @param text to be documented.
* @return Return no value.
*/
@ -2955,7 +2957,7 @@ evas_object_textblock_text_markup_set(Evas_Object *obj, const char *text)
/**
* to be documented.
* @param ts to be documented.
* @param cur to be documented.
* @param text to be documented.
* @return Return no value.
*/
@ -3527,8 +3529,7 @@ evas_textblock_cursor_pos_get(const Evas_Textblock_Cursor *cur)
/**
* to be documented.
* @param cur to be documented.
* @param int to be documented.
* @return Returns no value.
* @param pos to be documented.
*/
EAPI void
evas_textblock_cursor_pos_set(Evas_Textblock_Cursor *cur, int pos)
@ -3545,7 +3546,7 @@ evas_textblock_cursor_pos_set(Evas_Textblock_Cursor *cur, int pos)
/**
* to be documented.
* @param cur to be documented.
* @param int to be documented.
* @param line to be documented.
* @return to be documented.
*/
EAPI Eina_Bool

72
legacy/evas/src/lib/canvas/evas_render.c
View File

@ -5,9 +5,16 @@ static Eina_List *
evas_render_updates_internal(Evas *e, unsigned char make_updates, unsigned char do_draw);
/**
* To be documented.
* Add a damage rectangle.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param x The rectangle's left position.
* @param y The rectangle's top position.
* @param w The rectangle's width.
* @param h The rectangle's height.
*
* This is the function by which one tells evas that a part of the
* canvas has to be repainted.
*
*/
EAPI void
@ -25,9 +32,19 @@ evas_damage_rectangle_add(Evas *e, int x, int y, int w, int h)
}
/**
* To be documented.
* Add an obscured region.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @param x The rectangle's left position.
* @param y The rectangle's top position
* @param w The rectangle's width.
* @param h The rectangle's height.
*
* This is the function by which one tells evas that a part of the
* canvas has not to be repainted. To make this region one that have
* to be repainted, call the function evas_obscured_clear().
*
* @see evas_obscured_clear().
*
*/
EAPI void
@ -44,9 +61,14 @@ evas_obscured_rectangle_add(Evas *e, int x, int y, int w, int h)
}
/**
* To be documented.
* Remove all obscured region rectangles from the canvas.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
*
* This function removes all the rectangles from the obscured list of
* the canvas. It takes obscured areas added with
* evas_obscured_rectangle_add() and makes it a region that have to be
* repainted.
*
*/
EAPI void
@ -646,9 +668,12 @@ evas_render_updates_internal(Evas *e, unsigned char make_updates, unsigned char
}
/**
* To be documented.
* Free the rectangles returned by evas_render_updates().
*
* FIXME: To be fixed.
* @param updates The list of updated rectangles of the canvas.
*
* This function removes the region from the render updates list. It
* makes the region doesn't be render updated anymore.
*
*/
EAPI void
@ -661,9 +686,13 @@ evas_render_updates_free(Eina_List *updates)
}
/**
* To be documented.
* Force immediate renderization of the given canvas.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
* @return A list of updated rectangles of the canvas.
*
* This function forces an immediate renderization update of the given
* given canvas.
*
*/
EAPI Eina_List *
@ -678,9 +707,11 @@ evas_render_updates(Evas *e)
}
/**
* To be documented.
* Force renderization of a region
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
*
* This function forces renderization of the region given.
*
*/
EAPI void
@ -695,9 +726,16 @@ evas_render(Evas *e)
}
/**
* To be documented.
* Update the canvas internal objects but not triggering immediate
* renderization.
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
*
* This function updates the canvas internal objects not triggering
* renderization. To force renderization function evas_render() should
* be used.
*
* @see evas_render.
*
*/
EAPI void
@ -712,9 +750,11 @@ evas_norender(Evas *e)
}
/**
* To be documented.
* Make the canvas discard internally cached data used for renderization
*
* FIXME: To be fixed.
* @param e The given canvas pointer.
*
* This function flushes the arrays of delete, active and render objects.
*
*/
EAPI void

9
legacy/evas/src/lib/canvas/evas_smart.c
View File

@ -123,7 +123,7 @@ evas_smart_free(Evas_Smart *s)
/**
* Creates an Evas_Smart from an Evas_Smart_Class.
*
* @param Evas_Smart_Class the smart class definition
* @param sc the smart class definition
* @return an Evas_Smart
*/
EAPI Evas_Smart *
@ -162,14 +162,13 @@ evas_smart_class_get(const Evas_Smart *s)
}
/**
* Get the data pointer set on an Evas_Smart.
* @brief Get the data pointer set on an Evas_Smart.
*
* @param s Evas_Smart
*
* This data pointer is set either as the final parameter to
* evas_smart_new or as the data field in the Evas_Smart_Class passed
* in to evas_smart_class_new
*
* @param Evas_Smart
*
*/
EAPI void *
evas_smart_data_get(const Evas_Smart *s)