src/lib/elm_conform.h

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