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 contents 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) EINA_ARG_NONNULL(1);
  46
  47    /**
  48     * Set the content of the conformant widget.
  49     *
  50     * @param obj The conformant object.
  51     * @param content The content to be displayed by the conformant.
  52     *
  53     * Content will be sized and positioned considering the space required
  54     * to display a virtual keyboard. So it won't fill all the conformant
  55     * size. This way is possible to be sure that content won't resize
  56     * or be re-positioned after the keyboard is displayed.
  57     *
  58     * Once the content object is set, a previously set one will be deleted.
  59     * If you want to keep that old content object, use the
  60     * elm_object_content_unset() function.
  61     *
  62     * @see elm_object_content_unset()
  63     * @see elm_object_content_get()
  64     *
  65     * @deprecated use elm_object_content_set() instead
  66     *
  67     * @ingroup Conformant
  68     */
  69    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
  70
  71    /**
  72     * Get the content of the conformant widget.
  73     *
  74     * @param obj The conformant object.
  75     * @return The content that is being used.
  76     *
  77     * Return the content object which is set for this widget.
  78     * It won't be unparent from conformant. For that, use
  79     * elm_object_content_unset().
  80     *
  81     * @see elm_object_content_set().
  82     * @see elm_object_content_unset()
  83     *
  84     * @deprecated use elm_object_content_get() instead
  85     *
  86     * @ingroup Conformant
  87     */
  88    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  89
  90    /**
  91     * Unset the content of the conformant widget.
  92     *
  93     * @param obj The conformant object.
  94     * @return The content that was being used.
  95     *
  96     * Unparent and return the content object which was set for this widget.
  97     *
  98     * @see elm_object_content_set().
  99     *
 100     * @deprecated use elm_object_content_unset() instead
 101     *
 102     * @ingroup Conformant
 103     */
 104    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
 105
 106    /**
 107     * Returns the Evas_Object that represents the content area.
 108     *
 109     * @param obj The conformant object.
 110     * @return The content area of the widget.
 111     *
 112     * @ingroup Conformant
 113     */
 114    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 115
 116    /**
 117     * @}
 118     */
 119