aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/eina/eina_rectangle.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/eina/eina_rectangle.h')
-rw-r--r--src/lib/eina/eina_rectangle.h535
1 files changed, 229 insertions, 306 deletions
diff --git a/src/lib/eina/eina_rectangle.h b/src/lib/eina/eina_rectangle.h
index 55d370ff25..e7675128df 100644
--- a/src/lib/eina/eina_rectangle.h
+++ b/src/lib/eina/eina_rectangle.h
@@ -1,14 +1,14 @@
/* EINA - EFL data type library
* Copyright (C) 2007-2008 Jorge Luis Zapata Muga
*
- * This library is free software; you can redistribute it and/or
+ * This library is a free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
@@ -22,490 +22,417 @@
#include "eina_types.h"
/**
- * @addtogroup Eina_Rectangle_Group Rectangle
- *
- * @brief These functions provide rectangle management.
- */
-
-/**
- * @addtogroup Eina_Tools_Group Tools
- *
- * @{
- */
-
-/**
* @defgroup Eina_Rectangle_Group Rectangle
+ * @ingroup Eina_Tools_Group
+ *
+ * @brief This group discusses the functions that provide rectangle management.
*
* @{
*/
-#define EINA_RECTANGLE_INIT { 0, 0, 0, 0}
-#define EINA_RECTANGLE_FORMAT "dx%d - %dx%d"
-#define EINA_RECTANGLE_ARGS(r) (r)->x, (r)->y, (r)->w, (r)->h
-
/**
* @typedef Eina_Rectangle
- * Simple rectangle structure.
+ * @brief The structure type for the simple rectangle structure.
*/
typedef struct _Eina_Rectangle
{
- int x; /**< top-left x co-ordinate of rectangle */
- int y; /**< top-left y co-ordinate of rectangle */
- int w; /**< width of rectangle */
- int h; /**< height of rectangle */
+ int x; /**< The top-left x co-ordinate of the rectangle */
+ int y; /**< The top-left y co-ordinate of the rectangle */
+ int w; /**< The width of the rectangle */
+ int h; /**< The height of the rectangle */
} Eina_Rectangle;
/**
* @typedef Eina_Rectangle_Pool
- * Type for an opaque pool of rectangle.
+ * @brief The structure type for an opaque rectangle pool.
*/
typedef struct _Eina_Rectangle_Pool Eina_Rectangle_Pool;
/**
- * @typedef Eina_Rectangle_Pool_Type
- * Type for an Eina Pool based on packing algorithm.
- * @since 1.11
+ * @typedef Eina_Rectangle_Packing
+ * @brief Enumeration of the type for an Eina Pool based on the packing algorithm.
+ * @since 1.10
*/
typedef enum {
Eina_Packing_Descending, /**< Current */
- Eina_Packing_Ascending, /**< sorting in assending order */
- Eina_Packing_Bottom_Left, /**< sorting in bottemleft fasion */
- Eina_Packing_Bottom_Left_Skyline, /**< bottemleft skyline */
- Eina_Packing_Bottom_Left_Skyline_Improved /**< optimized bottemleft skyline */
+ Eina_Packing_Ascending, /**< Sorting in ascending order */
+ Eina_Packing_Bottom_Left, /**< Sorting in bottom left fashion */
+ Eina_Packing_Bottom_Left_Skyline, /**< Bottom left skyline */
+ Eina_Packing_Bottom_Left_Skyline_improved /**< Optimized bottom left skyline */
} Eina_Rectangle_Packing;
/**
* @brief Check if the given spans intersect.
*
- * @param c1 The column of the first span.
- * @param l1 The length of the first span.
- * @param c2 The column of the second span.
- * @param l2 The length of the second span.
- * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
+ * @details This function returns #EINA_TRUE if the given spans intersect,
+ * #EINA_FALSE otherwise.
*
- * This function returns #EINA_TRUE if the given spans intersect, #EINA_FALSE
- * otherwise.
+ * @since_tizen 2.3
+ *
+ * @param[in] c1 The column of the first span.
+ * @param[in] l1 The length of the first span.
+ * @param[in] c2 The column of the second span.
+ * @param[in] l2 The length of the second span.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*/
static inline int eina_spans_intersect(int c1, int l1, int c2, int l2) EINA_WARN_UNUSED_RESULT;
/**
* @brief Check if the given rectangle is empty.
*
- * @param r The rectangle to check.
- * @return #EINA_TRUE if the rectangle is empty, #EINA_FALSE otherwise.
+ * @details This function returns #EINA_TRUE if @p r is empty, #EINA_FALSE
+ * otherwise. No check is done on @p r, so it must be a valid
+ * rectangle.
+ *
+ * @since_tizen 2.3
*
- * This function returns #EINA_TRUE if @p r is empty, #EINA_FALSE
- * otherwise. No check is done on @p r, so it must be a valid
- * rectangle.
+ * @param[in] r The rectangle to check.
+ * @return #EINA_TRUE if the rectangle is empty, #EINA_FALSE otherwise.
*/
static inline Eina_Bool eina_rectangle_is_empty(const Eina_Rectangle *r) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
/**
* @brief Set the coordinates and size of the given rectangle.
*
- * @param r The rectangle.
- * @param x The top-left x coordinate of the rectangle.
- * @param y The top-left y coordinate of the rectangle.
- * @param w The width of the rectangle.
- * @param h The height of the rectangle.
+ * @details This function sets its top-left x coordinate to @p x, its top-left
+ * y coordinate to @p y, its width to @p w and its height to @p h. No
+ * check is done on @p r, so it must be a valid rectangle.
+ *
+ * @since_tizen 2.3
*
- * This function sets its top-left x coordinate to @p x, its top-left
- * y coordinate to @p y, its width to @p w and its height to @p h. No
- * check is done on @p r, so it must be a valid rectangle.
+ * @param[in] r The rectangle.
+ * @param[in] x The top-left x coordinate of the rectangle.
+ * @param[in] y The top-left y coordinate of the rectangle.
+ * @param[in] w The width of the rectangle.
+ * @param[in] h The height of the rectangle.
*/
static inline void eina_rectangle_coords_from(Eina_Rectangle *r, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
/**
* @brief Check if the given rectangles intersect.
*
- * @param r1 The first rectangle.
- * @param r2 The second rectangle.
- * @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE otherwise.
+ * @details This function returns #EINA_TRUE if @p r1 and @p r2 intersect, #EINA_FALSE
+ * otherwise. No check is done on @p r1 and @p r2, so they must be valid
+ * rectangles.
*
- * This function returns #EINA_TRUE if @p r1 and @p r2 intersect, #EINA_FALSE
- * otherwise. No check is done on @p r1 and @p r2, so they must be valid
- * rectangles.
+ * @since_tizen 2.3
+ *
+ * @param[in] r1 The first rectangle.
+ * @param[in] r2 The second rectangle.
+ * @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE otherwise.
*/
static inline Eina_Bool eina_rectangles_intersect(const Eina_Rectangle *r1, const Eina_Rectangle *r2) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
/**
* @brief Check if the given x-coordinate is in the rectangle .
*
- * @param r The rectangle.
- * @param x The x coordinate.
- * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
+ * @details This function returns #EINA_TRUE if @p x is in @p r with respect to
+ * the horizontal direction, #EINA_FALSE otherwise. No check is done
+ * on @p r, so it must be a valid rectangle.
*
- * This function returns #EINA_TRUE if @p x is in @p r with respect to
- * the horizontal direction, #EINA_FALSE otherwise. No check is done
- * on @p r, so it must be a valid rectangle.
+ * @since_tizen 2.3
+ *
+ * @param[in] r The rectangle.
+ * @param[in] x The x coordinate.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*/
static inline Eina_Bool eina_rectangle_xcoord_inside(const Eina_Rectangle *r, int x) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
/**
* @brief Check if the given y-coordinate is in the rectangle .
*
- * @param r The rectangle.
- * @param y The y coordinate.
- * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
+ * @details This function returns #EINA_TRUE if @p y is in @p r with respect to
+ * the vertical direction, #EINA_FALSE otherwise. No check is done
+ * on @p r, so it must be a valid rectangle.
*
- * This function returns #EINA_TRUE if @p y is in @p r with respect to
- * the vertical direction, #EINA_FALSE otherwise. No check is done
- * on @p r, so it must be a valid rectangle.
+ * @since_tizen 2.3
+ *
+ * @param[in] r The rectangle.
+ * @param[in] y The y coordinate.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*/
static inline Eina_Bool eina_rectangle_ycoord_inside(const Eina_Rectangle *r, int y) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
/**
* @brief Check if the given point is in the rectangle .
*
- * @param r The rectangle.
- * @param x The x coordinate of the point.
- * @param y The y coordinate of the point.
- * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
+ * @details This function returns #EINA_TRUE if the point of coordinate (@p x,
+ * @p y) is in @p r, #EINA_FALSE otherwise. No check is done on @p r,
+ * so it must be a valid rectangle.
+ *
+ * @since_tizen 2.3
*
- * This function returns #EINA_TRUE if the point of coordinate (@p x,
- * @p y) is in @p r, #EINA_FALSE otherwise. No check is done on @p r,
- * so it must be a valid rectangle.
+ * @param[in] r The rectangle.
+ * @param[in] x The x coordinate of the point.
+ * @param[in] y The y coordinate of the point.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*/
static inline Eina_Bool eina_rectangle_coords_inside(const Eina_Rectangle *r, int x, int y) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
/**
* @brief Get the union of two rectangles.
*
- * @param dst The first rectangle.
- * @param src The second rectangle.
+ * @details This function get the union of the rectangles @p dst and @p src. The
+ * result is stored in @p dst. No check is done on @p dst or @p src,
+ * so they must be valid rectangles.
+ *
+ * @since_tizen 2.3
*
- * This function get the union of the rectangles @p dst and @p src. The
- * result is stored in @p dst. No check is done on @p dst or @p src,
- * so they must be valid rectangles.
+ * @param[in] dst The first rectangle.
+ * @param[in] src The second rectangle.
*/
static inline void eina_rectangle_union(Eina_Rectangle *dst, const Eina_Rectangle *src) EINA_ARG_NONNULL(1, 2);
/**
* @brief Get the intersection of two rectangles.
*
- * @param dst The first rectangle.
- * @param src The second rectangle.
+ * @details This function get the intersection of the rectangles @p dst and
+ * @p src. The result is stored in @p dst. No check is done on @p dst
+ * or @p src, so they must be valid rectangles.
+ *
+ * @since_tizen 2.3
+ *
+ * @param[in] dst The first rectangle.
+ * @param[in] src The second rectangle.
* @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE
* otherwise.
- *
- * This function get the intersection of the rectangles @p dst and
- * @p src. The result is stored in @p dst. No check is done on @p dst
- * or @p src, so they must be valid rectangles.
*/
static inline Eina_Bool eina_rectangle_intersection(Eina_Rectangle *dst, const Eina_Rectangle *src) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
/**
- * @brief FIXME I am useless and used by no one
+ * @brief Rescale a rectangle inner position.
+ *
+ * @details This function rescales a rectangle by using @p out and @p in.
*
- * @param in The inner rectangle.
- * @param out The outer rectangle.
- * @param res The resulting rectangle.
+ * @since_tizen 2.3
*
+ * @param[in] out The outter rectangle.
+ * @param[in] in The inner rectangle.
+ * @param[in] res The rectangle to be rescaled
*/
static inline void eina_rectangle_rescale_in(const Eina_Rectangle *out, const Eina_Rectangle *in, Eina_Rectangle *res) EINA_ARG_NONNULL(1, 2, 3);
/**
- * @brief FIXME I am useless and used by no one
+ * @brief Rescale a rectangle outter position.
*
- * @param in The inner rectangle.
- * @param out The outer rectangle.
- * @param res The resulting rectangle.
+ * @details This function rescales a rectangle by using @p out and @p in.
*
+ * @since_tizen 2.3
+ *
+ * @param[in] out The outter rectangle.
+ * @param[in] in The inner rectangle.
+ * @param[in] res The rectangle to be rescaled
*/
static inline void eina_rectangle_rescale_out(const Eina_Rectangle *out, const Eina_Rectangle *in, Eina_Rectangle *res) EINA_ARG_NONNULL(1, 2, 3);
-/**
- *
- * @brief Tells whether a rectangle is valid or not.
- *
- * @param r The rectangle
- * @return #EINA_TRUE if the rectangle is valid, #EINA_FALSE otherwise.
- *
- * This function checks if both width and height attributes of the rectangle are
- * positive integers. If so, the rectangle is considered valid, else the
- * rectangle is invalid.
- */
-static inline Eina_Bool eina_rectangle_is_valid(const Eina_Rectangle *r) EINA_ARG_NONNULL(1);
/**
+ * @brief Adds a rectangle in a new pool.
*
- * @brief Gives the rectangle maximum x coordinate.
- *
- * @param thiz The rectangle
- * @return the maximum x coordinate
- *
- * This function calculates the maximum x coordinate of the rectangle by summing
- * the @p width with the current @p x coodinate of the rectangle.
- */
-static inline int eina_rectangle_max_x(Eina_Rectangle *thiz) EINA_ARG_NONNULL(1);
-
-/**
+ * @details This function adds the rectangle of size (@a width, @a height) to a
+ * new pool. If the pool cannot be created, @c NULL is
+ * returned. Otherwise the newly allocated pool is returned.
*
- * @brief Gives the rectangle maximum y coordinate.
+ * @since_tizen 2.3
*
- * @param thiz The rectangle
- * @return the maximum y coordinate
+ * @param[in] w The width of the rectangle
+ * @param[in] h The height of the rectangle
+ * @return A newly allocated pool on success, otherwise @c NULL
*
- * This function calculates the maximum y coordinate of the rectangle by summing
- * the @p height with the current @p y coodinate of the rectangle.
*/
-static inline int eina_rectangle_max_y(Eina_Rectangle *thiz) EINA_ARG_NONNULL(1);
+EAPI Eina_Rectangle_Pool *eina_rectangle_pool_new(int w, int h) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
/**
+ * @brief Gets the pool of the given rectangle.
*
- * @brief Slices a rectangle vertically into two subrectangles starting from left edge
+ * @details This function returns the pool in which @a rect is present. If @a rect is
+ * @c NULL, @c NULL is returned.
*
- * @param thiz The rectangle to slice
- * @param slice The sliced part of the rectangle
- * @param remainder The left over part of the original rectangle after slice
- * @param amount The x inner coordinate of the rectangle where to perform the
- * slicing.
- * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise
+ * @since_tizen 2.3
*
- * Use this function if we must cut a rectangle vertically. The @p amount
- * parameter defines the x inner coordinate where to do the cut, starting from
- * the left edge of the rectangle. If the @p amount value is greater than the
- * rectangle width, there will be not cut possible and #EINA_FALSE will be
- * returned.
- */
-static inline Eina_Bool eina_rectangle_x_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
-
-/**
+ * @param[in] rect The rectangle
+ * @return The pool of the given rectangle
*
- * @brief Slices a rectangle horizontally into two subrectangles starting from bottom edge
- *
- * @param thiz The rectangle to slice
- * @param slice The sliced part of the rectangle
- * @param remainder The left over part of the original rectangle after slice
- * @param amount The y inner coordinate of the rectangle where to perform the
- * slicing.
- * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise
- *
- * Use this function if we must cut a rectangle horizontally. The @p amount
- * parameter defines the y inner coordinate where to do the cut, starting from
- * the bottom edge of the rectangle. If the @p amount value is greater than the
- * rectangle width, there will be not cut possible and #EINA_FALSE will be
- * returned.
*/
-static inline Eina_Bool eina_rectangle_y_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
+EAPI Eina_Rectangle_Pool *eina_rectangle_pool_get(Eina_Rectangle *rect) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
+ * @brief Gets the width and height of the given pool.
+ *
+ * @details This function returns the width and height of @a pool and stores
+ * them in @a w and @a h respectively if they are not @c NULL. If
+ * @a pool is @c NULL, @c EINA_FALSE is returned. Otherwise @c EINA_TRUE is
+ * returned.
*
- * @brief Slices a rectangle vertically starting from right edge
+ * @since_tizen 2.3
*
- * @param thiz The rectangle to slice
- * @param slice The sliced part of the rectangle
- * @param remainder The left over part of the original rectangle after slice
- * @param amount The amount to cut off the rectangle starting from the right
- * edge
- * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise
+ * @param[in] pool The pool
+ * @param[out] w The returned width
+ * @param[out] h The returned height
+ * @return @c EINA_TRUE on success, otherwise @c EINA_FALSE
*
- * Use this function if we must cut a rectangle vertically. The @p amount
- * parameter defines the inner x coordinate where to do the cut, starting from
- * the right edge of the rectangle. If the @p amount value is greater than the
- * rectangle width, there will be not cut possible and #EINA_FALSE will be
- * returned.
*/
-static inline Eina_Bool eina_rectangle_width_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool eina_rectangle_pool_geometry_get(Eina_Rectangle_Pool *pool, int *w, int *h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
/**
+ * @brief Gets the data from the given pool.
+ *
+ * @details This function gets the data from @a pool set by
+ * eina_rectangle_pool_data_set(). If @a pool is @c NULL, this
+ * function returns @c NULL.
*
- * @brief Slices a rectangle horizontally starting from top edge
+ * @since_tizen 2.3
*
- * @param thiz The rectangle to slice
- * @param slice The sliced part of the rectangle
- * @param remainder The left over part of the original rectangle after slice
- * @param amount The amount to cut off the rectangle starting from the top edge
- * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise
+ * @param[in] pool The pool
+ * @return The returned data
*
- * Use this function if we must cut a rectangle horizontally. The @p amount
- * parameter defines the inner y coordinate where to do the cut, starting from
- * the top edge of the rectangle. If the @p amount value is greater than the
- * rectangle width, there will be not cut possible and #EINA_FALSE will be
- * returned.
*/
-static inline Eina_Bool eina_rectangle_height_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
+EAPI void *eina_rectangle_pool_data_get(Eina_Rectangle_Pool *pool) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
- * @brief Subtract two rectangles.
+ * @brief Sets the data to the given pool.
*
- * @param thiz The minuend rectangle
- * @param other The subtrahend rectangle
+ * @details This function sets @a data to @a pool. If @a pool is @c NULL, this
+ * function does nothing.
*
- * This function subtract two rectangles. The difference is stored on @p out
- * There will be at most four differences, use eina_rectangle_is_valid to
- * confirm the number of differences.
- */
-static inline Eina_Bool eina_rectangle_subtract(Eina_Rectangle *thiz, Eina_Rectangle *other, Eina_Rectangle out[4]) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Add a rectangle in a new pool.
+ * @since_tizen 2.3
*
- * @param w The width of the rectangle.
- * @param h The height of the rectangle.
- * @return A newly allocated pool on success, @c NULL otherwise.
+ * @param[in] pool The pool
+ * @param[in] data The data to set
*
- * This function adds the rectangle of size (@p width, @p height) to a
- * new pool. If the pool can not be created, @c NULL is
- * returned. Otherwise the newly allocated pool is returned.
*/
-EAPI Eina_Rectangle_Pool *eina_rectangle_pool_new(int w, int h) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+EAPI void eina_rectangle_pool_data_set(Eina_Rectangle_Pool *pool, const void *data) EINA_ARG_NONNULL(1);
/**
- * @brief Return the pool of the given rectangle.
+ * @brief Frees the given pool.
*
- * @param rect The rectangle.
- * @return The pool of the given rectangle.
+ * @details This function frees the allocated data of @a pool. If @a pool is
+ * @c NULL, this function returns immediately.
*
- * This function returns the pool in which @p rect is. If @p rect is
- * @c NULL, @c NULL is returned.
- */
-EAPI Eina_Rectangle_Pool *eina_rectangle_pool_get(Eina_Rectangle *rect) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
-
-/**
- * @brief Return the width and height of the given pool.
+ * @since_tizen 2.3
*
- * @param pool The pool.
- * @param w The returned width.
- * @param h The returned height.
- * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
+ * @param[in] pool The pool to free
*
- * This function returns the width and height of @p pool and store
- * them in respectively @p w and @p h if they are not @c NULL. If
- * @p pool is @c NULL, #EINA_FALSE is returned. Otherwise #EINA_TRUE is
- * returned.
*/
-EAPI Eina_Bool eina_rectangle_pool_geometry_get(Eina_Rectangle_Pool *pool, int *w, int *h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
+EAPI void eina_rectangle_pool_free(Eina_Rectangle_Pool *pool) EINA_ARG_NONNULL(1);
/**
- * @brief Get the data from the given pool.
+ * @brief Returns the number of rectangles in the given pool.
*
- * @param pool The pool.
- * @return The returned data.
+ * @details This function returns the number of rectangles in @a pool.
*
- * This function gets the data from @p pool set by
- * eina_rectangle_pool_data_set(). If @p pool is @c NULL, this
- * function returns @c NULL.
- */
-EAPI void *eina_rectangle_pool_data_get(Eina_Rectangle_Pool *pool) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
-
-/**
- * @brief Set the data to the given pool.
+ * @since_tizen 2.3
*
- * @param pool The pool.
- * @param data The data to set.
+ * @param[in] pool The pool
+ * @return The number of rectangles in the pool
*
- * This function sets @p data to @p pool. If @p pool is @c NULL, this
- * function does nothing.
*/
-EAPI void eina_rectangle_pool_data_set(Eina_Rectangle_Pool *pool, const void *data) EINA_ARG_NONNULL(1);
+EAPI int eina_rectangle_pool_count(Eina_Rectangle_Pool *pool) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
/**
- * @brief Free the given pool.
+ * @brief Requests for a rectangle of the given size in the given pool.
*
- * @param pool The pool to free.
+ * @details This function retrieves from @a pool the rectangle of width @a w and
+ * height @a h. If @a pool is @c NULL, or @a w or @a h are non-positive,
+ * the function returns @c NULL. If @a w or @a h are greater than the
+ * pool size, the function returns @c NULL. On success, the function
+ * returns the rectangle that matches the size (@a w, @a h).
+ * Otherwise it returns @c NULL.
*
- * This function frees the allocated data of @p pool. If @p pool is
- * @c NULL, this function returned immediately.
- */
-EAPI void eina_rectangle_pool_free(Eina_Rectangle_Pool *pool) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Return the number of rectangles in the given pool.
+ * @since_tizen 2.3
*
- * @param pool The pool.
- * @return The number of rectangles in the pool.
+ * @param[in] pool The pool
+ * @param[in] w The width of the rectangle to request for
+ * @param[in] h The height of the rectangle to request for
+ * @return The requested rectangle on success, otherwise @c NULL
*
- * This function returns the number of rectangles in @p pool.
- */
-EAPI int eina_rectangle_pool_count(Eina_Rectangle_Pool *pool) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
-
-/**
- * @brief Request a rectangle of given size in the given pool.
- *
- * @param pool The pool.
- * @param w The width of the rectangle to request.
- * @param h The height of the rectangle to request.
- * @return The requested rectangle on success, @c NULL otherwise.
- *
- * This function retrieve from @p pool the rectangle of width @p w and
- * height @p h. If @p pool is @c NULL, or @p w or @p h are non-positive,
- * the function returns @c NULL. If @p w or @p h are greater than the
- * pool size, the function returns @c NULL. On success, the function
- * returns the rectangle which matches the size (@p w, @p h).
- * Otherwise it returns @c NULL.
*/
EAPI Eina_Rectangle *eina_rectangle_pool_request(Eina_Rectangle_Pool *pool, int w, int h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
- * @brief Remove the given rectangle from the pool.
+ * @brief Removes the given rectangle from the pool.
+ *
+ * @details This function removes @a rect from the pool. If @a rect is
+ * @c NULL, the function returns immediately. Otherwise it removes
+ * @a rect from the pool.
+ *
+ * @since_tizen 2.3
*
- * @param rect The rectangle to remove from the pool.
+ * @param[in] rect The rectangle to remove from the pool
*
- * This function removes @p rect from the pool. If @p rect is
- * @c NULL, the function returns immediately. Otherwise it removes @p
- * rect from the pool.
*/
EAPI void eina_rectangle_pool_release(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
/**
* @def EINA_RECTANGLE_SET
- * @brief Macro to set the values of a #Eina_Rectangle.
+ * @brief Provides a macro to set the values of a #Eina_Rectangle.
*
- * @param Rectangle The rectangle to set the values.
- * @param X The X coordinate of the top left corner of the rectangle.
- * @param Y The Y coordinate of the top left corner of the rectangle.
- * @param W The width of the rectangle.
- * @param H The height of the rectangle.
+ * @details This macro sets the values of @a Rectangle. (@a X, @a Y) are the
+ * coordinates of the top left corner of @a Rectangle, @a W is its
+ * width and @a H is its height.
+ *
+ * @since_tizen 2.3
+ *
+ * @param Rectangle The rectangle to set the values of
+ * @param X The X coordinate of the top left corner of the rectangle
+ * @param Y The Y coordinate of the top left corner of the rectangle
+ * @param W The width of the rectangle
+ * @param H The height of the rectangle
*
- * This macro set the values of @p Rectangle. (@p X, @p Y) is the
- * coordinates of the top left corner of @p Rectangle, @p W is its
- * width and @p H is its height.
*/
#define EINA_RECTANGLE_SET(Rectangle, X, Y, W, H) \
- { \
- (Rectangle)->x = X; \
- (Rectangle)->y = Y; \
- (Rectangle)->w = W; \
- (Rectangle)->h = H; \
- }
+ (Rectangle)->x = X; \
+ (Rectangle)->y = Y; \
+ (Rectangle)->w = W; \
+ (Rectangle)->h = H;
/**
- * @brief Create a new rectangle.
- *
- * @param x The X coordinate of the top left corner of the rectangle.
- * @param y The Y coordinate of the top left corner of the rectangle.
- * @param w The width of the rectangle.
- * @param h The height of the rectangle.
- * @return The new rectangle on success, @ NULL otherwise.
- *
- * This function creates a rectangle which top left corner has the
- * coordinates (@p x, @p y), with height @p w and height @p h and adds
- * it to the rectangles pool. No check is done on @p w and @p h. This
- * function returns a new rectangle on success, @c NULL otherwhise.
+ * @brief Creates a new rectangle.
+ *
+ * @details This function creates a rectangle whose top left corner has the
+ * coordinates (@a x, @a y), with width @a w and height @a h and adds
+ * it to the rectangle's pool. No check is done on @a w and @a h. This
+ * function returns a new rectangle on success, otherwise it returns @c NULL.
+ *
+ * @since_tizen 2.3
+ *
+ * @param[in] x The X coordinate of the top left corner of the rectangle
+ * @param[in] y The Y coordinate of the top left corner of the rectangle
+ * @param[in] w The width of the rectangle
+ * @param[in] h The height of the rectangle
+ * @return The new rectangle on success, otherwise @c NULL
+ *
*/
EAPI Eina_Rectangle *eina_rectangle_new(int x, int y, int w, int h) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
/**
- * @brief Free the given rectangle.
+ * @brief Frees the given rectangle.
*
- * @param rect The rectangle to free.
+ * @details This function removes @a rect from the rectangles pool.
+ *
+ * @since_tizen 2.3
+ *
+ * @param[in] rect The rectangle to free
*
- * This function removes @p rect from the rectangles pool.
*/
EAPI void eina_rectangle_free(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
/**
- * @brief Sets the type of given rectangle pool.
+ * @brief Sets the type of the given rectangle pool.
+ *
+ * @details This function sets @a type of @a pool.
*
- * @param pool The rectangle pool for which type is to be set.
+ * @since 1.10
+ *
+ * @since_tizen 2.3
+ *
+ * @param[in] pool The rectangle pool type to set
+ * @param[in] type The packing type to set
*
- * This function sets @p type of @p pool.
* @see Eina_Rectangle_Packing
- * @since 1.11
*/
-EAPI void eina_rectangle_pool_packing_set(Eina_Rectangle_Pool *pool,Eina_Rectangle_Packing type) EINA_ARG_NONNULL(1);
+EAPI void eina_rectangle_pool_packing_set(Eina_Rectangle_Pool *pool, Eina_Rectangle_Packing type) EINA_ARG_NONNULL(1);
#include "eina_inline_rectangle.x"
@@ -513,8 +440,4 @@ EAPI void eina_rectangle_pool_packing_set(Eina_Rectangle_Pool *pool,E
* @}
*/
-/**
- * @}
- */
-
#endif /*_EINA_RECTANGLE_H_*/