1 typedef Eo Elm_Panes; 2 3 /** 4 * Add a new panes widget to the given parent Elementary 5 * (container) object. 6 * 7 * @param parent The parent object. 8 * @return a new panes widget handle or @c NULL, on errors. 9 * 10 * This function inserts a new panes widget on the canvas. 11 * 12 * @ingroup Elm_Panes 13 */ 14 EAPI Evas_Object *elm_panes_add(Evas_Object *parent); 15 16 /** 17 * @brief Set how to split and dispose each content. 18 * 19 * Use this function to change how your panes is to be disposed: vertically or 20 * horizontally. Horizontal panes have "top" and "bottom" contents, vertical 21 * panes have "left" and "right" contents. 22 * 23 * By default panes is in a vertical mode. 24 * 25 * @param[in] horizontal Use @c true to make @c obj to split panes horizontally 26 * ("top" and "bottom" contents). @c false to make it vertically ("left" and 27 * "right" contents). 28 * 29 * @ingroup Elm_Panes 30 */ 31 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal); 32 33 /** 34 * @brief Get how to split and dispose each content. 35 * 36 * Use this function to change how your panes is to be disposed: vertically or 37 * horizontally. Horizontal panes have "top" and "bottom" contents, vertical 38 * panes have "left" and "right" contents. 39 * 40 * By default panes is in a vertical mode. 41 * 42 * @return Use @c true to make @c obj to split panes horizontally ("top" and 43 * "bottom" contents). @c false to make it vertically ("left" and "right" 44 * contents). 45 * 46 * @ingroup Elm_Panes 47 */ 48 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj); 49 50 /** 51 * @brief Set the absolute minimum size of panes widget's left side. 52 * 53 * @note If displayed vertically, left content is displayed at top. 54 * 55 * @param[in] size Value representing minimum size of left side in pixels. 56 * 57 * @ingroup Efl_Ui_Panes 58 */ 59 EAPI void elm_panes_content_left_min_size_set(Evas_Object *obj, int size); 60 61 /** 62 * @brief Get the absolute minimum size of panes widget's left side. 63 * 64 * @note If displayed vertically, left content is displayed at top. 65 * 66 * @return Value representing minimum size of left side in pixels. 67 * 68 * @ingroup Efl_Ui_Panes 69 */ 70 EAPI int elm_panes_content_left_min_size_get(const Evas_Object *obj); 71 72 /** 73 * @brief Control the absolute minimum size of panes widget's right side. 74 * 75 * @note If displayed vertically, right content is displayed at bottom. 76 * 77 * @param[in] size Value representing minimum size of right side in pixels. 78 * 79 * @ingroup Efl_Ui_Panes 80 */ 81 EAPI void elm_panes_content_right_min_size_set(Evas_Object *obj, int size); 82 83 /** 84 * @brief Get the absolute minimum size of panes widget's right side. 85 * 86 * @note If displayed vertically, right content is displayed at bottom. 87 * 88 * @return Value representing minimum size of right side in pixels. 89 * 90 * @ingroup Efl_Ui_Panes 91 */ 92 EAPI int elm_panes_content_right_min_size_get(const Evas_Object *obj); 93 94 /** 95 * @brief Set the size proportion of panes widget's right side. 96 * 97 * By default it's homogeneous, i.e., both sides have the same size. 98 * 99 * If something different is required, it can be set with this function. For 100 * example, if the right content should be displayed over 75% of the panes 101 * size, @c size should be passed as 0.75. This way, left content will be 102 * resized to 25% of panes size. 103 * 104 * If displayed vertically, left content is displayed at top, and right content 105 * at bottom. 106 * 107 * @note This proportion will change when user drags the panes bar. 108 * 109 * @param[in] size Value between 0.0 and 1.0 representing size proportion of 110 * right side. 111 * 112 * @ingroup Efl_Ui_Panes 113 */ 114 EAPI void elm_panes_content_right_size_set(Evas_Object *obj, double size); 115 116 /** 117 * @brief Get the size proportion of panes widget's right side. 118 * 119 * By default it's homogeneous, i.e., both sides have the same size. 120 * 121 * If displayed vertically, left content is displayed at top, and right content 122 * at bottom. 123 * 124 * @note This proportion will change when user drags the panes bar. 125 * 126 * @return Value between 0.0 and 1.0 representing size proportion of right 127 * side. 128 * 129 * @ingroup Efl_Ui_Panes 130 */ 131 EAPI double elm_panes_content_right_size_get(const Evas_Object *obj); 132 133 /** 134 * @brief Set the size proportion of panes widget's left side. 135 * 136 * By default it's homogeneous, i.e., both sides have the same size. 137 * 138 * If something different is required, it can be set with this function. For 139 * example, if the left content should be displayed over 75% of the panes size, 140 * @c size should be passed as 0.75. This way, right content will be resized to 141 * 25% of panes size. 142 * 143 * If displayed vertically, left content is displayed at top, and right content 144 * at bottom. 145 * 146 * @note This proportion will change when user drags the panes bar. 147 * 148 * @param[in] size Value between 0.0 and 1.0 representing size proportion of 149 * left side. 150 * 151 * @ingroup Efl_Ui_Panes 152 */ 153 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size); 154 155 /** 156 * @brief Get the size proportion of panes widget's left side. 157 * 158 * By default it's homogeneous, i.e., both sides have the same size. 159 * 160 * If displayed vertically, left content is displayed at top, and right content 161 * at bottom. 162 * 163 * @note This proportion will change when user drags the panes bar. 164 * 165 * @return Value between 0.0 and 1.0 representing size proportion of left side. 166 * 167 * @ingroup Efl_Ui_Panes 168 */ 169 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj); 170 171 /** 172 * @brief Controls the relative minimum size of panes widget's left side. 173 * 174 * proportion of minimum size of left side. 175 * 176 * @note If displayed vertically, left content is displayed at top. 177 * 178 * @param[in] size Value between 0.0 and 1.0 representing size proportion of 179 * minimum size of left side. 180 * 181 * @ingroup Efl_Ui_Panes 182 */ 183 EAPI void elm_panes_content_left_min_relative_size_set(Evas_Object *obj, double size); 184 185 /** 186 * @brief Get the relative minimum size of panes widget's left side. 187 * 188 * proportion of minimum size of left side. 189 * 190 * @note If displayed vertically, left content is displayed at top. 191 * 192 * @return Value between 0.0 and 1.0 representing size proportion of minimum 193 * size of left side. 194 * 195 * @ingroup Efl_Ui_Panes 196 */ 197 EAPI double elm_panes_content_left_min_relative_size_get(const Evas_Object *obj); 198 199 /** 200 * @brief Set the relative minimum size of panes widget's right side. 201 * 202 * @note If displayed vertically, right content is displayed at bottom. 203 * 204 * @param[in] size Value between 0.0 and 1.0 representing size proportion of 205 * minimum size of right side. 206 * 207 * @ingroup Efl_Ui_Panes 208 */ 209 EAPI void elm_panes_content_right_min_relative_size_set(Evas_Object *obj, double size); 210 211 /** 212 * @brief Get the relative minimum size of panes widget's right side. 213 * 214 * @note If displayed vertically, right content is displayed at bottom. 215 * 216 * @return Value between 0.0 and 1.0 representing size proportion of minimum 217 * size of right side. 218 * 219 * @ingroup Efl_Ui_Panes 220 */ 221 EAPI double elm_panes_content_right_min_relative_size_get(const Evas_Object *obj); 222 223 #include "efl_ui_panes_eo.legacy.h" 224