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  * Get the global scaling factor
  18  *
  19  * This gets the globally configured scaling factor that is applied to all
  20  * objects.
  21  *
  22  * @return The scaling factor
  23  * @ingroup Scaling
  24  */
  25 EAPI double elm_scale_get(void);
  26
  27 /**
  28  * Set the global scaling factor
  29  *
  30  * This sets the globally configured scaling factor that is applied to all
  31  * objects.
  32  *
  33  * @param scale The scaling factor to set
  34  * @ingroup Scaling
  35  */
  36 EAPI void   elm_scale_set(double scale);
  37
  38 /**
  39  * Set the global scaling factor for all applications on the display
  40  *
  41  * This sets the globally configured scaling factor that is applied to all
  42  * objects for all applications.
  43  * @param scale The scaling factor to set
  44  * @ingroup Scaling
  45  */
  46 // XXX: deprecate and replace with elm_config_all_flush()
  47 EAPI void   elm_scale_all_set(double scale);
  48
  49 /**
  50  * Set the scaling factor for a given Elementary object
  51  *
  52  * @param obj The Elementary to operate on
  53  * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
  54  * no scaling)
  55  *
  56  * @ingroup Scaling
  57  */
  58 EAPI void
  59             elm_object_scale_set(Evas_Object *obj, double scale)
  60 EINA_ARG_NONNULL(1);
  61
  62 /**
  63  * Get the scaling factor for a given Elementary object
  64  *
  65  * @param obj The object
  66  * @return The scaling factor set by elm_object_scale_set()
  67  *
  68  * @ingroup Scaling
  69  */
  70 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);