src/lib conflict fixed
[framework/uifw/elementary.git] / src / lib / elm_finger.h
1 /**
2  * @defgroup Fingers Fingers
3  *
4  * Elementary is designed to be finger-friendly for touchscreens,
5  * and so in addition to scaling for display resolution, it can
6  * also scale based on finger "resolution" (or size). You can then
7  * customize the granularity of the areas meant to receive clicks
8  * on touchscreens.
9  *
10  * Different profiles may have pre-set values for finger sizes.
11  *
12  * @ref general_functions_example_page "This" example contemplates
13  * some of these functions.
14  *
15  * @{
16  */
17
18 /**
19  * Adjust size of an element for finger usage.
20  *
21  * @param times_w How many fingers should fit horizontally
22  * @param w Pointer to the width size to adjust
23  * @param times_h How many fingers should fit vertically
24  * @param h Pointer to the height size to adjust
25  *
26  * This takes width and height sizes (in pixels) as input and a
27  * size multiple (which is how many fingers you want to place
28  * within the area, being "finger" the size set by
29  * elm_finger_size_set()), and adjusts the size to be large enough
30  * to accommodate the resulting size -- if it doesn't already
31  * accommodate it. On return the @p w and @p h sizes pointed to by
32  * these parameters will be modified, on those conditions.
33  *
34  * @note This is kind of low level Elementary call, most useful
35  * on size evaluation times for widgets. An external user wouldn't
36  * be calling, most of the time.
37  *
38  * @ingroup Fingers
39  */
40 EAPI void       elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
41
42 /**
43  * @}
44  */