src/lib/elm_frame.h

   1 /**
   2  * @defgroup Frame Frame
   3  *
   4  * @image html img/widget/frame/preview-00.png
   5  * @image latex img/widget/frame/preview-00.eps
   6  *
   7  * @brief Frame is a widget that holds some content and has a title.
   8  *
   9  * The default look is a frame with a title, but Frame supports multple
  10  * styles:
  11  * @li default
  12  * @li pad_small
  13  * @li pad_medium
  14  * @li pad_large
  15  * @li pad_huge
  16  * @li outdent_top
  17  * @li outdent_bottom
  18  *
  19  * Of all this styles only default shows the title. Frame emits no signals.
  20  *
  21  * Default contents parts of the frame widget that you can use for are:
  22  * @li "default" - A content of the frame
  23  *
  24  * Default text parts of the frame widget that you can use for are:
  25  * @li "elm.text" - Label of the frame
  26  *
  27  * For a detailed example see the @ref tutorial_frame.
  28  *
  29  * @{
  30  */
  31
  32 /**
  33  * @brief Add a new frame to the parent
  34  *
  35  * @param parent The parent object
  36  * @return The new object or NULL if it cannot be created
  37  */
  38 EAPI Evas_Object *
  39                                   elm_frame_add(Evas_Object *parent)
  40 EINA_ARG_NONNULL(1);
  41
  42 /**
  43  * @brief Set the frame label
  44  *
  45  * @param obj The frame object
  46  * @param label The label of this frame object
  47  *
  48  * @deprecated use elm_object_text_set() instead.
  49  */
  50 EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
  51
  52 /**
  53  * @brief Get the frame label
  54  *
  55  * @param obj The frame object
  56  *
  57  * @return The label of this frame objet or NULL if unable to get frame
  58  *
  59  * @deprecated use elm_object_text_get() instead.
  60  */
  61 EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  62
  63 /**
  64  * @brief Set the content of the frame widget
  65  *
  66  * Once the content object is set, a previously set one will be deleted.
  67  * If you want to keep that old content object, use the
  68  * elm_frame_content_unset() function.
  69  *
  70  * @param obj The frame object
  71  * @param content The content will be filled in this frame object
  72  *
  73  * @deprecated use elm_object_content_set() instead.
  74  */
  75 EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
  76
  77 /**
  78  * @brief Get the content of the frame widget
  79  *
  80  * Return the content object which is set for this widget
  81  *
  82  * @param obj The frame object
  83  * @return The content that is being used
  84  *
  85  * @deprecated use elm_object_content_get() instead.
  86  */
  87 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  88
  89 /**
  90  * @brief Unset the content of the frame widget
  91  *
  92  * Unparent and return the content object which was set for this widget
  93  *
  94  * @param obj The frame object
  95  * @return The content that was being used
  96  *
  97  * @deprecated use elm_object_content_unset() instead.
  98  */
  99 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
 100
 101 /**
 102  * @}
 103  */