src/lib/elm_conform.h

   1 /**
   2  * @defgroup Conformant Conformant
   3  * @ingroup Elementary
   4  *
   5  * @image html conformant_inheritance_tree.png
   6  * @image latex conformant_inheritance_tree.eps
   7  *
   8  * @image html img/widget/conformant/preview-00.png
   9  * @image latex img/widget/conformant/preview-00.eps width=\textwidth
  10  *
  11  * @image html img/conformant.png
  12  * @image latex img/conformant.eps width=\textwidth
  13  *
  14  * The aim is to provide a widget that can be used in elementary apps to
  15  * account for space taken up by the indicator, virtual keypad & softkey
  16  * windows when running the illume2 module of E17.
  17  *
  18  * So conformant content will be sized and positioned considering the
  19  * space required for such stuff, and when they popup, as a keyboard
  20  * shows when an entry is selected, conformant content won't change.
  21  *
  22  * This widget inherits from the @ref Layout one, so that all the
  23  * functions acting on it also work for conformant objects.
  24  *
  25  * This widget emits the same signals sent from @ref Layout:
  26  *
  27  * Available styles for it:
  28  * - @c "default"
  29  *
  30  * Default content parts of the conformant widget that you can use for are:
  31  * @li "default" - A content of the conformant
  32  *
  33  * See how to use this widget in this example:
  34  * @ref conformant_example
  35  */
  36
  37 /**
  38  * @addtogroup Conformant
  39  * @{
  40  */
  41
  42 /**
  43  * Add a new conformant widget to the given parent Elementary
  44  * (container) object.
  45  *
  46  * @param parent The parent object.
  47  * @return A new conformant widget handle or @c NULL, on errors.
  48  *
  49  * This function inserts a new conformant widget on the canvas.
  50  *
  51  * @ingroup Conformant
  52  */
  53 EAPI Evas_Object                 *elm_conformant_add(Evas_Object *parent);
  54
  55 /**
  56  * @}
  57  */