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