Ecore_Animator *_edje_timer = NULL;
Eina_List *_edje_animators = NULL;
-/************************** API Routines **************************/
-/* FIXDOC: Expand */
-/** Set the frametime
- * @param t The frametime
+/*============================================================================*
+ * API *
+ *============================================================================*/
+
+/**
+ * @addtogroup Edje_program_Group Program
+ *
+ * @brief These functions provide an abstraction layer between the
+ * application code and the interface, while allowing extremely
+ * flexible dynamic layouts and animations.
+ *
+ * For more information, you can look at the @ref tutorial_list_page.
+ *
+ * @{
+ */
+
+/**
+ * @brief Set edje trasitions' frame time.
+ *
+ * @param t The frame time, in seconds. Default value is 1/30.
+ *
+ * This function sets the edje built-in animations' frame time (thus,
+ * affecting their resolution) by calling
+ * ecore_animator_frametime_set(). This frame time can be retrieved
+ * with edje_frametime_get().
+ *
+ * @see edje_frametime_get()
*
- * Sets the global frametime in seconds, by default this is 1/30.
*/
EAPI void
edje_frametime_set(double t)
ecore_animator_frametime_set(t);
}
-/* FIXDOC: Expand */
-/** Get the frametime
- * @return The frametime
+/**
+ * @brief Get edje trasitions' frame time.
+ *
+ * @return The frame time, in seconds.
+ *
+ * This function returns the edje frame time set by
+ * edje_frametime_set().
+ *
+ * @see edje_frametime_set()
*
- * Returns the frametime in seconds, by default this is 1/30.
*/
EAPI double
edje_frametime_get(void)
return ecore_animator_frametime_get();
}
-/* FIXDOC: Expand */
-/** Add a callback for a signal emitted by @a obj.
- * @param obj A valid Evas_Object handle
- * @param emission The signal name
- * @param source The signal source
- * @param func The callback function to be executed when the signal is emitted
- * @param data A pointer to data to pass in to the callback function
+/**
+ * @brief Add a callback for a signal emitted by @a obj.
+ *
+ * @param obj A valid Evas_Object handle.
+ * @param emission The signal's name.
+ * @param source The signal's source.
+ * @param func The callback function to be executed when the signal is
+ * emitted.
+ * @param data A pointer to data to pass in to the callback function.
*
* Connects a callback function to a signal emitted by @a obj.
* In EDC, a program can emit a signal as follows:
* edje_object_callback_add(obj, "a_signal", "a_source", cb_signal, data);
* @endcode
*
- * Here, @a data is an arbitrary pointer to be used as desired.
- * Note that @a emission and @a source correspond respectively to first and
- * second parameters to the SIGNAL_EMIT action.
+ * Here, @a data is an arbitrary pointer to be used as desired. Note
+ * that @a emission and @a source correspond respectively to the first
+ * and the second parameters at the SIGNAL_EMIT action.
*
- * Internal edje signals can also be attached to, and globs can be in either
- * the emission or source name. e.g.
+ * Internal edje signals can also be attached to, and globs can occur
+ * in either the emission or source name, e.g.
*
* @code
* edje_object_callback_add(obj, "mouse,down,*", "button.*", NULL);
* @endcode
*
* Here, any mouse down events on an edje part whose name begins with
- * "button." will trigger the callback. The actual signal and source name
- * will be passed in to the @a emission and @a source parameters of the
- * callback function. (e.g. "mouse,down,2" and "button.close").
+ * "button." will trigger the callback. The actual signal and source
+ * names will be passed in to the @a emission and @a source parameters
+ * of the callback function (e.g. "mouse,down,2" and "button.close").
*/
EAPI void
edje_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data)
_edje_callbacks_patterns_clean(ed);
}
-/** Remove a callback from an object
- * @param obj A valid Evas_Object handle
- * @param emission the emission string
- * @param source the source string
- * @param func the callback function
- * @return the data pointer
+/**
+ * @brief Remove a signal-triggered callback from an object.
+ *
+ * @param obj A valid Evas_Object handle.
+ * @param emission The emission string.
+ * @param source The source string.
+ * @param func The callback function.
+ * @return The data pointer
+ *
+ * This function removes a callback, previously attached to the
+ * emittion of a signal, from the object @a obj. The parameters @a
+ * emission, @a source and @a func must match exactly those passed to
+ * a previous call to edje_object_signal_callback_add(). The data
+ * pointer that was passed to this call will be returned.
+ *
+ * @see edje_object_signal_callback_add().
*
- * Removes a callback from an object. The parameters @a emission, @a source
- * and @a func must match exactly those passed to a previous call to
- * edje_object_signal_callback_add(). The data pointer that was passed to
- * this call will be returned.
*/
EAPI void *
edje_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source))
return NULL;
}
-/* FIXDOC: Verify/Expand */
-/** Send a signal to the Edje object
- * @param obj A vaild Evas_Object handle
- * @param emission The signal
- * @param source The signal source
- *
- * This sends a signal to the edje object.
+/**
+ * @brief Send a signal to an edje object.
*
- * An edje program can respond to a signal by specifying matching 'signal'
- * and 'source' fields.
+ * @param obj A valid Evas_Object handle.
+ * @param emission The signal's name.
+ * @param source The signal's source.
*
- * E.g.
+ * This function sends a signal to the object @a obj. An edje program
+ * can respond to a signal by specifying matching 'signal' and
+ * 'source' fields.
*
* @code
* edje_object_signal_emit(obj, "a_signal", "");
* @endcode
*
- * will trigger a program whose edc is:
+ * will trigger a program whose EDC block is:
*
* @code
* program {
* }
* @endcode
*
- * FIXME should this signal be sent to children also?
+ * FIXME: should this signal be sent to children also?
*/
EAPI void
edje_object_signal_emit(Evas_Object *obj, const char *emission, const char *source)
}
/* FIXDOC: Verify/Expand */
-/** Set the Edje to play or pause
- * @param obj A valid Evas_Object handle
- * @param play Play instruction (1 to play, 0 to pause)
+/**
+ * @brief Set the edje object to playing or paused states.
+ *
+ * @param obj A valid Evas_Object handle.
+ * @param play Object state (1 to playing, 0 to pauseed).
+ *
+ * This function sets the edje object @a obj to playing or paused
+ * states, depending on the parameter @a play. This has no effect if
+ * the object was already at that state.
+ *
+ * @see edje_object_play_get().
*
- * This sets the Edje to play or pause depending on the parameter.
- * This has no effect if the Edje is already in that state.
*/
EAPI void
edje_object_play_set(Evas_Object *obj, int play)
}
}
-/* FIXDOC: Verify/Expand */
-/** Get the Edje play/pause state
- * @param obj A valid Evas_Object handle
- * @return 0 if Edje not connected, Edje delete_me, or Edje paused\n
- * 1 if Edje set to play
+/**
+ * @brief Get the edje object's play/pause state.
+ *
+ * @param obj A valid Evas_Object handle.
+ * @return @c 0 if the object is not connected, its @c delete_me flag
+ * is set, or it is at paused state; @c 1 if the object is at playing
+ * state.
+ *
+ * This function tells if an edje object is playing or not. This state
+ * is set by edje_object_play_set().
+ *
+ * @see edje_object_play_set().
+ *
*/
EAPI int
edje_object_play_get(const Evas_Object *obj)
}
/* FIXDOC: Verify/Expand */
-/** Set Animation state
- * @param obj A valid Evas_Object handle
- * @param on Animation State
+/**
+ * @brief Set the object's animation state.
+ *
+ * @param obj A valid Evas_Object handle.
+ * @param on Animation State.
+ *
+ * This function starts or stops an edje object's animation. The
+ * information if it's runnig can be retrieved by
+ * edje_object_animation_get().
+ *
+ * @see edje_object_animation_get()
*
- * Stop or start an Edje animation.
*/
EAPI void
edje_object_animation_set(Evas_Object *obj, int on)
_edje_unblock(ed);
}
-/* FIXDOC: Verify/Expand */
-/** Get the animation state
- * @param obj A valid Evas_Object handle
- * @return 0 on Error or if not animated\n
- * 1 if animated
+/**
+ * @brief Get the edje object's animation state.
+ *
+ * @param obj A valid Evas_Object handle.
+ * @return @c 0 on error or if object is not animated; @c 1 if animated.
+ *
+ * This function returns if the animation is playing or not. The
+ * animation state is set by edje_object_play_set().
+ *
+ * @see edje_object_animation_set().
+ *
*/
+
EAPI int
edje_object_animation_get(const Evas_Object *obj)
{
/************************** API Routines **************************/
-/* FIXDOC: These all need to be looked over, Verified/Expanded upon.
- I just got lazy and stopped putting FIXDOC next to each function in this file. */
-
//#define FASTFREEZE 1
-/** Freeze all Edje objects in the current process.
+/**
+ * @brief Freeze Edje objects.
+ *
+ * This function freezes every edje objects in the current process.
+ *
+ * See edje_object_freeze().
*
- * See edje_object_freeze() for more.
*/
EAPI void
edje_freeze(void)
{
-#ifdef FASTFREEZE
+#ifdef FASTFREEZE
_edje_freeze_val++;
printf("fr ++ ->%i\n", _edje_freeze_val);
-#else
+#else
// FIXME: could just have a global freeze instead of per object
// above i tried.. but this broke some things. notable e17's menus. why?
Eina_List *l;
EINA_LIST_FOREACH(_edje_edjes, l, data)
edje_object_freeze(data);
-#endif
+#endif
}
-#ifdef FASTFREEZE
+#ifdef FASTFREEZE
static void
_edje_thaw_edje(Edje *ed)
{
int i;
-
+
for (i = 0; i < ed->table_parts_size; i++)
{
Edje_Real_Part *rp;
-
+
rp = ed->table_parts[i];
if (rp->part->type == EDJE_PART_TYPE_GROUP && rp->swallowed_object)
{
Edje *ed2;
-
+
ed2 = _edje_fetch(rp->swallowed_object);
if (ed2) _edje_thaw_edje(ed2);
}
}
#endif
-/** Thaw all Edje objects in the current process.
+/**
+ * @brief Thaw edje objects.
+ *
+ * This function thaw all edje object in the current process.
+ *
+ * See edje_object_thaw().
*
- * See edje_object_thaw() for more.
*/
EAPI void
edje_thaw(void)
{
Evas_Object *data;
-#ifdef FASTFREEZE
+#ifdef FASTFREEZE
_edje_freeze_val--;
printf("fr -- ->%i\n", _edje_freeze_val);
if ((_edje_freeze_val <= 0) && (_edje_freeze_calc_count > 0))
EINA_LIST_FOREACH(_edje_edjes, l, data)
edje_object_thaw(data);
-#endif
+#endif
}
-/* FIXDOC: Expand */
+/**
+ * @brief Set the edje append fontset.
+ *
+ * This function set the edje append fontset.
+ *
+ */
EAPI void
edje_fontset_append_set(const char *fonts)
{
_edje_fontset_append = fonts ? strdup(fonts) : NULL;
}
-/* FIXDOC: Expand */
+/**
+ * @brief Get the edje append fontset.
+ *
+ * @return The edje append fontset.
+ *
+ * This function returns the edje append fontset set by
+ * edje_fontset_append_set() function.
+ *
+ * @see edje_fontset_append_set().
+ *
+ */
EAPI const char *
edje_fontset_append_get(void)
{
return _edje_fontset_append;
}
+/**
+ * @brief Set edje's global scaling factor.
+ *
+ * @param The edje (global) scale factor. The defaul is 1.0.
+ *
+ * Edje allows one to build scalable interfaces. Scale factors, which
+ * are set to neutral values by default (no scaling, actual sizes),
+ * are of two types: global and individual. Edje's global scaling
+ * factor will affect all its objects which hadn't their individual
+ * scaling factors altered from the default value. If they had it set
+ * differently, that factor will override the global one.
+ *
+ * Scaling affects the values of min/max object sizes, which are
+ * multiplied by it. Font sizes are scaled, too.
+ *
+ * This property can be retrieved with edje_scale_get().
+ *
+ * @see edje_scale_get().
+ *
+ */
EAPI void
edje_scale_set(double scale)
{
- Eina_List *l;
+ Eina_List *l;
Evas_Object *data;
if (_edje_scale == scale) return;
edje_object_calc_force(data);
}
+/**
+ * @brief Get edje's global scaling factor.
+ *
+ * @return The edje (global) scale factor. The defaul is 1.0.
+ *
+ * This function returns edje's global scale factor, which can be set
+ * by edje_scale_set().
+ *
+ * @see edje_scale_set().
+ *
+ */
EAPI double
edje_scale_get(void)
{
return _edje_scale;
}
+/**
+ * @brief Set the edje object's scaling factor.
+ *
+ * @param The edje object's reference.
+ * @param The edje object scale factor. The defaul is 1.0.
+ *
+ * This function sets the individual scale factor of the @a obj edje
+ * object. This property (or edje's global scale factor, when
+ * applicable), will affect this object's parts. However, only parts
+ * which, at the EDC language level, were declared which the "scale"
+ * attribute set to 1 (default is zero) will be affected.
+ *
+ * This scale factor can be retrieved with edje_object_scale_get().
+ * @see edje_object_scale_get().
+ *
+ */
EAPI void
edje_object_scale_set(Evas_Object *obj, double scale)
{
edje_object_calc_force(obj);
}
+/**
+ * @brief Get the edje object's scaling factor.
+ *
+ * @param The edje object's reference.
+ *
+ * This function returns the individual scale factor of the @a obj
+ * edje object, which can be set by edje_object_scale_set().
+ *
+ * @see edje_object_scale_set().
+ *
+ */
EAPI double
edje_object_scale_get(const Evas_Object *obj)
{
return ed->scale;
}
-/* FIXDOC: Verify/Expand */
-/** Get Edje object data
+/**
+ * @brief Get Edje object data.
+ *
* @param obj A valid Evas_Object handle
* @param key The data key
* @return The data string
*
- * This fetches data specified at the object level.
+ * This function fetches data specified at the object level.
*
- * In EDC this comes from a data block within the group block that @a obj
- * was loaded from. E.g.
+ * In EDC this comes from a data block within the group block that @a
+ * obj was loaded from. E.g.
*
* @code
* collections {
return NULL;
}
-/* FIXDOC: Verify/Expand */
-/** Freeze object
+/**
+ * @brief Freeze object.
+ *
* @param obj A valid Evas_Object handle
- * @return The frozen state\n
- * 0 on Error
+ * @return The frozen state or 0 on Error
+ *
+ * This function puts all changes on hold. Successive freezes will
+ * nest, requiring an equal number of thaws.
*
- * This puts all changes on hold. Successive freezes will nest,
- * requiring an equal number of thaws.
*/
EAPI int
edje_object_freeze(Evas_Object *obj)
return _edje_freeze(ed);
}
-/** Thaw object
+/**
+ * @brief Thaw object.
+ *
* @param obj A valid Evas_Object handle
- * @return The frozen state\n
- * 0 on Error
+ * @return The frozen state or 0 on Error
*
* This allows frozen changes to occur.
+ *
*/
EAPI int
edje_object_thaw(Evas_Object *obj)
return _edje_thaw(ed);
}
-/** Set Edje color class
+/**
+ * @brief Set Edje color class.
+ *
* @param color_class
* @param r Object Red value
* @param g Object Green value
* @param b3 Shadow Blue value
* @param a3 Shadow Alpha value
*
- * Sets the color values for a process level color class. This will cause all
- * edje parts in the current process that have the specified color class to
- * have their colors multiplied by these values. (Object level color classes
- * set by edje_object_color_class_set() will override the values set by this
+ * This function sets the color values for a process level color
+ * class. This will cause all edje parts in the current process that
+ * have the specified color class to have their colors multiplied by
+ * these values. (Object level color classes set by
+ * edje_object_color_class_set() will override the values set by this
* function).
*
- * The first color is the object, the second is the text outline, and the
- * third is the text shadow. (Note that the second two only apply to text parts)
+ * The first color is the object, the second is the text outline, and
+ * the third is the text shadow. (Note that the second two only apply
+ * to text parts).
+ *
+ * @see edje_color_class_set().
+ *
*/
EAPI void
edje_color_class_set(const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3)
}
/**
+ * @brief Delete edje color class.
+ *
* @param color_class
*
- * Deletes any values at the process level for the specified color class.
+ * This function deletes any values at the process level for the
+ * specified color class.
+ *
*/
void
edje_color_class_del(const char *color_class)
}
/**
- * Lists all color classes known about by the current process.
+ * @brief Lists color classes.
+ *
+ * @return A list of color class names (strings). These strings and
+ * the list must be free()'d by the caller.
+ *
+ * This function lists all color classes known about by the current
+ * process.
*
- * @return A list of color class names (strings). These strings and the list
- * must be free()'d by the caller.
*/
Eina_List *
edje_color_class_list(void)
return EINA_TRUE;
}
-/** Sets the object color class
+/**
+ * @brief Sets the object color class.
+ *
* @param obj A valid Evas_Object handle
* @param color_class
* @param r Object Red value
* @param b3 Shadow Blue value
* @param a3 Shadow Alpha value
*
- * Sets the color values for an object level color class. This will cause all
- * edje parts in the specified object that have the specified color class to
- * have their colors multiplied by these values.
+ * This function sets the color values for an object level color
+ * class. This will cause all edje parts in the specified object that
+ * have the specified color class to have their colors multiplied by
+ * these values.
+ *
+ * The first color is the object, the second is the text outline, and
+ * the third is the text shadow. (Note that the second two only apply
+ * to text parts).
*
- * The first color is the object, the second is the text outline, and the
- * third is the text shadow. (Note that the second two only apply to text parts)
*/
EAPI void
edje_object_color_class_set(Evas_Object *obj, const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3)
}
/**
- * @param color_class
+ * @brief Delete the object color class.
+ *
+ * @param color_class The color class to be deleted.
+ *
+ * This function deletes any values at the object level for the
+ * specified object and color class.
*
- * Deletes any values at the object level for the specified object and
- * color class.
*/
void
edje_object_color_class_del(Evas_Object *obj, const char *color_class)
_edje_recalc(ed);
}
-/** Set the Edje text class
- * @param text_class The text class name ?!
+/**
+ * @brief Set the Edje text class.
+ *
+ * @param text_class The text class name
* @param font The font name
* @param size The font size
*
- * This sets updates all edje members which belong to this text class
- * with the new font attributes.
+ * This function sets updates all edje members which belong to this
+ * text class with the new font attributes.
+ *
+ * @see edje_text_class_get().
+ *
*/
EAPI void
edje_text_class_set(const char *text_class, const char *font, Evas_Font_Size size)
}
/**
- * @param text_class
+ * @brief Delete the text class.
+ *
+ * @param text_class The text class name string
+ *
+ * This function deletes any values at the process level for the
+ * specified text class.
*
- * Deletes any values at the process level for the specified text class.
*/
void
edje_text_class_del(const char *text_class)
}
/**
- * Lists all text classes known about by the current process.
+ * @brief List text classes.
+ *
+ * @return A list of text class names (strings). These strings are
+ * stringshares and the list must be free()'d by the caller.
+ *
+ * This function lists all text classes known about by the current
+ * process.
*
- * @return A list of text class names (strings). These strings are stringshares and
- * the list must be free()'d by the caller.
*/
Eina_List *
edje_text_class_list(void)
return EINA_TRUE;
}
-/** Sets Edje text class
+/**
+ * @brief Sets Edje text class.
+ *
* @param obj A valid Evas_Object handle
* @param text_class The text class name
* @param font Font name
* @param size Font Size
*
- * Sets the text class for the Edje.
+ * This function sets the text class for the Edje.
+ *
*/
EAPI void
edje_object_text_class_set(Evas_Object *obj, const char *text_class, const char *font, Evas_Font_Size size)
_edje_recalc(ed);
}
-/** Check if Edje part exists
+/**
+ * @brief Check if Edje part exists.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name to check
- * @return 0 on Error\n
- * 1 if Edje part exists
+ *
+ * @return 0 on Error, 1 if Edje part exists.
+ *
+ * This function returns if a part exists in the edje.
+ *
*/
EAPI int
edje_object_part_exists(const Evas_Object *obj, const char *part)
}
/**
- * Gets the Evas_Object corresponding to a given part.
- * You should never modify the state of the returned object
- * (with evas_object_move() or evas_object_hide() for example),
- * but you can safely query info about its current state
- * (with evas_object_visible_get() or evas_object_color_get() for example)
+ * @brief Gets the evas object from a part.
*
* @param obj A valid Evas_Object handle
* @param part The Edje part
- * @return Returns the Evas_Object corresponding to the given part,
- * or NULL on failure (if the part doesn't exist)
+ * @return Returns the Evas_Object corresponding to the given part, or
+ * NULL on failure (if the part doesn't exist)
+ *
+ * This functio gets the Evas_Object corresponding to a given part.
+ *
+ * You should never modify the state of the returned object (with
+ * evas_object_move() or evas_object_hide() for example), but you can
+ * safely query info about its current state (with
+ * evas_object_visible_get() or evas_object_color_get() for example)
+ *
**/
EAPI const Evas_Object *
edje_object_part_object_get(const Evas_Object *obj, const char *part)
return rp->object;
}
-/** Get the geometry of an Edje part
+/**
+ * @brief Get the geometry of an Edje part.
+ *
* @param obj A valid Evas_Object handle
* @param part The Edje part
* @param x The x coordinate pointer
* @param w The width pointer
* @param h The height pointer
*
- * Gets the geometry of an Edje part
+ * This function gets the geometry of an Edje part.
*
* It is valid to pass NULL as any of @a x, @a y, @a w or @a h, whose
* values you are uninterested in.
}
/* FIXDOC: New Function */
+/**
+ * @brief Set the object text callback.
+ *
+ * @param obj A valid Evas_Object handle
+ * @param func The callback function to handle the text change
+ * @param data The data associated to the callback function.
+ *
+ * This function gets the geometry of an Edje part
+ *
+ * It is valid to pass NULL as any of @a x, @a y, @a w or @a h, whose
+ * values you are uninterested in.
+ *
+ */
EAPI void
edje_object_text_change_cb_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj, const char *part), void *data)
{
_edje_object_part_text_raw_set(obj, rp, part, text);
}
-/** Returns the text of the object part
+/**
+ * @brief Return the text of the object part.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
+ *
* @return The text string
+ *
+ * This function returns the text associated to the object part.
+ *
*/
EAPI const char *
edje_object_part_text_get(const Evas_Object *obj, const char *part)
return ret;
}
-/** Sets the raw (non escaped) text for an object part.
- *
- * This will do escape for you if it is a TEXTBLOCK part, that is, if
- * text contain tags, these tags will not be interpreted/parsed by
- * TEXTBLOCK.
+/**
+ * @brief Sets the raw (non escaped) text for an object part.
*
* @param obj A valid Evas Object handle
* @param part The part name
* @param text The text string
+ *
+ * This funciton will do escape for you if it is a TEXTBLOCK part,
+ * that is, if text contain tags, these tags will not be
+ * interpreted/parsed by TEXTBLOCK.
+ *
+ * @see edje_object_part_text_unescaped_get().
+ *
*/
EAPI void
edje_object_part_text_unescaped_set(Evas_Object *obj, const char *part, const char *text_to_escape)
}
}
-/** Returns the text of the object part, without escaping.
- *
- * Counterpart of edje_object_part_text_unescaped_set(). Please notice
- * that the result is newly allocated memory and should be released
- * with free() when done.
+/**
+ * @brief Returns the text of the object part, without escaping.
*
* @param obj A valid Evas_Object handle
* @param part The part name
- * @return The @b allocated text string without escaping, or NULL on problems.
+ * @return The @b allocated text string without escaping, or NULL on
+ * problems.
+ *
+ * This function is the counterpart of
+ * edje_object_part_text_unescaped_set(). Please notice that the
+ * result is newly allocated memory and should be released with free()
+ * when done.
+ *
+ * @see edje_object_part_text_unescaped_set().
+ *
*/
EAPI char *
edje_object_part_text_unescaped_get(const Evas_Object *obj, const char *part)
return NULL;
}
-/** Returns the selection text of the object part
+/**
+ * @brief Return the selection text of the object part.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @return The text string
+ *
+ * This function returns selection text of the object part.
+ *
*/
EAPI const char *
edje_object_part_text_selection_get(const Evas_Object *obj, const char *part)
return NULL;
}
-/** sets the selection to be none
+/**
+ * @brief Set the selection to be none.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
+ *
+ * This function sets the selection text to be none.
+ *
*/
EAPI void
edje_object_part_text_select_none(const Evas_Object *obj, const char *part)
_edje_entry_select_none(rp);
}
-/** sets the selection to be everything
+/**
+ * @brief Set the selection to be everything.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
+ *
+ * This function selects all text of the object of the part.
+ *
*/
EAPI void
edje_object_part_text_select_all(const Evas_Object *obj, const char *part)
_edje_entry_select_all(rp);
}
-/** Inserts the text for an object part just before the cursor position
+/**
+ * @brief Insert text for an object part.
+ *
* @param obj A valid Evas Object handle
* @param part The part name
* @param text The text string
+ *
+ * This function inserts the text for an object part just before the
+ * cursor position.
+ *
*/
EAPI void
edje_object_part_text_insert(Evas_Object *obj, const char *part, const char *text)
rp->edje->text_change.func(rp->edje->text_change.data, obj, part);
}
-/** Returns a list of char * anchor names
+/**
+ * @brief Return a list of char anchor names.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
+ *
* @return The list of anchors (const char *), do not modify!
+ *
+ * This function returns a list of char anchor names.
+ *
*/
EAPI const Eina_List *
edje_object_part_text_anchor_list_get(const Evas_Object *obj, const char *part)
return NULL;
}
-/** Returns a list of Evas_Textblock_Rectangle * anchor rectangles
+/**
+ * @brief Return a list of Evas_Textblock_Rectangle anchor rectangles.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param anchor The anchor name
- * @return The list of anchor rects (const Evas_Textblock_Rectangle *), do not modify!
+ *
+ * @return The list of anchor rects (const Evas_Textblock_Rectangle
+ * *), do not modify!
+ *
+ * This function return a list of Evas_Textblock_Rectangle anchor
+ * rectangles.
+ *
*/
EAPI const Eina_List *
edje_object_part_text_anchor_geometry_get(const Evas_Object *obj, const char *part, const char *anchor)
return NULL;
}
-/** Returns the cursor geometry of the part relative to the edje object
+/**
+ * @brief Returns the cursor geometry of the part relative to the edje
+ * object.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param x Cursor X position
* @param y Cursor Y position
* @param w Cursor width
* @param h Cursor height
+ *
*/
EAPI void
edje_object_part_text_cursor_geometry_get(const Evas_Object *obj, const char *part, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
return;
}
-/** Enables selection if the entyr is an EXPLICIT selection mode type
+/**
+ * @brief Enables selection if the entyr is an EXPLICIT selection mode
+ * type.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
*/
_edje_entry_select_allow_set(rp, allow);
}
-/** Aborts any selection action on a part
+/**
+ * @brief Aborts any selection action on a part.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
*/
_edje_entry_select_abort(rp);
}
-/** Swallows an object into the edje
+/**
+ * @brief Swallows an object into the edje.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param obj_swallow The object to swallow
* for the part affect the swallowed object. (e.g. resize, move, show,
* raise/lower, etc.).
*
- * If an object has already been swallowed into this part, then it will
- * first be unswallowed before the new object is swallowed.
+ * If an object has already been swallowed into this part, then it
+ * will first be unswallowed before the new object is swallowed.
*/
EAPI void
edje_object_part_swallow(Evas_Object *obj, const char *part, Evas_Object *obj_swallow)
_edje_recalc(ed);
}
-/** Set the object minimum size
+/**
+ * @brief Set the object minimum size.
+ *
* @param obj A valid Evas_Object handle
* @param minw The minimum width
* @param minh The minimum height
}
}
-/** Set the object maximum size
+/**
+ * @brief Set the object maximum size.
+ *
* @param obj A valid Evas_Object handle
* @param maxw The maximum width
* @param maxh The maximum height
}
}
-/** Set the object aspect size
+/**
+ * @brief Set the object aspect size.
+ *
* @param obj A valid Evas_Object handle
* @param aspect The aspect control axes
* @param aw The aspect radio width
* @param ah The aspect ratio height
*
- * This sets the desired aspect ratio to keep an object that will be swallowed
- * by Edje. The width and height define a preferred size ASPECT and the
- * object may be scaled to be larger or smaller, but retaining the relative
- * scale of both aspect width and height.
+ * This sets the desired aspect ratio to keep an object that will be
+ * swallowed by Edje. The width and height define a preferred size
+ * ASPECT and the object may be scaled to be larger or smaller, but
+ * retaining the relative scale of both aspect width and height.
*/
EAPI void
edje_extern_object_aspect_set(Evas_Object *obj, Edje_Aspect_Control aspect, Evas_Coord aw, Evas_Coord ah)
return l;
}
-/** Registers a custom layout to be used in edje boxes
+/**
+ * @brief Registers a custom layout to be used in edje boxes.
+ *
* @param name The name of the layout
* @param func The function defining the layout
- * @param layout_data_get This function gets the custom data pointer for func
- * @param layout_data_free Passed to func to free its private data when needed
+ * @param layout_data_get This function gets the custom data pointer
+ * for func
+ * @param layout_data_free Passed to func to free its private data
+ * when needed
* @param free_data Frees data
* @param data Private pointer passed to layout_data_get
*
- * This function registers custom layouts that can be referred from themes
- * by the registered name.
- * The Evas_Object_Box_Layout functions receive two pointers for internal
- * use, one being private data, and the other the function to free that
- * data when it's not longer needed. From Edje, this private data will be
- * retrieved by calling layout_data_get, and layout_data_free will be the
- * free function passed to func. layout_data_get will be called with data
- * as its parameter, and this one will be freed by free_data whenever the
- * layout is unregistered from Edje.
+ * This function registers custom layouts that can be referred from
+ * themes by the registered name. The Evas_Object_Box_Layout
+ * functions receive two pointers for internal use, one being private
+ * data, and the other the function to free that data when it's not
+ * longer needed. From Edje, this private data will be retrieved by
+ * calling layout_data_get, and layout_data_free will be the free
+ * function passed to func. layout_data_get will be called with data
+ * as its parameter, and this one will be freed by free_data whenever
+ * the layout is unregistered from Edje.
*/
EAPI void
edje_box_layout_register(const char *name, Evas_Object_Box_Layout func, void *(*layout_data_get)(void *), void (*layout_data_free)(void *), void (*free_data)(void *), void *data)
}
}
-/** Unswallow an object
+/**
+ * @brief Unswallow an object.
+ *
* @param obj A valid Evas_Object handle
* @param obj_swallow The swallowed object
*
}
}
-/** Get the object currently swallowed by a part
+/**
+ * @brief Get the object currently swallowed by a part.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @return The swallowed object, or NULL if there is none.
return rp->swallowed_object;
}
-/** Get the minimum size for an object
+/**
+ * @brief Get the minimum size for an object.
+ *
* @param obj A valid Evas_Object handle
* @param minw Minimum width pointer
* @param minh Minimum height pointer
if (minh) *minh = ed->collection->prop.min.h;
}
-/** Get the maximum size for an object
+/**
+ * @brief Get the maximum size for an object.
+ *
* @param obj A valid Evas_Object handle
* @param maxw Maximum width pointer
* @param maxh Maximum height pointer
*
- * Gets the object's maximum size values from the Edje. These are set
+ * Gets the object's maximum size values from the Edje. These are set
* to zero if no Edje is connected to the Evas Object.
*/
EAPI void
}
}
-/** Force a Size/Geometry calculation
+/**
+ * @brief Force a Size/Geometry calculation.
+ *
* @param obj A valid Evas_Object handle
*
* Forces the object @p obj to recalculation layout regardless of
_edje_freeze_val = pf2;
}
-/** Calculate minimum size
+/**
+ * @brief Calculate minimum size.
+ *
* @param obj A valid Evas_Object handle
* @param minw Minimum width pointer
* @param minh Minimum height pointer
ed->calc_only = 0;
}
-/** Returns the state of the Edje part
+/**
+ * @brief Returns the state of the Edje part.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param val_ret
if (!rp)
{
if (val_ret) *val_ret = 0;
+ printf("part not found\n");
return "";
}
if (!rp->chosen_description)
return "";
}
-/** Determine dragable directions
+/**
+ * @brief Determine dragable directions.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
*
return EDJE_DRAG_DIR_NONE;
}
-/** Set the dragable object location
+/**
+ * @brief Set the dragable object location.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dx The x value
_edje_emit(rp->edje, "drag,set", rp->part->name);
}
-/** Get the dragable object location
+/**
+ * @brief Get the dragable object location.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dx The X value pointer
if (dy) *dy = ddy;
}
-/** Set the dragable object size
+/**
+ * @brief Set the dragable object size.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dw The drag width
_edje_recalc(rp->edje);
}
-/** Get the dragable object size
+/**
+ * @brief Get the dragable object size.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dw The drag width pointer
if (dh) *dh = rp->drag->size.y;
}
-/** Sets the drag step increment
+/**
+ * @brief Sets the drag step increment.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dx The x step ammount
#endif
}
-/** Gets the drag step increment values.
+/**
+ * @brief Gets the drag step increment values.
+ *
* @param obj A valid Evas_Object handle
* @param part The part
* @param dx The x step increment pointer
if (dy) *dy = rp->drag->step.y;
}
-/** Sets the page step increments
+/**
+ * @brief Sets the page step increments.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dx The x page step increment
#endif
}
-/** Gets the page step increments
+/**
+ * @brief Gets the page step increments.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dx The dx page increment pointer
if (dy) *dy = rp->drag->page.y;
}
-/** Steps the dragable x,y steps
+/**
+ * @brief Steps the dragable x,y steps.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dx The x step
_edje_emit(rp->edje, "drag,step", rp->part->name);
}
-/** Pages x,y steps
+/**
+ * @brief Pages x,y steps.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param dx The x step
* @param dy The y step
*
- * Pages x,y where the increment is defined by edje_object_part_drag_page_set.\n
- * WARNING: Paging is bugged!
+ * Pages x,y where the increment is defined by
+ * edje_object_part_drag_page_set.\n WARNING: Paging is bugged!
*/
EAPI void
edje_object_part_drag_page(Evas_Object *obj, const char *part, double dx, double dy)
_edje_box_layout_registry = NULL;
}
-/** Appends an object to the box
+/**
+ * @brief Appends an object to the box.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param child The object to append
* @return 1: Successfully added.\n
* 0: An error occured.
*
- * Appends child to the box indicated by part.\n
+ * Appends child to the box indicated by part.
*/
EAPI Eina_Bool
edje_object_part_box_append(Evas_Object *obj, const char *part, Evas_Object *child)
return _edje_real_part_box_append(rp, child);
}
-/** Prepends an object to the box
+/**
+ * @briefPrepends an object to the box.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param child The object to prepend
* @return 1: Successfully added.\n
* 0: An error occured.
*
- * Prepends child to the box indicated by part.\n
+ * Prepends child to the box indicated by part.
*/
EAPI Eina_Bool
edje_object_part_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child)
return _edje_real_part_box_prepend(rp, child);
}
-/** Adds an object to the box
+/**
+ * @brief Adds an object to the box.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param child The object to insert
* @return 1: Successfully added.\n
* 0: An error occured.
*
- * Inserts child in the box given by part, in the position marked by reference.\n
+ * Inserts child in the box given by part, in the position marked by
+ * reference.
*/
EAPI Eina_Bool
edje_object_part_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference)
return _edje_real_part_box_insert_before(rp, child, reference);
}
-/** Inserts an object to the box
+/**
+ * @brief Inserts an object to the box.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param child The object to insert
* @return 1: Successfully added.\n
* 0: An error occured.
*
- * Adds child to the box indicated by part, in the position given by pos.\n
+ * Adds child to the box indicated by part, in the position given by
+ * pos.
*/
EAPI Eina_Bool
edje_object_part_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos)
return _edje_real_part_box_insert_at(rp, child, pos);
}
-/** Removes an object from the box
+/**
+ * @brief Removes an object from the box.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param child The object to remove
*
* @return Pointer to the object removed, or NULL.
*
- * Removes child from the box indicated by part.\n
+ * Removes child from the box indicated by part.
*/
EAPI Evas_Object *
edje_object_part_box_remove(Evas_Object *obj, const char *part, Evas_Object *child)
return _edje_real_part_box_remove(rp, child);
}
-/** Removes an object from the box
+/**
+ * @brief Removes an object from the box.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param pos
*
* @return Pointer to the object removed, or NULL.
*
- * Removes from the box indicated by part, the object in the position pos.\n
+ * Removes from the box indicated by part, the object in the position
+ * pos.
*/
EAPI Evas_Object *
edje_object_part_box_remove_at(Evas_Object *obj, const char *part, unsigned int pos)
return _edje_real_part_box_remove_at(rp, pos);
}
-/** Removes all elements from the box
+/**
+ * @brief Removes all elements from the box.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param clear Delete objects on removal
* 0: An error occured.
*
* Removes all the external objects from the box indicated by part.
- * Elements created from the theme will not be removed.\n
+ * Elements created from the theme will not be removed.
*/
EAPI Eina_Bool
edje_object_part_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear)
_edje_recalc(rp->edje);
}
-/** Packs an object into the table
+/**
+ * @brief Packs an object into the table.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param child The object to pack in
* @return 1: Successfully added.\n
* 0: An error occured.
*
- * Packs an object into the table indicated by part.\n
+ * Packs an object into the table indicated by part.
*/
EAPI Eina_Bool
edje_object_part_table_pack(Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan)
return _edje_real_part_table_pack(rp, child_obj, col, row, colspan, rowspan);
}
-/** Removes an object from the table
+/**
+ * @brief Removes an object from the table.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param child The object to pack in
* @return 1: Successfully removed.\n
* 0: An error occured.
*
- * Removes an object from the table indicated by part.\n
+ * Removes an object from the table indicated by part.
*/
EAPI Eina_Bool
edje_object_part_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj)
return _edje_real_part_table_unpack(rp, child_obj);
}
-/** Gets the number of columns and rows the table has
+/**
+ * @brief Gets the number of columns and rows the table has.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param cols Pointer where to store number of columns (can be NULL)
* @return 1: Successfully get some data.\n
* 0: An error occured.
*
- * Retrieves the size of the table in number of columns and rows.\n
+ * Retrieves the size of the table in number of columns and rows.
*/
EAPI Eina_Bool
edje_object_part_table_col_row_size_get(const Evas_Object *obj, const char *part, int *cols, int *rows)
return EINA_TRUE;
}
-/** Removes all object from the table
+/**
+ * @brief Removes all object from the table.
+ *
* @param obj A valid Evas_Object handle
* @param part The part name
* @param clear If set, will delete subobjs on remove
* @return 1: Successfully clear table.\n
* 0: An error occured.
*
- * Removes all object from the table indicated by part, except
- * the internal ones set from the theme.\n
+ * Removes all object from the table indicated by part, except the
+ * internal ones set from the theme.
*/
EAPI Eina_Bool
edje_object_part_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear)
}
/**
- * Used to free the member lists that are stored in the text_class
- * and color_class hashtables.
+ * Used to free the member lists that are stored in the text_class and
+ * color_class hashtables.
*/
static Eina_Bool
member_list_free(const Eina_Hash *hash __UNUSED__, const void *key __UNUSED__, void *data, void *fdata __UNUSED__)
projects / framework / uifw / edje.git / commitdiff