src/lib/elm_panes.h

   1 /**
   2  * @defgroup Panes Panes
   3  * @ingroup Elementary
   4  *
   5  * @image html img/widget/panes/preview-00.png
   6  * @image latex img/widget/panes/preview-00.eps width=\textwidth
   7  *
   8  * @image html img/panes.png
   9  * @image latex img/panes.eps width=\textwidth
  10  *
  11  * The panes adds a draggable bar between two contents. When dragged
  12  * this bar will resize contents size.
  13  *
  14  * Panes can be displayed vertically or horizontally, and contents
  15  * size proportion can be customized (homogeneous by default).
  16  *
  17  * Smart callbacks one can listen to:
  18  * - "press" - The panes has been pressed (button wasn't released yet).
  19  * - "unpressed" - The panes was released after being pressed.
  20  * - "clicked" - The panes has been clicked>
  21  * - "clicked,double" - The panes has been double clicked
  22  *
  23  * Available styles for it:
  24  * - @c "default"
  25  *
  26  * Default contents parts of the panes widget that you can use for are:
  27  * @li "left" - A leftside content of the panes
  28  * @li "right" - A rightside content of the panes
  29  *
  30  * If panes is displayed vertically, left content will be displayed at
  31  * top.
  32  *
  33  * Here is an example on its usage:
  34  * @li @ref panes_example
  35  */
  36
  37 /**
  38  * @addtogroup Panes
  39  * @{
  40  */
  41
  42 /**
  43  * Add a new panes widget to the given parent Elementary
  44  * (container) object.
  45  *
  46  * @param parent The parent object.
  47  * @return a new panes widget handle or @c NULL, on errors.
  48  *
  49  * This function inserts a new panes widget on the canvas.
  50  *
  51  * @ingroup Panes
  52  */
  53 EAPI Evas_Object                 *elm_panes_add(Evas_Object *parent);
  54
  55 /**
  56  * Get the size proportion of panes widget's left side.
  57  *
  58  * @param obj The panes object.
  59  * @return float value between 0.0 and 1.0 representing size proportion
  60  * of left side.
  61  *
  62  * @see elm_panes_content_left_size_set() for more details.
  63  *
  64  * @ingroup Panes
  65  */
  66 EAPI double                       elm_panes_content_left_size_get(const Evas_Object *obj);
  67
  68 /**
  69  * Set the size proportion of panes widget's left side.
  70  *
  71  * @param obj The panes object.
  72  * @param size Value between 0.0 and 1.0 representing size proportion
  73  * of left side.
  74  *
  75  * By default it's homogeneous, i.e., both sides have the same size.
  76  *
  77  * If something different is required, it can be set with this function.
  78  * For example, if the left content should be displayed over
  79  * 75% of the panes size, @p size should be passed as @c 0.75.
  80  * This way, right content will be resized to 25% of panes size.
  81  *
  82  * If displayed vertically, left content is displayed at top, and
  83  * right content at bottom.
  84  *
  85  * @note This proportion will change when user drags the panes bar.
  86  *
  87  * @see elm_panes_content_left_size_get()
  88  *
  89  * @ingroup Panes
  90  */
  91 EAPI void                         elm_panes_content_left_size_set(Evas_Object *obj, double size);
  92
  93 /**
  94  * Set the orientation of a given panes widget.
  95  *
  96  * @param obj The panes object.
  97  * @param horizontal Use @c EINA_TRUE to make @p obj to be
  98  * @b horizontal, @c EINA_FALSE to make it @b vertical.
  99  *
 100  * Use this function to change how your panes is to be
 101  * disposed: vertically or horizontally.
 102  *
 103  * By default it's displayed horizontally.
 104  *
 105  * @see elm_panes_horizontal_get()
 106  *
 107  * @ingroup Panes
 108  */
 109 EAPI void                         elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
 110
 111 /**
 112  * Retrieve the orientation of a given panes widget.
 113  *
 114  * @param obj The panes object.
 115  * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
 116  * @c EINA_FALSE if it's @b vertical (and on errors).
 117  *
 118  * @see elm_panes_horizontal_set() for more details.
 119  *
 120  * @ingroup Panes
 121  */
 122 EAPI Eina_Bool                    elm_panes_horizontal_get(const Evas_Object *obj);
 123 EAPI void                         elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed);
 124 EAPI Eina_Bool                    elm_panes_fixed_get(const Evas_Object *obj);
 125
 126 /**
 127  * @}
 128  */