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 <<<<<<< HEAD
  10  * The default look is a frame with a title, but Frame supports multple
  11 =======
  12  * The default look is a frame with a title, but Frame supports multiple
  13 >>>>>>> remotes/origin/upstream
  14  * styles:
  15  * @li default
  16  * @li pad_small
  17  * @li pad_medium
  18  * @li pad_large
  19  * @li pad_huge
  20  * @li outdent_top
  21  * @li outdent_bottom
  22  *
  23  * Of all this styles only default shows the title.
  24  *
  25  * Smart callbacks one can listen to:
  26  * - @c "clicked" - The user has clicked the frame's label
  27  *
  28 <<<<<<< HEAD
  29  * Default contents parts of the frame widget that you can use for are:
  30 =======
  31  * Default content parts of the frame widget that you can use for are:
  32 >>>>>>> remotes/origin/upstream
  33  * @li "default" - A content of the frame
  34  *
  35  * Default text parts of the frame widget that you can use for are:
  36  * @li "default" - Label of the frame
  37  *
  38  * Supported elm_object common APIs.
  39  * @li elm_object_part_text_set
  40  * @li elm_object_part_text_get
  41  * @li elm_object_part_content_set
  42  * @li elm_object_part_content_get
  43  * @li elm_object_part_content_unset
  44  *
  45  * For a detailed example see the @ref tutorial_frame.
  46  *
  47  * @{
  48  */
  49
  50 /**
  51  * @brief Add a new frame to the parent
  52  *
  53  * @param parent The parent object
  54  * @return The new object or NULL if it cannot be created
  55  */
  56 EAPI Evas_Object                 *elm_frame_add(Evas_Object *parent);
  57
  58 /**
  59  * @brief Toggle autocollapsing of a frame
  60  * @param obj The frame
  61 <<<<<<< HEAD
  62  * @param enable Whether to enable autocollapse
  63 =======
  64  * @param autocollapse Whether to enable autocollapse
  65 >>>>>>> remotes/origin/upstream
  66  *
  67  * When @p enable is EINA_TRUE, clicking a frame's label will collapse the frame
  68  * vertically, shrinking it to the height of the label.
  69  * By default, this is DISABLED.
  70  */
  71 <<<<<<< HEAD
  72 EAPI void elm_frame_autocollapse_set(Evas_Object *obj, Eina_Bool enable);
  73 =======
  74 EAPI void elm_frame_autocollapse_set(Evas_Object *obj, Eina_Bool autocollapse);
  75 >>>>>>> remotes/origin/upstream
  76
  77 /**
  78  * @brief Determine autocollapsing of a frame
  79  * @param obj The frame
  80  * @return Whether autocollapse is enabled
  81  *
  82  * When this returns EINA_TRUE, clicking a frame's label will collapse the frame
  83  * vertically, shrinking it to the height of the label.
  84  * By default, this is DISABLED.
  85  */
  86 <<<<<<< HEAD
  87 EAPI Eina_Bool elm_frame_autocollapse_get(Evas_Object *obj);
  88 =======
  89 EAPI Eina_Bool elm_frame_autocollapse_get(const Evas_Object *obj);
  90 >>>>>>> remotes/origin/upstream
  91
  92 /**
  93  * @brief Manually collapse a frame without animations
  94  * @param obj The frame
  95  * @param collapse true to collapse, false to expand
  96  *
  97  * Use this to toggle the collapsed state of a frame, bypassing animations.
  98  */
  99 EAPI void elm_frame_collapse_set(Evas_Object *obj, Eina_Bool collapse);
 100
 101 /**
 102 <<<<<<< HEAD
 103  * @brief Manually collapse a frame with animations
 104  * @param obj The frame
 105  * @param collapse true to collapse, false to expand
 106  *
 107  * Use this to toggle the collapsed state of a frame, triggering animations.
 108  */
 109 EAPI void elm_frame_collapse_go(Evas_Object *obj, Eina_Bool collapse);
 110
 111 /**
 112  * @brief Determine the collapse state of a frame
 113  * @param obj The frame
 114  * @return true if collapsed, false otherwise
 115  *
 116  * Use this to determine the collapse state of a frame.
 117  */
 118 EAPI Eina_Bool elm_frame_collapse_get(Evas_Object *obj);
 119 /**
 120 =======
 121  * @brief Determine the collapse state of a frame
 122  * @param obj The frame
 123  * @return true if collapsed, false otherwise
 124  *
 125  * Use this to determine the collapse state of a frame.
 126  */
 127 EAPI Eina_Bool elm_frame_collapse_get(const Evas_Object *obj);
 128
 129 /**
 130  * @brief Manually collapse a frame with animations
 131  * @param obj The frame
 132  * @param collapse true to collapse, false to expand
 133  *
 134  * Use this to toggle the collapsed state of a frame, triggering animations.
 135  */
 136 EAPI void elm_frame_collapse_go(Evas_Object *obj, Eina_Bool collapse);
 137
 138 /*
 139 >>>>>>> remotes/origin/upstream
 140  * @}
 141  */