Merge remote-tracking branch 'remotes/origin/upstream'
[framework/uifw/elementary.git] / src / lib / elm_scale.h
1 /**
2  * @defgroup Scaling Widget Scaling
3  *
4  * Different widgets can be scaled independently. These functions
5  * allow you to manipulate this scaling on a per-widget basis. The
6  * object and all its children get their scaling factors multiplied
7  * by the scale factor set. This is multiplicative, in that if a
8  * child also has a scale size set it is in turn multiplied by its
9  * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
10  * double size, @c 0.5 is half, etc.
11  *
12  * @ref general_functions_example_page "This" example contemplates
13  * some of these functions.
14  */
15
16 /**
17 <<<<<<< HEAD
18  * Get the global scaling factor
19  *
20  * This gets the globally configured scaling factor that is applied to all
21  * objects.
22  *
23  * @return The scaling factor
24  * @ingroup Scaling
25  */
26 EAPI double elm_scale_get(void);
27
28 /**
29  * Set the global scaling factor
30  *
31  * This sets the globally configured scaling factor that is applied to all
32  * objects.
33  *
34  * @param scale The scaling factor to set
35  * @ingroup Scaling
36  */
37 EAPI void   elm_scale_set(double scale);
38
39 /**
40  * Set the global scaling factor for all applications on the display
41  *
42  * This sets the globally configured scaling factor that is applied to all
43  * objects for all applications.
44  * @param scale The scaling factor to set
45  * @ingroup Scaling
46  */
47 // XXX: deprecate and replace with elm_config_all_flush()
48 EAPI void   elm_scale_all_set(double scale);
49
50 /**
51 =======
52 >>>>>>> remotes/origin/upstream
53  * Set the scaling factor for a given Elementary object
54  *
55  * @param obj The Elementary to operate on
56  * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
57  * no scaling)
58  *
59  * @ingroup Scaling
60  */
61 EAPI void   elm_object_scale_set(Evas_Object *obj, double scale);
62
63 /**
64  * Get the scaling factor for a given Elementary object
65  *
66  * @param obj The object
67  * @return The scaling factor set by elm_object_scale_set()
68  *
69  * @ingroup Scaling
70  */
71 EAPI double elm_object_scale_get(const Evas_Object *obj);