1889 lines
68 KiB
C
1889 lines
68 KiB
C
#ifndef _EVAS_H
|
|
# error You shall not include this header directly
|
|
#endif
|
|
|
|
/**
|
|
* @ingroup Evas_Canvas
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* Creates a new empty evas.
|
|
*
|
|
* Note that before you can use the evas, you will to at a minimum:
|
|
* @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 .
|
|
*
|
|
* This function should only fail if the memory allocation fails
|
|
*
|
|
* @note this function is very low level. Instead of using it
|
|
* directly, consider using the high level functions in
|
|
* @ref Ecore_Evas_Group such as @c ecore_evas_new(). See
|
|
* @ref Ecore.
|
|
*
|
|
* @attention it is recommended that one calls evas_init() before
|
|
* creating new canvas.
|
|
*
|
|
* @return A new uninitialised Evas canvas on success. Otherwise, @c NULL.
|
|
* @ingroup Evas_Canvas
|
|
*/
|
|
EAPI Evas *evas_new(void) EINA_WARN_UNUSED_RESULT EINA_MALLOC;
|
|
|
|
/**
|
|
* Frees the given evas and any objects created on it.
|
|
*
|
|
* Any objects with 'free' callbacks will have those callbacks called
|
|
* in this function.
|
|
*
|
|
* @param e The given evas.
|
|
*
|
|
* @ingroup Evas_Canvas
|
|
*/
|
|
EAPI void evas_free(Evas *e) EINA_ARG_NONNULL(1);
|
|
|
|
#include "canvas/evas_canvas.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/**
|
|
* @ingroup Evas_Canvas_Events
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Add (register) a callback function to a given canvas event.
|
|
*
|
|
* @param e Canvas to attach a callback to
|
|
* @param type The type of event that will trigger the callback
|
|
* @param func The (callback) 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 the canvas @p e when the
|
|
* event of type @p type occurs on it. The function pointer is @p
|
|
* func.
|
|
*
|
|
* In the event of a memory allocation error during the addition of
|
|
* the callback to the canvas, evas_alloc_error() should be used to
|
|
* determine the nature of the error, if any, and the program should
|
|
* sensibly try and recover.
|
|
*
|
|
* A callback function must have the ::Evas_Event_Cb prototype
|
|
* definition. The first parameter (@p data) in this definition will
|
|
* have the same value passed to evas_event_callback_add() as the @p
|
|
* data parameter, at runtime. The second parameter @p e is the canvas
|
|
* pointer on which the event occurred. The third 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. This is so because some events don't carry extra
|
|
* context with them, but others do.
|
|
*
|
|
* The event type @p type to trigger the function may be one of
|
|
* #EVAS_CALLBACK_RENDER_FLUSH_PRE, #EVAS_CALLBACK_RENDER_FLUSH_POST,
|
|
* #EVAS_CALLBACK_CANVAS_FOCUS_IN, #EVAS_CALLBACK_CANVAS_FOCUS_OUT,
|
|
* #EVAS_CALLBACK_CANVAS_OBJECT_FOCUS_IN and
|
|
* #EVAS_CALLBACK_CANVAS_OBJECT_FOCUS_OUT. This determines the kind of
|
|
* event that will trigger the callback to be called. Only the last
|
|
* two of the event types listed here provide useful event information
|
|
* data -- a pointer to the recently focused Evas object. For the
|
|
* others the @p event_info pointer is going to be @c NULL.
|
|
*
|
|
* Example:
|
|
* @dontinclude evas-events.c
|
|
* @skip evas_event_callback_add(d.canvas, EVAS_CALLBACK_RENDER_FLUSH_PRE
|
|
* @until two canvas event callbacks
|
|
*
|
|
* Looking to the callbacks registered above,
|
|
* @dontinclude evas-events.c
|
|
* @skip called when our rectangle gets focus
|
|
* @until let's have our events back
|
|
*
|
|
* we see that the canvas flushes its rendering pipeline
|
|
* (#EVAS_CALLBACK_RENDER_FLUSH_PRE) whenever the @c _resize_cb
|
|
* routine takes place: it has to redraw that image at a different
|
|
* size. Also, the callback on an object being focused comes just
|
|
* after we focus it explicitly, on code.
|
|
*
|
|
* See the full @ref Example_Evas_Events "example".
|
|
*
|
|
* @note Be careful not to add the same callback multiple times, if
|
|
* that's not what you want, because Evas won't check if a callback
|
|
* existed before exactly as the one being registered (and thus, call
|
|
* it more than once on the event, in this case). This would make
|
|
* sense if you passed different functions and/or callback data, only.
|
|
*/
|
|
EAPI void evas_event_callback_add(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3);
|
|
|
|
/**
|
|
* Add (register) a callback function to a given canvas event with a
|
|
* non-default priority set. Except for the priority field, it's exactly the
|
|
* same as @ref evas_event_callback_add
|
|
*
|
|
* @param e Canvas to attach a callback to
|
|
* @param type The type of event that will trigger the callback
|
|
* @param priority The priority of the callback, lower values called first.
|
|
* @param func The (callback) function to be called when the event is
|
|
* triggered
|
|
* @param data The data pointer to be passed to @p func
|
|
*
|
|
* @see evas_event_callback_add
|
|
* @since 1.1
|
|
*/
|
|
EAPI void evas_event_callback_priority_add(Evas *e, Evas_Callback_Type type, Evas_Callback_Priority priority, Evas_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 4);
|
|
|
|
/**
|
|
* Delete a callback function from the canvas.
|
|
*
|
|
* @param e Canvas 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
|
|
* canvas @p e 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_event_callback_add() when the callback was added to the
|
|
* canvas. If not successful @c NULL will be returned.
|
|
*
|
|
* Example:
|
|
* @code
|
|
* extern Evas *e;
|
|
* void *my_data;
|
|
* void focus_in_callback(void *data, Evas *e, void *event_info);
|
|
*
|
|
* my_data = evas_event_callback_del(ebject, EVAS_CALLBACK_CANVAS_FOCUS_IN, focus_in_callback);
|
|
* @endcode
|
|
*/
|
|
EAPI void *evas_event_callback_del(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func) EINA_ARG_NONNULL(1, 3);
|
|
|
|
/**
|
|
* Delete (unregister) a callback function registered to a given
|
|
* canvas event.
|
|
*
|
|
* @param e Canvas to remove an event 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 <b>the first</b> added callback from the
|
|
* canvas @p e matching the event type @p type, the registered
|
|
* function pointer @p func and the callback data pointer @p data. If
|
|
* the removal is successful it will also return the data pointer that
|
|
* was passed to evas_event_callback_add() (that will be the same as
|
|
* the parameter) when the callback(s) was(were) added to the
|
|
* canvas. If not successful @c NULL will be returned. A common use
|
|
* would be to remove an exact match of a callback.
|
|
*
|
|
* Example:
|
|
* @dontinclude evas-events.c
|
|
* @skip evas_event_callback_del_full(evas, EVAS_CALLBACK_RENDER_FLUSH_PRE,
|
|
* @until _object_focus_in_cb, NULL);
|
|
*
|
|
* See the full @ref Example_Evas_Events "example".
|
|
*
|
|
* @note For deletion of canvas events callbacks filtering by just
|
|
* type and function pointer, user evas_event_callback_del().
|
|
*/
|
|
EAPI void *evas_event_callback_del_full(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3);
|
|
|
|
/**
|
|
* Push a callback on the post-event callback stack
|
|
*
|
|
* @param e Canvas to push the callback on
|
|
* @param func The function that to be called when the stack is unwound
|
|
* @param data The data pointer to be passed to the callback
|
|
*
|
|
* Evas has a stack of callbacks that get called after all the callbacks for
|
|
* an event have triggered (all the objects it triggers on and all the callbacks
|
|
* in each object triggered). When all these have been called, the stack is
|
|
* unwond from most recently to least recently pushed item and removed from the
|
|
* stack calling the callback set for it.
|
|
*
|
|
* This is intended for doing reverse logic-like processing, example - when a
|
|
* child object that happens to get the event later is meant to be able to
|
|
* "steal" functions from a parent and thus on unwind of this stack have its
|
|
* function called first, thus being able to set flags, or return 0 from the
|
|
* post-callback that stops all other post-callbacks in the current stack from
|
|
* being called (thus basically allowing a child to take control, if the event
|
|
* callback prepares information ready for taking action, but the post callback
|
|
* actually does the action).
|
|
*
|
|
*/
|
|
EAPI void evas_post_event_callback_push(Evas *e, Evas_Object_Event_Post_Cb func, const void *data);
|
|
|
|
/**
|
|
* Remove a callback from the post-event callback stack
|
|
*
|
|
* @param e Canvas to push the callback on
|
|
* @param func The function that to be called when the stack is unwound
|
|
*
|
|
* This removes a callback from the stack added with
|
|
* evas_post_event_callback_push(). The first instance of the function in
|
|
* the callback stack is removed from being executed when the stack is
|
|
* unwound. Further instances may still be run on unwind.
|
|
*/
|
|
EAPI void evas_post_event_callback_remove(Evas *e, Evas_Object_Event_Post_Cb func);
|
|
|
|
/**
|
|
* Remove a callback from the post-event callback stack
|
|
*
|
|
* @param e Canvas to push the callback on
|
|
* @param func The function that to be called when the stack is unwound
|
|
* @param data The data pointer to be passed to the callback
|
|
*
|
|
* This removes a callback from the stack added with
|
|
* evas_post_event_callback_push(). The first instance of the function and data
|
|
* in the callback stack is removed from being executed when the stack is
|
|
* unwound. Further instances may still be run on unwind.
|
|
*/
|
|
EAPI void evas_post_event_callback_remove_full(Evas *e, Evas_Object_Event_Post_Cb func, const void *data);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Event_Feeding_Group
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Freeze all input events processing.
|
|
*
|
|
* @param e The canvas to freeze input events processing on.
|
|
*
|
|
* This function will indicate to Evas that the canvas @p e is to have
|
|
* all input event processing frozen until a matching
|
|
* evas_event_thaw() function is called on the same canvas. All events
|
|
* of this kind during the freeze will get @b discarded. Every freeze
|
|
* call must be matched by a thaw call in order to completely thaw out
|
|
* a canvas (i.e. these calls may be nested). The most common use is
|
|
* when you don't want the user to interact with your user interface
|
|
* when you're populating a view or changing the layout.
|
|
*
|
|
* Example:
|
|
* @dontinclude evas-events.c
|
|
* @skip freeze input for 3 seconds
|
|
* @until }
|
|
* @dontinclude evas-events.c
|
|
* @skip let's have our events back
|
|
* @until }
|
|
*
|
|
* See the full @ref Example_Evas_Events "example".
|
|
*
|
|
* If you run that example, you'll see the canvas ignoring all input
|
|
* events for 3 seconds, when the "f" key is pressed. In a more
|
|
* realistic code we would be freezing while a toolkit or Edje was
|
|
* doing some UI changes, thawing it back afterwards.
|
|
*/
|
|
EAPI void evas_event_freeze(Evas *e) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* Thaw a canvas out after freezing (for input events).
|
|
*
|
|
* @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, i.e., there's no
|
|
* other unbalanced call to evas_event_freeze(), events will start to
|
|
* be processed again, but any "missed" events will @b not be
|
|
* evaluated.
|
|
*
|
|
* See evas_event_freeze() for an example.
|
|
*/
|
|
EAPI void evas_event_thaw(Evas *e) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* Return the freeze count on input events 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
|
|
* input 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
|
|
* extern Evas *evas;
|
|
*
|
|
* while (evas_event_freeze_get(evas) > 0) evas_event_thaw(evas);
|
|
* @endcode
|
|
*
|
|
*/
|
|
EAPI int evas_event_freeze_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* After thaw of a canvas, re-evaluate the state of objects and call callbacks
|
|
*
|
|
* @param e The canvas to evaluate after a thaw
|
|
*
|
|
* This is normally called after evas_event_thaw() to re-evaluate mouse
|
|
* containment and other states and thus also call callbacks for mouse in and
|
|
* out on new objects if the state change demands it.
|
|
*/
|
|
EAPI void evas_event_thaw_eval(Evas *e) EINA_ARG_NONNULL(1);
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Font_Group
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Free list of font descriptions returned by evas_font_dir_available_list().
|
|
*
|
|
* @param e The evas instance that returned such list.
|
|
* @param available the list returned by evas_font_dir_available_list().
|
|
*
|
|
* @ingroup Evas_Font_Group
|
|
*/
|
|
EAPI void evas_font_available_list_free(Evas *e, Eina_List *available) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Group_Basic
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Increments object reference count to defer its deletion.
|
|
*
|
|
* @param obj The given Evas object to reference
|
|
*
|
|
* This increments the reference count of an object, which if greater
|
|
* than 0 will defer deletion by evas_object_del() until all
|
|
* references are released back (counter back to 0). References cannot
|
|
* go below 0 and unreferencing past that will result in the reference
|
|
* count being limited to 0. References are limited to <c>2^32 - 1</c>
|
|
* for an object. Referencing it more than this will result in it
|
|
* being limited to this value.
|
|
*
|
|
* @see evas_object_unref()
|
|
* @see evas_object_del()
|
|
*
|
|
* @note This is a <b>very simple</b> reference counting mechanism! For
|
|
* instance, Evas is not ready to check for pending references on a
|
|
* canvas deletion, or things like that. This is useful on scenarios
|
|
* where, inside a code block, callbacks exist which would possibly
|
|
* delete an object we are operating on afterwards. Then, one would
|
|
* evas_object_ref() it on the beginning of the block and
|
|
* evas_object_unref() it on the end. It would then be deleted at this
|
|
* point, if it should be.
|
|
*
|
|
* Example:
|
|
* @code
|
|
* evas_object_ref(obj);
|
|
*
|
|
* // action here...
|
|
* evas_object_smart_callback_call(obj, SIG_SELECTED, NULL);
|
|
* // more action here...
|
|
* evas_object_unref(obj);
|
|
* @endcode
|
|
*
|
|
* @ingroup Evas_Object_Group_Basic
|
|
* @since 1.1
|
|
*/
|
|
EAPI void evas_object_ref(Evas_Object *obj);
|
|
|
|
/**
|
|
* Decrements object reference count.
|
|
*
|
|
* @param obj The given Evas object to unreference
|
|
*
|
|
* This decrements the reference count of an object. If the object has
|
|
* had evas_object_del() called on it while references were more than
|
|
* 0, it will be deleted at the time this function is called and puts
|
|
* the counter back to 0. See evas_object_ref() for more information.
|
|
*
|
|
* @see evas_object_ref() (for an example)
|
|
* @see evas_object_del()
|
|
*
|
|
* @ingroup Evas_Object_Group_Basic
|
|
* @since 1.1
|
|
*/
|
|
EAPI void evas_object_unref(Evas_Object *obj);
|
|
|
|
/**
|
|
* Get the object reference count.
|
|
*
|
|
* @param obj The given Evas object to query
|
|
*
|
|
* This gets the reference count for an object (normally 0 until it is
|
|
* referenced). Values of 1 or greater mean that someone is holding a
|
|
* reference to this object that needs to be unreffed before it can be
|
|
* deleted.
|
|
*
|
|
* @see evas_object_ref()
|
|
* @see evas_object_unref()
|
|
* @see evas_object_del()
|
|
*
|
|
* @ingroup Evas_Object_Group_Basic
|
|
* @since 1.2
|
|
*/
|
|
EAPI int evas_object_ref_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Marks the given Evas object for deletion (when Evas will free its
|
|
* memory).
|
|
*
|
|
* @param obj The given Evas object.
|
|
*
|
|
* This call will mark @p obj for deletion, which will take place
|
|
* whenever it has no more references to it (see evas_object_ref() and
|
|
* evas_object_unref()).
|
|
*
|
|
* At actual deletion time, which may or may not be just after this
|
|
* call, ::EVAS_CALLBACK_DEL and ::EVAS_CALLBACK_FREE callbacks will
|
|
* be called. If the object currently had the focus, its
|
|
* ::EVAS_CALLBACK_FOCUS_OUT callback will also be called.
|
|
*
|
|
* @see evas_object_ref()
|
|
* @see evas_object_unref()
|
|
*
|
|
* @ingroup Evas_Object_Group_Basic
|
|
*/
|
|
EAPI void evas_object_del(Evas_Object *obj) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* Retrieves the position and (rectangular) size of the given Evas
|
|
* object.
|
|
*
|
|
* @param obj The given Evas object.
|
|
* @param x Pointer to an integer in which to store the X coordinate
|
|
* of the object.
|
|
* @param y Pointer to an integer in which to store the Y coordinate
|
|
* of the object.
|
|
* @param w Pointer to an integer in which to store the width of the
|
|
* object.
|
|
* @param h Pointer to an integer in which to store the height of the
|
|
* object.
|
|
*
|
|
* The position, naturally, will be relative to the top left corner of
|
|
* the canvas' viewport.
|
|
*
|
|
* @note Use @c NULL pointers on the geometry components you're not
|
|
* interested in: they'll be ignored by the function.
|
|
*
|
|
* Example:
|
|
* @dontinclude evas-events.c
|
|
* @skip int w, h, cw, ch;
|
|
* @until return
|
|
*
|
|
* See the full @ref Example_Evas_Events "example".
|
|
*
|
|
* @ingroup Evas_Object_Group_Basic
|
|
*/
|
|
EAPI void evas_object_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* Set the position and (rectangular) size of the given Evas object.
|
|
*
|
|
* @param obj The given Evas object.
|
|
* @param x X position to move the object to, in canvas units.
|
|
* @param y Y position to move the object to, in canvas units.
|
|
* @param w The new width of the Evas object.
|
|
* @param h The new height of the Evas object.
|
|
*
|
|
* The position, naturally, will be relative to the top left corner of
|
|
* the canvas' viewport.
|
|
*
|
|
* If the object get moved, the object's ::EVAS_CALLBACK_MOVE callback
|
|
* will be called.
|
|
*
|
|
* If the object get resized, the object's ::EVAS_CALLBACK_RESIZE callback
|
|
* will be called.
|
|
*
|
|
* @see evas_object_move()
|
|
* @see evas_object_resize()
|
|
* @see evas_object_geometry_get
|
|
*
|
|
* @since 1.8
|
|
* @ingroup Evas_Object_Group_Basic
|
|
*/
|
|
EAPI void evas_object_geometry_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
|
|
|
|
|
|
/**
|
|
* Makes the given Evas object visible.
|
|
*
|
|
* @param obj The given Evas object.
|
|
*
|
|
* Besides becoming visible, the object's ::EVAS_CALLBACK_SHOW
|
|
* callback will be called.
|
|
*
|
|
* @see evas_object_hide() for more on object visibility.
|
|
* @see evas_object_visible_get()
|
|
*
|
|
* @ingroup Evas_Object_Group_Basic
|
|
*/
|
|
EAPI void evas_object_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* Makes the given Evas object invisible.
|
|
*
|
|
* @param obj The given Evas object.
|
|
*
|
|
* Hidden objects, besides not being shown at all in your canvas,
|
|
* won't be checked for changes on the canvas rendering
|
|
* process. Furthermore, they will not catch input events. Thus, they
|
|
* are much ligher (in processing needs) than an object that is
|
|
* invisible due to indirect causes, such as being clipped or out of
|
|
* the canvas' viewport.
|
|
*
|
|
* Besides becoming hidden, @p obj object's ::EVAS_CALLBACK_SHOW
|
|
* callback will be called.
|
|
*
|
|
* @note All objects are created in the hidden state! If you want them
|
|
* shown, use evas_object_show() after their creation.
|
|
*
|
|
* @see evas_object_show()
|
|
* @see evas_object_visible_get()
|
|
*
|
|
* Example:
|
|
* @dontinclude evas-object-manipulation.c
|
|
* @skip if (evas_object_visible_get(d.clipper))
|
|
* @until return
|
|
*
|
|
* See the full @ref Example_Evas_Object_Manipulation "example".
|
|
*
|
|
* @ingroup Evas_Object_Group_Basic
|
|
*/
|
|
EAPI void evas_object_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
|
|
|
|
|
|
#include "canvas/evas_common_interface.eo.legacy.h"
|
|
#include "canvas/evas_object.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Group_Events
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Add (register) a callback function to a given Evas object event.
|
|
*
|
|
* @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.
|
|
*
|
|
* 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.
|
|
*
|
|
* A callback function must have the ::Evas_Object_Event_Cb prototype
|
|
* definition. The first parameter (@p data) in this definition will
|
|
* have the same value passed to evas_object_event_callback_add() as
|
|
* the @p data parameter, at runtime. The second parameter @p e is the
|
|
* canvas pointer on which the event occurred. The third parameter is
|
|
* a pointer to the object on which event occurred. Finally, the
|
|
* fourth 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. This is so because some
|
|
* events don't carry extra context with them, but others do.
|
|
*
|
|
* 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_MULTI_DOWN, #EVAS_CALLBACK_MULTI_UP,
|
|
* #EVAS_CALLBACK_MULTI_MOVE, #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, #EVAS_CALLBACK_RESTACK, #EVAS_CALLBACK_DEL,
|
|
* #EVAS_CALLBACK_HOLD, #EVAS_CALLBACK_CHANGED_SIZE_HINTS,
|
|
* #EVAS_CALLBACK_IMAGE_PRELOADED or #EVAS_CALLBACK_IMAGE_UNLOADED.
|
|
*
|
|
* This determines the kind of event that will trigger the callback.
|
|
* What follows is a list explaining better the nature of each type of
|
|
* event, along with their associated @p event_info pointers:
|
|
*
|
|
* - #EVAS_CALLBACK_MOUSE_IN: @p event_info is a pointer to an
|
|
* #Evas_Event_Mouse_In struct\n\n
|
|
* This event is triggered when the mouse pointer enters the area
|
|
* (not shaded by other objects) of the object @p obj. This may
|
|
* occur by the mouse pointer being moved by
|
|
* evas_event_feed_mouse_move() calls, or by the object being shown,
|
|
* raised, moved, resized, or other objects being moved out of the
|
|
* way, hidden or lowered, whatever may cause the mouse pointer to
|
|
* get on top of @p obj, having been on top of another object
|
|
* previously.
|
|
*
|
|
* - #EVAS_CALLBACK_MOUSE_OUT: @p event_info is a pointer to an
|
|
* #Evas_Event_Mouse_Out struct\n\n
|
|
* This event is triggered exactly like #EVAS_CALLBACK_MOUSE_IN is,
|
|
* but it occurs when the mouse pointer exits an object's area. Note
|
|
* that no mouse out events will be reported if the mouse pointer is
|
|
* implicitly grabbed to an object (mouse buttons are down, having
|
|
* been pressed while the pointer was over that object). In these
|
|
* cases, mouse out events will be reported once all buttons are
|
|
* released, if the mouse pointer has left the object's area. The
|
|
* indirect ways of taking off the mouse pointer from an object,
|
|
* like cited above, for #EVAS_CALLBACK_MOUSE_IN, also apply here,
|
|
* naturally.
|
|
*
|
|
* - #EVAS_CALLBACK_MOUSE_DOWN: @p event_info is a pointer to an
|
|
* #Evas_Event_Mouse_Down struct\n\n
|
|
* This event is triggered by a mouse button being pressed while the
|
|
* mouse pointer is over an object. If the pointer mode for Evas is
|
|
* #EVAS_OBJECT_POINTER_MODE_AUTOGRAB (default), this causes this
|
|
* object to <b>passively grab the mouse</b> until all mouse buttons
|
|
* have been released: all future mouse events will be reported to
|
|
* only this object until no buttons are down. That includes mouse
|
|
* move events, mouse in and mouse out events, and further button
|
|
* presses. When all buttons are released, event propagation will
|
|
* occur as normal (see #Evas_Object_Pointer_Mode).
|
|
*
|
|
* - #EVAS_CALLBACK_MOUSE_UP: @p event_info is a pointer to an
|
|
* #Evas_Event_Mouse_Up struct\n\n
|
|
* This event is triggered by a mouse button being released while
|
|
* the mouse pointer is over an object's area (or when passively
|
|
* grabbed to an object).
|
|
*
|
|
* - #EVAS_CALLBACK_MOUSE_MOVE: @p event_info is a pointer to an
|
|
* #Evas_Event_Mouse_Move struct\n\n
|
|
* This event is triggered by the mouse pointer being moved while
|
|
* over an object's area (or while passively grabbed to an object).
|
|
*
|
|
* - #EVAS_CALLBACK_MOUSE_WHEEL: @p event_info is a pointer to an
|
|
* #Evas_Event_Mouse_Wheel struct\n\n
|
|
* This event is triggered by the mouse wheel being rolled while the
|
|
* mouse pointer is over an object (or passively grabbed to an
|
|
* object).
|
|
*
|
|
* - #EVAS_CALLBACK_MULTI_DOWN: @p event_info is a pointer to an
|
|
* #Evas_Event_Multi_Down struct
|
|
*
|
|
* - #EVAS_CALLBACK_MULTI_UP: @p event_info is a pointer to an
|
|
* #Evas_Event_Multi_Up struct
|
|
*
|
|
* - #EVAS_CALLBACK_MULTI_MOVE: @p event_info is a pointer to an
|
|
* #Evas_Event_Multi_Move struct
|
|
*
|
|
* - #EVAS_CALLBACK_FREE: @p event_info is @c NULL \n\n
|
|
* 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 it returns, there
|
|
* is no guarantee on the object's validity.
|
|
*
|
|
* - #EVAS_CALLBACK_KEY_DOWN: @p event_info is a pointer to an
|
|
* #Evas_Event_Key_Down struct\n\n
|
|
* 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: @p event_info is a pointer to an
|
|
* #Evas_Event_Key_Up struct \n\n
|
|
* 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: @p event_info is @c NULL \n\n
|
|
* This event is called when an object gains the focus. When it is
|
|
* called the object has already gained the focus.
|
|
*
|
|
* - #EVAS_CALLBACK_FOCUS_OUT: @p event_info is @c NULL \n\n
|
|
* This event is triggered when an object loses the focus. When it
|
|
* is called the object has already lost the focus.
|
|
*
|
|
* - #EVAS_CALLBACK_SHOW: @p event_info is @c NULL \n\n
|
|
* This event is triggered by the object being shown by
|
|
* evas_object_show().
|
|
*
|
|
* - #EVAS_CALLBACK_HIDE: @p event_info is @c NULL \n\n
|
|
* This event is triggered by an object being hidden by
|
|
* evas_object_hide().
|
|
*
|
|
* - #EVAS_CALLBACK_MOVE: @p event_info is @c NULL \n\n
|
|
* 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: @p event_info is @c NULL \n\n
|
|
* 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.
|
|
*
|
|
* - #EVAS_CALLBACK_RESTACK: @p event_info is @c NULL \n\n
|
|
* This event is triggered by an object being re-stacked. Stacking
|
|
* changes can be triggered by
|
|
* evas_object_stack_below()/evas_object_stack_above() and others.
|
|
*
|
|
* - #EVAS_CALLBACK_DEL: @p event_info is @c NULL.
|
|
*
|
|
* - #EVAS_CALLBACK_HOLD: @p event_info is a pointer to an
|
|
* #Evas_Event_Hold struct
|
|
*
|
|
* - #EVAS_CALLBACK_CHANGED_SIZE_HINTS: @p event_info is @c NULL.
|
|
*
|
|
* - #EVAS_CALLBACK_IMAGE_PRELOADED: @p event_info is @c NULL.
|
|
*
|
|
* - #EVAS_CALLBACK_IMAGE_UNLOADED: @p event_info is @c NULL.
|
|
*
|
|
* @note Be careful not to add the same callback multiple times, if
|
|
* that's not what you want, because Evas won't check if a callback
|
|
* existed before exactly as the one being registered (and thus, call
|
|
* it more than once on the event, in this case). This would make
|
|
* sense if you passed different functions and/or callback data, only.
|
|
*
|
|
* Example:
|
|
* @dontinclude evas-events.c
|
|
* @skip evas_object_event_callback_add(
|
|
* @until }
|
|
*
|
|
* See the full example @ref Example_Evas_Events "here".
|
|
*
|
|
*/
|
|
EAPI void evas_object_event_callback_add(Evas_Object *obj, Evas_Callback_Type type, Evas_Object_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3);
|
|
|
|
/**
|
|
* Add (register) a callback function to a given Evas object event with a
|
|
* non-default priority set. Except for the priority field, it's exactly the
|
|
* same as @ref evas_object_event_callback_add
|
|
*
|
|
* @param obj Object to attach a callback to
|
|
* @param type The type of event that will trigger the callback
|
|
* @param priority The priority of the callback, lower values called first.
|
|
* @param func The function to be called when the event is triggered
|
|
* @param data The data pointer to be passed to @p func
|
|
*
|
|
* @see evas_object_event_callback_add
|
|
* @since 1.1
|
|
*/
|
|
EAPI void evas_object_event_callback_priority_add(Evas_Object *obj, Evas_Callback_Type type, Evas_Callback_Priority priority, Evas_Object_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 4);
|
|
|
|
/**
|
|
* 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 @c NULL will be returned.
|
|
*
|
|
* Example:
|
|
* @code
|
|
* extern Evas_Object *object;
|
|
* void *my_data;
|
|
* void up_callback(void *data, Evas *e, Evas_Object *obj, void *event_info);
|
|
*
|
|
* my_data = evas_object_event_callback_del(object, EVAS_CALLBACK_MOUSE_UP, up_callback);
|
|
* @endcode
|
|
*/
|
|
EAPI void *evas_object_event_callback_del(Evas_Object *obj, Evas_Callback_Type type, Evas_Object_Event_Cb func) EINA_ARG_NONNULL(1, 3);
|
|
|
|
/**
|
|
* Delete (unregister) a callback function registered to a given
|
|
* Evas object event.
|
|
*
|
|
* @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. In errors, @c NULL will be returned.
|
|
*
|
|
* @note For deletion of Evas object events callbacks filtering by
|
|
* just type and function pointer, user
|
|
* evas_object_event_callback_del().
|
|
*
|
|
* Example:
|
|
* @code
|
|
* extern Evas_Object *object;
|
|
* void *my_data;
|
|
* void up_callback(void *data, Evas *e, Evas_Object *obj, void *event_info);
|
|
*
|
|
* my_data = evas_object_event_callback_del_full(object, EVAS_CALLBACK_MOUSE_UP, up_callback, data);
|
|
* @endcode
|
|
*/
|
|
EAPI void *evas_object_event_callback_del_full(Evas_Object *obj, Evas_Callback_Type type, Evas_Object_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Group_Extras
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Set an attached data pointer to an object with a given string key.
|
|
*
|
|
* @param obj The object to attach the data pointer to
|
|
* @param key The string key for the data to access it
|
|
* @param data The pointer to the data to be attached
|
|
*
|
|
* This attaches the pointer @p data to the object @p obj, given the
|
|
* access string @p key. This pointer will stay "hooked" to the object
|
|
* until a new pointer with the same string key is attached with
|
|
* evas_object_data_set() or it is deleted with
|
|
* evas_object_data_del(). On deletion of the object @p obj, the
|
|
* pointers will not be accessible from the object anymore.
|
|
*
|
|
* You can find the pointer attached under a string key using
|
|
* evas_object_data_get(). It is the job of the calling application to
|
|
* free any data pointed to by @p data when it is no longer required.
|
|
*
|
|
* If @p data is @c NULL, the old value stored at @p key will be
|
|
* removed but no new value will be stored. This is synonymous with
|
|
* calling evas_object_data_del() with @p obj and @p key.
|
|
*
|
|
* @note This function is very handy when you have data associated
|
|
* specifically to an Evas object, being of use only when dealing with
|
|
* it. Than you don't have the burden to a pointer to it elsewhere,
|
|
* using this family of functions.
|
|
*
|
|
* Example:
|
|
*
|
|
* @code
|
|
* int *my_data;
|
|
* extern Evas_Object *obj;
|
|
*
|
|
* my_data = malloc(500);
|
|
* evas_object_data_set(obj, "name_of_data", my_data);
|
|
* printf("The data that was attached was %p\n", evas_object_data_get(obj, "name_of_data"));
|
|
* @endcode
|
|
*/
|
|
EAPI void evas_object_data_set(Evas_Object *obj, const char *key, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Return an attached data pointer on an Evas object by its given
|
|
* string key.
|
|
*
|
|
* @param obj The object to which the data was attached
|
|
* @param key The string key the data was stored under
|
|
* @return The data pointer stored, or @c NULL if none was stored
|
|
*
|
|
* This function will return the data pointer attached to the object
|
|
* @p obj, stored using the string key @p key. If the object is valid
|
|
* and a data pointer was stored under the given key, that pointer
|
|
* will be returned. If this is not the case, @c NULL will be
|
|
* returned, signifying an invalid object or a non-existent key. It is
|
|
* possible that a @c NULL pointer was stored given that key, but this
|
|
* situation is non-sensical and thus can be considered an error as
|
|
* well. @c NULL pointers are never stored as this is the return value
|
|
* if an error occurs.
|
|
*
|
|
* Example:
|
|
*
|
|
* @code
|
|
* int *my_data;
|
|
* extern Evas_Object *obj;
|
|
*
|
|
* my_data = evas_object_data_get(obj, "name_of_my_data");
|
|
* if (my_data) printf("Data stored was %p\n", my_data);
|
|
* else printf("No data was stored on the object\n");
|
|
* @endcode
|
|
*/
|
|
EAPI void *evas_object_data_get(const Evas_Object *obj, const char *key) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Delete an attached data pointer from an object.
|
|
*
|
|
* @param obj The object to delete the data pointer from
|
|
* @param key The string key the data was stored under
|
|
* @return The original data pointer stored at @p key on @p obj
|
|
*
|
|
* This will remove the stored data pointer from @p obj stored under
|
|
* @p key and return this same pointer, if actually there was data
|
|
* there, or @c NULL, if nothing was stored under that key.
|
|
*
|
|
* Example:
|
|
*
|
|
* @code
|
|
* int *my_data;
|
|
* extern Evas_Object *obj;
|
|
*
|
|
* my_data = evas_object_data_del(obj, "name_of_my_data");
|
|
* @endcode
|
|
*/
|
|
EAPI void *evas_object_data_del(Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Group_Find
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Retrieve the Evas object stacked at the top at the position of the
|
|
* mouse cursor, over a given canvas
|
|
*
|
|
* @param e A handle to the canvas.
|
|
* @return The Evas object that is over all other objects at the mouse
|
|
* pointer's position
|
|
*
|
|
* This function will traverse all the layers of the given canvas,
|
|
* from top to bottom, querying for objects with areas covering the
|
|
* mouse pointer's position, over @p e.
|
|
*
|
|
* @warning This function will @b skip objects parented by smart
|
|
* objects, acting only on the ones at the "top level", with regard to
|
|
* object parenting.
|
|
*/
|
|
EAPI Evas_Object *evas_object_top_at_pointer_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Group_Interceptors
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Set the callback function that intercepts a show event of a object.
|
|
*
|
|
* @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 function.
|
|
*
|
|
* This function sets a callback function to intercepts a show event
|
|
* of a canvas object.
|
|
*
|
|
* @see evas_object_intercept_show_callback_del().
|
|
*
|
|
*/
|
|
EAPI void evas_object_intercept_show_callback_add(Evas_Object *obj, Evas_Object_Intercept_Show_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Unset the callback function that intercepts a show event of a
|
|
* object.
|
|
*
|
|
* @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 *evas_object_intercept_show_callback_del(Evas_Object *obj, Evas_Object_Intercept_Show_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Set the callback function that intercepts a hide event of a object.
|
|
*
|
|
* @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 function.
|
|
*
|
|
* This function sets a callback function to intercepts a hide event
|
|
* of a canvas object.
|
|
*
|
|
* @see evas_object_intercept_hide_callback_del().
|
|
*
|
|
*/
|
|
EAPI void evas_object_intercept_hide_callback_add(Evas_Object *obj, Evas_Object_Intercept_Hide_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Unset the callback function that intercepts a hide event of a
|
|
* object.
|
|
*
|
|
* @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 *evas_object_intercept_hide_callback_del(Evas_Object *obj, Evas_Object_Intercept_Hide_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Set the callback function that intercepts a move event of a object.
|
|
*
|
|
* @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 function.
|
|
*
|
|
* This function sets a callback function to intercepts a move event
|
|
* of a canvas object.
|
|
*
|
|
* @see evas_object_intercept_move_callback_del().
|
|
*
|
|
*/
|
|
EAPI void evas_object_intercept_move_callback_add(Evas_Object *obj, Evas_Object_Intercept_Move_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Unset the callback function that intercepts a move event of a
|
|
* object.
|
|
*
|
|
* @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 *evas_object_intercept_move_callback_del(Evas_Object *obj, Evas_Object_Intercept_Move_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
|
|
EAPI void evas_object_intercept_resize_callback_add(Evas_Object *obj, Evas_Object_Intercept_Resize_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_resize_callback_del(Evas_Object *obj, Evas_Object_Intercept_Resize_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_raise_callback_add(Evas_Object *obj, Evas_Object_Intercept_Raise_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_raise_callback_del(Evas_Object *obj, Evas_Object_Intercept_Raise_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_lower_callback_add(Evas_Object *obj, Evas_Object_Intercept_Lower_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_lower_callback_del(Evas_Object *obj, Evas_Object_Intercept_Lower_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_stack_above_callback_add(Evas_Object *obj, Evas_Object_Intercept_Stack_Above_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_stack_above_callback_del(Evas_Object *obj, Evas_Object_Intercept_Stack_Above_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_stack_below_callback_add(Evas_Object *obj, Evas_Object_Intercept_Stack_Below_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_stack_below_callback_del(Evas_Object *obj, Evas_Object_Intercept_Stack_Below_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_layer_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Layer_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_layer_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Layer_Set_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_color_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Color_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_color_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Color_Set_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_clip_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Clip_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_clip_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Clip_Set_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_clip_unset_callback_add(Evas_Object *obj, Evas_Object_Intercept_Clip_Unset_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_clip_unset_callback_del(Evas_Object *obj, Evas_Object_Intercept_Clip_Unset_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void evas_object_intercept_focus_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Focus_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
|
|
EAPI void *evas_object_intercept_focus_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Focus_Set_Cb func) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Rectangle
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Adds a rectangle to the given evas.
|
|
* @param e The given evas.
|
|
* @return The new rectangle object.
|
|
*
|
|
* @ingroup Evas_Object_Rectangle
|
|
*/
|
|
EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
#include "canvas/evas_rectangle.eo.legacy.h"
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Image
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* Creates a new image object on the given Evas @p e canvas.
|
|
*
|
|
* @param e The given canvas.
|
|
* @return The created image object handle.
|
|
*
|
|
* @note If you intend to @b display an image somehow in a GUI,
|
|
* besides binding it to a real image file/source (with
|
|
* evas_object_image_file_set(), for example), you'll have to tell
|
|
* this image object how to fill its space with the pixels it can get
|
|
* from the source. See evas_object_image_filled_add(), for a helper
|
|
* on the common case of scaling up an image source to the whole area
|
|
* of the image object.
|
|
*
|
|
* @see evas_object_image_fill_set()
|
|
*
|
|
* Example:
|
|
* @code
|
|
* img = evas_object_image_add(canvas);
|
|
* evas_object_image_file_set(img, "/path/to/img", NULL);
|
|
* @endcode
|
|
*/
|
|
EAPI Evas_Object *evas_object_image_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
/**
|
|
* Creates a new image object that @b automatically scales its bound
|
|
* image to the object's area, on both axis.
|
|
*
|
|
* @param e The given canvas.
|
|
* @return The created image object handle.
|
|
*
|
|
* This is a helper function around evas_object_image_add() and
|
|
* evas_object_image_filled_set(). It has the same effect of applying
|
|
* those functions in sequence, which is a very common use case.
|
|
*
|
|
* @note Whenever this object gets resized, the bound image will be
|
|
* rescaled, too.
|
|
*
|
|
* @see evas_object_image_add()
|
|
* @see evas_object_image_filled_set()
|
|
* @see evas_object_image_fill_set()
|
|
*/
|
|
EAPI Evas_Object *evas_object_image_filled_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
/**
|
|
* Sets the data for an image from memory to be loaded
|
|
*
|
|
* This is the same as evas_object_image_file_set() but the file to be loaded
|
|
* may exist at an address in memory (the data for the file, not the filename
|
|
* itself). The @p data at the address is copied and stored for future use, so
|
|
* no @p data needs to be kept after this call is made. It will be managed and
|
|
* freed for you when no longer needed. The @p size is limited to 2 gigabytes
|
|
* in size, and must be greater than 0. A @c NULL @p data pointer is also
|
|
* invalid. Set the filename to @c NULL to reset to empty state and have the
|
|
* image file data freed from memory using evas_object_image_file_set().
|
|
*
|
|
* The @p format is optional (pass @c NULL if you don't need/use it). It is
|
|
* used to help Evas guess better which loader to use for the data. It may
|
|
* simply be the "extension" of the file as it would normally be on disk
|
|
* such as "jpg" or "png" or "gif" etc.
|
|
*
|
|
* @param obj The given image object.
|
|
* @param data The image file data address
|
|
* @param size The size of the image file data in bytes
|
|
* @param format The format of the file (optional), or @c NULL if not needed
|
|
* @param key The image key in file, or @c NULL.
|
|
*/
|
|
EAPI void evas_object_image_memfile_set(Evas_Object *obj, void *data, int size, char *format, char *key) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Set the native surface of a given image of the canvas
|
|
*
|
|
* @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 evas_object_image_native_surface_set(Evas_Object *obj, Evas_Native_Surface *surf) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Preload an image object's image data in the background
|
|
*
|
|
* @param obj The given image object.
|
|
* @param cancel @c EINA_FALSE will add it the preloading work queue,
|
|
* @c EINA_TRUE will remove it (if it was issued before).
|
|
*
|
|
* This function requests the preload of the data image in the
|
|
* background. The work is queued before being processed (because
|
|
* there might be other pending requests of this type).
|
|
*
|
|
* Whenever the image data gets loaded, Evas will call
|
|
* #EVAS_CALLBACK_IMAGE_PRELOADED registered callbacks on @p obj (what
|
|
* may be immediately, if the data was already preloaded before).
|
|
*
|
|
* Use @c EINA_TRUE for @p cancel on scenarios where you don't need
|
|
* the image data preloaded anymore.
|
|
*
|
|
* @note Any evas_object_show() call after evas_object_image_preload()
|
|
* will make the latter to be @b cancelled, with the loading process
|
|
* now taking place @b synchronously (and, thus, blocking the return
|
|
* of the former until the image is loaded). It is highly advisable,
|
|
* then, that the user preload an image with it being @b hidden, just
|
|
* to be shown on the #EVAS_CALLBACK_IMAGE_PRELOADED event's callback.
|
|
*/
|
|
EAPI void evas_object_image_preload(Evas_Object *obj, Eina_Bool cancel) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* Clear the source object on a proxy image object.
|
|
*
|
|
* @param obj Image object to clear source of.
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE on error.
|
|
*
|
|
* This is equivalent to calling evas_object_image_source_set() with a
|
|
* @c NULL source.
|
|
*/
|
|
EAPI Eina_Bool evas_object_image_source_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* Enable an image to be used as an alpha mask.
|
|
*
|
|
* This will set any flags, and discard any excess image data not used as an
|
|
* alpha mask.
|
|
*
|
|
* Note there is little point in using a image as alpha mask unless it has an
|
|
* alpha channel.
|
|
*
|
|
* @param obj Object to use as an alpha mask.
|
|
* @param ismask Use image as alphamask, must be true.
|
|
*/
|
|
EAPI void evas_object_image_alpha_mask_set(Evas_Object *obj, Eina_Bool ismask) EINA_ARG_NONNULL(1);
|
|
|
|
#include "canvas/evas_image.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Text
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Creates a new text object on the provided canvas.
|
|
*
|
|
* @param e The canvas to create the text object on.
|
|
* @return @c NULL on error, a pointer to a new text object on
|
|
* success.
|
|
*
|
|
* Text objects are for simple, single line text elements. If you want
|
|
* more elaborated text blocks, see @ref Evas_Object_Textblock.
|
|
*
|
|
* @see evas_object_text_font_source_set()
|
|
* @see evas_object_text_font_set()
|
|
* @see evas_object_text_text_set()
|
|
*/
|
|
EAPI Evas_Object *evas_object_text_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
#include "canvas/evas_text.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Textblock
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Adds a textblock to the given evas.
|
|
* @param e The given evas.
|
|
* @return The new textblock object.
|
|
*/
|
|
EAPI Evas_Object *evas_object_textblock_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
/**
|
|
* Return the plain version of the markup.
|
|
*
|
|
* Works as if you set the markup to a textblock and then retrieve the plain
|
|
* version of the text. i.e: <br> and <\n> will be replaced with \n, &...; with
|
|
* the actual char and etc.
|
|
*
|
|
* @param obj The textblock object to work with. (if @c NULL, tries the
|
|
* default).
|
|
* @param text The markup text (if @c NULL, return @c NULL).
|
|
* @return An allocated plain text version of the markup.
|
|
* @since 1.2
|
|
*/
|
|
EAPI char *evas_textblock_text_markup_to_utf8(const Evas_Object *obj, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC;
|
|
|
|
/**
|
|
* Return the markup version of the plain text.
|
|
*
|
|
* Replaces \\n -\> \<br/\> \\t -\> \<tab/\> and etc. Generally needed before you pass
|
|
* plain text to be set in a textblock.
|
|
*
|
|
* @param obj the textblock object to work with (if @c NULL, it just does the
|
|
* default behaviour, i.e with no extra object information).
|
|
* @param text The plain text (if @c NULL, return @c NULL).
|
|
* @return An allocated markup version of the plain text.
|
|
* @since 1.2
|
|
*/
|
|
EAPI char *evas_textblock_text_utf8_to_markup(const Evas_Object *obj, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC;
|
|
|
|
/**
|
|
* Clear the textblock object.
|
|
* @note Does *NOT* free the Evas object itself.
|
|
*
|
|
* @param obj the object to clear.
|
|
* @return nothing.
|
|
*/
|
|
EAPI void evas_object_textblock_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
|
|
|
|
#include "canvas/evas_textblock.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Grid
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Add a textgrid to the given Evas.
|
|
*
|
|
* @param e The given evas.
|
|
* @return The new textgrid object.
|
|
*
|
|
* This function adds a new textgrid object to the Evas @p e and returns the object.
|
|
*
|
|
* @since 1.7
|
|
*/
|
|
EAPI Evas_Object *evas_object_textgrid_add(Evas *e);
|
|
|
|
#include "canvas/evas_textgrid.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Line
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* Adds a new evas line object to the given evas.
|
|
* @param e The given evas.
|
|
* @return The new evas line object.
|
|
*/
|
|
EAPI Evas_Object *evas_object_line_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
#include "canvas/evas_line.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Polygon
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* Adds a new evas polygon object to the given evas.
|
|
* @param e The given evas.
|
|
* @return A new evas polygon object.
|
|
*/
|
|
EAPI Evas_Object *evas_object_polygon_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
#include "canvas/evas_polygon.eo.legacy.h"
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/**
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* Instantiates a new smart object described by @p s.
|
|
*
|
|
* @param e the canvas on which to add the object
|
|
* @param s the #Evas_Smart describing the smart object
|
|
* @return a new #Evas_Object handle
|
|
*
|
|
* This is the function one should use when defining the public
|
|
* function @b adding an instance of the new smart object to a given
|
|
* canvas. It will take care of setting all of its internals to work
|
|
* as they should, if the user set things properly, as seem on the
|
|
* #EVAS_SMART_SUBCLASS_NEW, for example.
|
|
*
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*/
|
|
EAPI Evas_Object *evas_object_smart_add(Evas *e, Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_MALLOC;
|
|
|
|
/**
|
|
* Set an Evas object as a member of a given smart object.
|
|
*
|
|
* @param obj The member object
|
|
* @param smart_obj The smart object
|
|
*
|
|
* Members will automatically be stacked and layered together with the
|
|
* smart object. The various stacking functions will operate on
|
|
* members relative to the other members instead of the entire canvas,
|
|
* since they now live on an exclusive layer (see
|
|
* evas_object_stack_above(), for more details).
|
|
*
|
|
* Any @p smart_obj object's specific implementation of the @c
|
|
* member_add() smart function will take place too, naturally.
|
|
*
|
|
* @see evas_object_smart_member_del()
|
|
* @see evas_object_smart_members_get()
|
|
*
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*/
|
|
EAPI void evas_object_smart_member_add(Evas_Object *obj, Evas_Object *smart_obj) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Removes a member object from a given smart object.
|
|
*
|
|
* @param obj the member object
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*
|
|
* This removes a member object from a smart object, if it was added
|
|
* to any. The object will still be on the canvas, but no longer
|
|
* associated with whichever smart object it was associated with.
|
|
*
|
|
* @see evas_object_smart_member_add() for more details
|
|
* @see evas_object_smart_members_get()
|
|
*/
|
|
EAPI void evas_object_smart_member_del(Evas_Object *obj) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* Add (register) a callback function to the smart event specified by
|
|
* @p event on the smart object @p obj.
|
|
*
|
|
* @param obj a smart object
|
|
* @param event the event's name string
|
|
* @param func the callback function
|
|
* @param data user data to be passed to the callback function
|
|
*
|
|
* Smart callbacks look very similar to Evas callbacks, but are
|
|
* implemented as smart object's custom ones.
|
|
*
|
|
* This function adds a function callback to an smart object when the
|
|
* event named @p event occurs in it. 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.
|
|
*
|
|
* A smart callback function must have the ::Evas_Smart_Cb prototype
|
|
* definition. The first parameter (@p data) in this definition will
|
|
* have the same value passed to evas_object_smart_callback_add() as
|
|
* the @p data parameter, at runtime. The second parameter @p obj is a
|
|
* handle to the object on which the event occurred. The third
|
|
* parameter, @p event_info, is a pointer to data which is totally
|
|
* dependent on the smart object's implementation and semantic for the
|
|
* given event.
|
|
*
|
|
* There is an infrastructure for introspection on smart objects'
|
|
* events (see evas_smart_callbacks_descriptions_get()), but no
|
|
* internal smart objects on Evas implement them yet.
|
|
*
|
|
* @see @ref Evas_Smart_Object_Group_Callbacks for more details.
|
|
*
|
|
* @see evas_object_smart_callback_del()
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*/
|
|
EAPI void evas_object_smart_callback_add(Evas_Object *obj, const char *event, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2, 3);
|
|
|
|
/**
|
|
* Add (register) a callback function to the smart event specified by
|
|
* @p event on the smart object @p obj. Except for the priority field,
|
|
* it's exactly the same as @ref evas_object_smart_callback_add
|
|
*
|
|
* @param obj a smart object
|
|
* @param event the event's name string
|
|
* @param priority The priority of the callback, lower values called first.
|
|
* @param func the callback function
|
|
* @param data user data to be passed to the callback function
|
|
*
|
|
* @see evas_object_smart_callback_add
|
|
* @since 1.1
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*/
|
|
EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, const char *event, Evas_Callback_Priority priority, Evas_Smart_Cb func, const void *data);
|
|
|
|
/**
|
|
* Delete (unregister) a callback function from the smart event
|
|
* specified by @p event on the smart object @p obj.
|
|
*
|
|
* @param obj a smart object
|
|
* @param event the event's name string
|
|
* @param func the callback function
|
|
* @return the data pointer
|
|
*
|
|
* This function removes <b>the first</b> added smart callback on the
|
|
* object @p obj matching the event name @p event and the registered
|
|
* function pointer @p func. If the removal is successful it will also
|
|
* return the data pointer that was passed to
|
|
* evas_object_smart_callback_add() (that will be the same as the
|
|
* parameter) when the callback(s) was(were) added to the canvas. If
|
|
* not successful @c NULL will be returned.
|
|
*
|
|
* @see evas_object_smart_callback_add() for more details.
|
|
*
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*/
|
|
EAPI void *evas_object_smart_callback_del(Evas_Object *obj, const char *event, Evas_Smart_Cb func) EINA_ARG_NONNULL(1, 2, 3);
|
|
|
|
/**
|
|
* Delete (unregister) a callback function from the smart event
|
|
* specified by @p event on the smart object @p obj.
|
|
*
|
|
* @param obj a smart object
|
|
* @param event the event's name string
|
|
* @param func the callback function
|
|
* @param data the data pointer that was passed to the callback
|
|
* @return the data pointer
|
|
*
|
|
* This function removes <b>the first</b> added smart callback on the
|
|
* object @p obj matching the event name @p event, the registered
|
|
* function pointer @p func and the callback data pointer @p data. If
|
|
* the removal is successful it will also return the data pointer that
|
|
* was passed to evas_object_smart_callback_add() (that will be the same
|
|
* as the parameter) when the callback(s) was(were) added to the canvas.
|
|
* If not successful @c NULL will be returned. A common use would be to
|
|
* remove an exact match of a callback
|
|
*
|
|
* @see evas_object_smart_callback_add() for more details.
|
|
* @since 1.2
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*
|
|
* @note To delete all smart event callbacks which match @p type and @p func,
|
|
* use evas_object_smart_callback_del().
|
|
*/
|
|
EAPI void *evas_object_smart_callback_del_full(Evas_Object *obj, const char *event, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2, 3);
|
|
|
|
/**
|
|
* Call a given smart callback on the smart object @p obj.
|
|
*
|
|
* @param obj the smart object
|
|
* @param event the event's name string
|
|
* @param event_info pointer to an event specific struct or information to
|
|
* pass to the callback functions registered on this smart event
|
|
*
|
|
* This should be called @b internally, from the smart object's own
|
|
* code, when some specific event has occurred and the implementor
|
|
* wants is to pertain to the object's events API (see @ref
|
|
* Evas_Smart_Object_Group_Callbacks). The documentation for the smart
|
|
* object should include a list of possible events and what type of @p
|
|
* event_info to expect for each of them. Also, when defining an
|
|
* #Evas_Smart_Class, smart object implementors are strongly
|
|
* encouraged to properly set the Evas_Smart_Class::callbacks
|
|
* callbacks description array, so that the users of the smart object
|
|
* can have introspection on its events API <b>at run time</b>.
|
|
*
|
|
* @ingroup Evas_Smart_Object_Group
|
|
*/
|
|
EAPI void evas_object_smart_callback_call(Evas_Object *obj, const char *event, void *event_info) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Retrieve an Evas smart object's interface, by name string pointer.
|
|
*
|
|
* @param obj An Evas smart object.
|
|
* @param name Name string of the desired interface, which must be the
|
|
* same pointer used at the interface's declarion, when
|
|
* creating the smart object @a obj.
|
|
*
|
|
* @since 1.7
|
|
*
|
|
* @return The interface's handle pointer, if found, @c NULL
|
|
* otherwise.
|
|
*/
|
|
EAPI const void *evas_object_smart_interface_get(const Evas_Object *obj, const char *name);
|
|
|
|
/**
|
|
* Retrieve an Evas smart object interface's <b>private data</b>.
|
|
*
|
|
* @param obj An Evas smart object.
|
|
* @param iface The given object's interface handle.
|
|
*
|
|
* @since 1.7
|
|
*
|
|
* @return The object interface's private data blob pointer, if found,
|
|
* @c NULL otherwise.
|
|
*/
|
|
EAPI void *evas_object_smart_interface_data_get(const Evas_Object *obj, const Evas_Smart_Interface *iface);
|
|
|
|
/**
|
|
* This gets the internal counter that counts the number of smart calculations
|
|
*
|
|
* @param e The canvas to get the calculate counter from
|
|
*
|
|
* Whenever evas performs smart object calculations on the whole canvas
|
|
* it increments a counter by 1. This is the smart object calculate counter
|
|
* that this function returns the value of. It starts at the value of 0 and
|
|
* will increase (and eventually wrap around to negative values and so on) by
|
|
* 1 every time objects are calculated. You can use this counter to ensure
|
|
* you don't re-do calculations withint the same calculation generation/run
|
|
* if the calculations maybe cause self-feeding effects.
|
|
*
|
|
* @ingroup Evas_Smart_Object_Group
|
|
* @since 1.1
|
|
*/
|
|
EAPI int evas_smart_objects_calculate_count_get(const Evas *e);
|
|
|
|
#include "canvas/evas_object_smart.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Smart_Object_Clipped
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* Get the clipper object for the given clipped smart object.
|
|
*
|
|
* @param obj the clipped smart object to retrieve associated clipper
|
|
* from.
|
|
* @return the clipper object.
|
|
*
|
|
* Use this function if you want to change any of this clipper's
|
|
* properties, like colors.
|
|
*
|
|
* @see evas_object_smart_clipped_smart_add()
|
|
*/
|
|
EAPI Evas_Object *evas_object_smart_clipped_clipper_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
|
|
#include "canvas/evas_smart_clipped.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Box
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Add a new box object on the provided canvas.
|
|
*
|
|
* @param evas The canvas to create the box object on.
|
|
* @return @c NULL on error, a pointer to a new box object on
|
|
* success.
|
|
*
|
|
* After instantiation, if a box object hasn't its layout function
|
|
* set, via evas_object_box_layout_set(), it will have it by default
|
|
* set to evas_object_box_layout_horizontal(). The remaining
|
|
* properties of the box must be set/retrieved via
|
|
* <c>evas_object_box_{h,v}_{align,padding}_{get,set)()</c>.
|
|
*/
|
|
EAPI Evas_Object *evas_object_box_add(Evas *evas) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
/**
|
|
* Get a property's value (by its given numerical identifier), on a
|
|
* given box child element -- by a variable argument list
|
|
*
|
|
* @param o The box parenting the child element
|
|
* @param opt The box option structure bound to the child box element
|
|
* to get a property from
|
|
* @param property The numerical ID of the given property
|
|
* @param args The variable argument list with pointers to where to
|
|
* store the values of this property. They @b must point to variables
|
|
* of the same type the user has defined for them.
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
|
|
*
|
|
* This is a variable argument list variant of the
|
|
* evas_object_box_option_property_get(). See its documentation for
|
|
* more details.
|
|
*/
|
|
EAPI Eina_Bool evas_object_box_option_property_vget(const Evas_Object *o, Evas_Object_Box_Option *opt, int property, va_list args) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Set a property value (by its given numerical identifier), on a
|
|
* given box child element -- by a variable argument list
|
|
*
|
|
* @param o The box parenting the child element
|
|
* @param opt The box option structure bound to the child box element
|
|
* to set a property on
|
|
* @param property The numerical ID of the given property
|
|
* @param args The variable argument list implementing the value to
|
|
* be set for this property. It @b must be of the same type the user has
|
|
* defined for it.
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
|
|
*
|
|
* This is a variable argument list variant of the
|
|
* evas_object_box_option_property_set(). See its documentation for
|
|
* more details.
|
|
*/
|
|
EAPI Eina_Bool evas_object_box_option_property_vset(Evas_Object *o, Evas_Object_Box_Option *opt, int property, va_list args) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Set a property value (by its given numerical identifier), on a
|
|
* given box child element
|
|
*
|
|
* @param o The box parenting the child element
|
|
* @param opt The box option structure bound to the child box element
|
|
* to set a property on
|
|
* @param property The numerical ID of the given property
|
|
* @param ... (List of) actual value(s) to be set for this
|
|
* property. It (they) @b must be of the same type the user has
|
|
* defined for it (them).
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
|
|
*
|
|
* @note This call won't do anything for a canonical Evas box. Only
|
|
* users which have @b subclassed it, setting custom box items options
|
|
* (see #Evas_Object_Box_Option) on it, would benefit from this
|
|
* function. They'd have to implement it and set it to be the
|
|
* _Evas_Object_Box_Api::property_set smart class function of the box,
|
|
* which is originally set to @c NULL.
|
|
*
|
|
* @note This function will internally create a variable argument
|
|
* list, with the values passed after @p property, and call
|
|
* evas_object_box_option_property_vset() with this list and the same
|
|
* previous arguments.
|
|
*/
|
|
EAPI Eina_Bool evas_object_box_option_property_set(Evas_Object *o, Evas_Object_Box_Option *opt, int property, ...) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Get a property's value (by its given numerical identifier), on a
|
|
* given box child element
|
|
*
|
|
* @param o The box parenting the child element
|
|
* @param opt The box option structure bound to the child box element
|
|
* to get a property from
|
|
* @param property The numerical ID of the given property
|
|
* @param ... (List of) pointer(s) where to store the value(s) set for
|
|
* this property. It (they) @b must point to variable(s) of the same
|
|
* type the user has defined for it (them).
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
|
|
*
|
|
* @note This call won't do anything for a canonical Evas box. Only
|
|
* users which have @b subclassed it, getting custom box items options
|
|
* (see #Evas_Object_Box_Option) on it, would benefit from this
|
|
* function. They'd have to implement it and get it to be the
|
|
* _Evas_Object_Box_Api::property_get smart class function of the
|
|
* box, which is originally get to @c NULL.
|
|
*
|
|
* @note This function will internally create a variable argument
|
|
* list, with the values passed after @p property, and call
|
|
* evas_object_box_option_property_vget() with this list and the same
|
|
* previous arguments.
|
|
*/
|
|
EAPI Eina_Bool evas_object_box_option_property_get(const Evas_Object *o, Evas_Object_Box_Option *opt, int property, ...) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* Get the list of children objects in a given box object.
|
|
*
|
|
* @param o The box to retrieve an items list from
|
|
* @return A list of @p o's child objects, on success, or @c NULL,
|
|
* on errors (or if it has no child objects)
|
|
*
|
|
* The returned list should be freed with @c eina_list_free() when you
|
|
* no longer need it.
|
|
*
|
|
* @note This is a duplicate of the list kept by the box internally.
|
|
* It's up to the user to destroy it when it no longer needs it.
|
|
* It's possible to remove objects from the box when walking
|
|
* this list, but these removals won't be reflected on it.
|
|
*/
|
|
EAPI Eina_List *evas_object_box_children_get(const Evas_Object *o) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
#include "canvas/evas_box.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Table
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Create a new table.
|
|
*
|
|
* @param evas Canvas in which table will be added.
|
|
*/
|
|
EAPI Evas_Object *evas_object_table_add(Evas *evas) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
/**
|
|
* Get the child of the table at the given coordinates
|
|
*
|
|
* @note This does not take into account col/row spanning
|
|
*/
|
|
EAPI Evas_Object *evas_object_table_child_get(const Evas_Object *o, unsigned short col, unsigned short row) EINA_ARG_NONNULL(1);
|
|
|
|
#include "canvas/evas_table.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @ingroup Evas_Object_Grid
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* Create a new grid.
|
|
*
|
|
* It's set to a virtual size of 1x1 by default and add children with
|
|
* evas_object_grid_pack().
|
|
* @since 1.1
|
|
*/
|
|
EAPI Evas_Object *evas_object_grid_add(Evas *evas) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
|
|
|
|
#include "canvas/evas_grid.eo.legacy.h"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @since 1.8
|
|
*
|
|
* Adds an output to the canvas
|
|
*
|
|
* @parem e The canvas to add the output to
|
|
* @return The output
|
|
*
|
|
* @see evas_out_engine_info_set
|
|
* @see evas_output_viewport_set
|
|
* @see evas_output_size_set
|
|
*/
|
|
EAPI Evas_Out *evas_out_add(Evas *e);
|
|
|
|
/**
|
|
* @since 1.8
|
|
*
|
|
* Deletes an output
|
|
*
|
|
* @parem evo The output object
|
|
*
|
|
* @see evas_out_add
|
|
*/
|
|
EAPI void evas_output_del(Evas_Out *evo);
|
|
|
|
#include "canvas/evas_out.eo.legacy.h"
|