efl/legacy/elementary/src/lib/elm_conform.h

60 lines
1.6 KiB
C

/**
* @defgroup Conformant Conformant
* @ingroup Elementary
*
* @image html img/widget/conformant/preview-00.png
* @image latex img/widget/conformant/preview-00.eps width=\textwidth
*
* @image html img/conformant.png
* @image latex img/conformant.eps width=\textwidth
*
* The aim is to provide a widget that can be used in elementary apps to
* account for space taken up by the indicator, virtual keypad & softkey
* windows when running the illume2 module of E17.
*
* So conformant content will be sized and positioned considering the
* space required for such stuff, and when they popup, as a keyboard
* shows when an entry is selected, conformant content won't change.
*
* Available styles for it:
* - @c "default"
*
* Default contents parts of the conformant widget that you can use for are:
* @li "default" - A content of the conformant
*
* See how to use this widget in this example:
* @ref conformant_example
*/
/**
* @addtogroup Conformant
* @{
*/
/**
* Add a new conformant widget to the given parent Elementary
* (container) object.
*
* @param parent The parent object.
* @return A new conformant widget handle or @c NULL, on errors.
*
* This function inserts a new conformant widget on the canvas.
*
* @ingroup Conformant
*/
EAPI Evas_Object *elm_conformant_add(Evas_Object *parent);
/**
* Returns the Evas_Object that represents the content area.
*
* @param obj The conformant object.
* @return The content area of the widget.
*
* @ingroup Conformant
*/
EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj);
/**
* @}
*/