summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaehyun Cho <jae_hyun.cho@samsung.com>2018-01-30 18:53:33 +0900
committerJaehyun Cho <jae_hyun.cho@samsung.com>2018-01-30 18:53:33 +0900
commit10342af9204ce180b5c2d26791c7d662c143ed0f (patch)
tree2726927b58c573ff8f1330d0115f7360a406a65d
parent9f59009131c04b8d95934e15e8b00e6f650d2ec6 (diff)
elm_panes_legacy: Fix description of functions
-rw-r--r--src/lib/elementary/elm_panes_legacy.h24
1 files changed, 7 insertions, 17 deletions
diff --git a/src/lib/elementary/elm_panes_legacy.h b/src/lib/elementary/elm_panes_legacy.h
index 251c6ff5b3..5f85a9ba72 100644
--- a/src/lib/elementary/elm_panes_legacy.h
+++ b/src/lib/elementary/elm_panes_legacy.h
@@ -29,7 +29,7 @@ EAPI Evas_Object *elm_panes_add(Evas_Object *parent);
29EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal); 29EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
30 30
31/** 31/**
32 * @brief Set how to split and dispose each content. 32 * @brief Get how to split and dispose each content.
33 * 33 *
34 * Use this function to change how your panes is to be disposed: vertically or 34 * Use this function to change how your panes is to be disposed: vertically or
35 * horizontally. Horizontal panes have "top" and "bottom" contents, vertical 35 * horizontally. Horizontal panes have "top" and "bottom" contents, vertical
@@ -57,7 +57,7 @@ EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj);
57EAPI void elm_panes_content_left_min_size_set(Evas_Object *obj, int size); 57EAPI void elm_panes_content_left_min_size_set(Evas_Object *obj, int size);
58 58
59/** 59/**
60 * @brief Set the absolute minimum size of panes widget's left side. 60 * @brief Get the absolute minimum size of panes widget's left side.
61 * 61 *
62 * @note If displayed vertically, left content is displayed at top. 62 * @note If displayed vertically, left content is displayed at top.
63 * 63 *
@@ -79,7 +79,7 @@ EAPI int elm_panes_content_left_min_size_get(const Evas_Object *obj);
79EAPI void elm_panes_content_right_min_size_set(Evas_Object *obj, int size); 79EAPI void elm_panes_content_right_min_size_set(Evas_Object *obj, int size);
80 80
81/** 81/**
82 * @brief Control the absolute minimum size of panes widget's right side. 82 * @brief Get the absolute minimum size of panes widget's right side.
83 * 83 *
84 * @note If displayed vertically, right content is displayed at bottom. 84 * @note If displayed vertically, right content is displayed at bottom.
85 * 85 *
@@ -112,15 +112,10 @@ EAPI int elm_panes_content_right_min_size_get(const Evas_Object *obj);
112EAPI void elm_panes_content_right_size_set(Evas_Object *obj, double size); 112EAPI void elm_panes_content_right_size_set(Evas_Object *obj, double size);
113 113
114/** 114/**
115 * @brief Set the size proportion of panes widget's right side. 115 * @brief Get the size proportion of panes widget's right side.
116 * 116 *
117 * By default it's homogeneous, i.e., both sides have the same size. 117 * By default it's homogeneous, i.e., both sides have the same size.
118 * 118 *
119 * If something different is required, it can be set with this function. For
120 * example, if the right content should be displayed over 75% of the panes
121 * size, @c size should be passed as 0.75. This way, left content will be
122 * resized to 25% of panes size.
123 *
124 * If displayed vertically, left content is displayed at top, and right content 119 * If displayed vertically, left content is displayed at top, and right content
125 * at bottom. 120 * at bottom.
126 * 121 *
@@ -156,15 +151,10 @@ EAPI double elm_panes_content_right_size_get(const Evas_Object *obj);
156EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size); 151EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size);
157 152
158/** 153/**
159 * @brief Set the size proportion of panes widget's left side. 154 * @brief Get the size proportion of panes widget's left side.
160 * 155 *
161 * By default it's homogeneous, i.e., both sides have the same size. 156 * By default it's homogeneous, i.e., both sides have the same size.
162 * 157 *
163 * If something different is required, it can be set with this function. For
164 * example, if the left content should be displayed over 75% of the panes size,
165 * @c size should be passed as 0.75. This way, right content will be resized to
166 * 25% of panes size.
167 *
168 * If displayed vertically, left content is displayed at top, and right content 158 * If displayed vertically, left content is displayed at top, and right content
169 * at bottom. 159 * at bottom.
170 * 160 *
@@ -191,7 +181,7 @@ EAPI double elm_panes_content_left_size_get(const Evas_Object *obj);
191EAPI void elm_panes_content_left_min_relative_size_set(Evas_Object *obj, double size); 181EAPI void elm_panes_content_left_min_relative_size_set(Evas_Object *obj, double size);
192 182
193/** 183/**
194 * @brief Controls the relative minimum size of panes widget's left side. 184 * @brief Get the relative minimum size of panes widget's left side.
195 * 185 *
196 * proportion of minimum size of left side. 186 * proportion of minimum size of left side.
197 * 187 *
@@ -217,7 +207,7 @@ EAPI double elm_panes_content_left_min_relative_size_get(const Evas_Object *obj)
217EAPI void elm_panes_content_right_min_relative_size_set(Evas_Object *obj, double size); 207EAPI void elm_panes_content_right_min_relative_size_set(Evas_Object *obj, double size);
218 208
219/** 209/**
220 * @brief Set the relative minimum size of panes widget's right side. 210 * @brief Get the relative minimum size of panes widget's right side.
221 * 211 *
222 * @note If displayed vertically, right content is displayed at bottom. 212 * @note If displayed vertically, right content is displayed at bottom.
223 * 213 *