forked from enlightenment/efl
Add missing documentation for elm_panes EAPIs and some comments. One API needs renaming.
Signed-off-by: Sanjeev BA <iamsanjeev@gmail.com> SVN revision: 67954
This commit is contained in:
parent
95a3abd63e
commit
3e373c4a9a
|
@ -8,8 +8,8 @@
|
||||||
* @image html img/panes.png
|
* @image html img/panes.png
|
||||||
* @image latex img/panes.eps width=\textwidth
|
* @image latex img/panes.eps width=\textwidth
|
||||||
*
|
*
|
||||||
* The panes adds a draggable bar between two contents. When dragged
|
* The panes widget adds a draggable bar between two contents. When dragged
|
||||||
* this bar will resize contents size.
|
* this bar will resize contents' size.
|
||||||
*
|
*
|
||||||
* Panes can be displayed vertically or horizontally, and contents
|
* Panes can be displayed vertically or horizontally, and contents
|
||||||
* size proportion can be customized (homogeneous by default).
|
* size proportion can be customized (homogeneous by default).
|
||||||
|
@ -23,11 +23,11 @@
|
||||||
* Available styles for it:
|
* Available styles for it:
|
||||||
* - @c "default"
|
* - @c "default"
|
||||||
*
|
*
|
||||||
* Default contents parts of the panes widget that you can use for are:
|
* Default contents parts of the panes widget that you can use are:
|
||||||
* @li "left" - A leftside content of the panes
|
* @li "left" - A leftside content of the panes
|
||||||
* @li "right" - A rightside content of the panes
|
* @li "right" - A rightside content of the panes
|
||||||
*
|
*
|
||||||
* If panes is displayed vertically, left content will be displayed at
|
* If panes are displayed vertically, left content will be displayed on
|
||||||
* top.
|
* top.
|
||||||
*
|
*
|
||||||
* Here is an example on its usage:
|
* Here is an example on its usage:
|
||||||
|
@ -52,6 +52,115 @@
|
||||||
*/
|
*/
|
||||||
EAPI Evas_Object *elm_panes_add(Evas_Object *parent);
|
EAPI Evas_Object *elm_panes_add(Evas_Object *parent);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the left pane content object of the panes object.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @param left_content The left content object.
|
||||||
|
*
|
||||||
|
* This function sets the left pane contents of a panes widgets.
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *left_content);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the left pane content object of the panes object.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @return the left pane widget handle or @c NULL, on errors.
|
||||||
|
*
|
||||||
|
* This function gets the left pane contents of a panes widget.
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI Evas_Object * elm_panes_content_left_get(const Evas_Object *obj);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unset the left pane content object of the panes object.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @return the left pane widget handle or @c NULL, on errors.
|
||||||
|
*
|
||||||
|
* This function unsets the left pane contents of a panes widget and makes
|
||||||
|
* the left pane empty.
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI Evas_Object * elm_panes_content_left_unset(Evas_Object *obj);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the right pane content object of the panes object.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @param right_content The right content object.
|
||||||
|
*
|
||||||
|
* This function sets the right pane contents of a panes widgets.
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *right_content);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the right pane content object of the panes object.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @return the right pane widget handle or @c NULL, on errors.
|
||||||
|
*
|
||||||
|
* This function gets the right pane contents of a panes widget.
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI Evas_Object * elm_panes_content_right_get(const Evas_Object *obj);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unset the right pane content object of the panes object.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @return the right pane widget handle or @c NULL, on errors.
|
||||||
|
*
|
||||||
|
* This function unsets the right pane contents of a panes widget and makes
|
||||||
|
* the right pane empty.
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI Evas_Object * elm_panes_content_right_unset(Evas_Object *obj);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set whether the left and right panes resize homogenously or not.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @param fixed Use @c EINA_TRUE to make @p obj to be
|
||||||
|
* resize the left and right panes @b homogenously.
|
||||||
|
* Use @c EINA_FALSE to make use of the values specified in
|
||||||
|
* elm_panes_content_left_size_set() and
|
||||||
|
* elm_panes_content_right_size_set()
|
||||||
|
* to resize the left and right panes.
|
||||||
|
*
|
||||||
|
* By default panes are resized homogenously.
|
||||||
|
*
|
||||||
|
* @see elm_panes_fixed_get()
|
||||||
|
* @see elmpanes_content_left_size_set()
|
||||||
|
* @see elm_panes_content_right_size_set()
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the resize mode for the panes of a given panes widget.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @return @c EINA_TRUE, if @p obj is set to be resized @b homogenously,
|
||||||
|
*
|
||||||
|
* @see elm_panes_fixed_set() for more details.
|
||||||
|
* @see elmpanes_content_left_size_get()
|
||||||
|
* @see elm_panes_content_right_size_get()
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the size proportion of panes widget's left side.
|
* Get the size proportion of panes widget's left side.
|
||||||
*
|
*
|
||||||
|
@ -90,6 +199,45 @@ EAPI double elm_panes_content_left_size_get(const Evas_Obj
|
||||||
*/
|
*/
|
||||||
EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size);
|
EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the size proportion of panes widget's right side.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @return float value between 0.0 and 1.0 representing size proportion
|
||||||
|
* of right side.
|
||||||
|
*
|
||||||
|
* @see elm_panes_content_right_size_set() for more details.
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI double elm_panes_content_right_size_get(const Evas_Object *obj);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the size proportion of panes widget's right side.
|
||||||
|
*
|
||||||
|
* @param obj The panes object.
|
||||||
|
* @param size Value between 0.0 and 1.0 representing size proportion
|
||||||
|
* of right side.
|
||||||
|
*
|
||||||
|
* By default it's homogeneous, i.e., both sides have the same size.
|
||||||
|
*
|
||||||
|
* If something different is required, it can be set with this function.
|
||||||
|
* For example, if the right content should be displayed over
|
||||||
|
* 75% of the panes size, @p size should be passed as @c 0.75.
|
||||||
|
* This way, right content will be resized to 25% of panes size.
|
||||||
|
*
|
||||||
|
* If displayed vertically, right content is displayed at top, and
|
||||||
|
* right content at bottom.
|
||||||
|
*
|
||||||
|
* @note This proportion will change when user drags the panes bar.
|
||||||
|
*
|
||||||
|
* @see elm_panes_content_right_size_get()
|
||||||
|
*
|
||||||
|
* @ingroup Panes
|
||||||
|
*/
|
||||||
|
EAPI void elm_panes_content_right_size_set(Evas_Object *obj, double size);
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the orientation of a given panes widget.
|
* Set the orientation of a given panes widget.
|
||||||
*
|
*
|
||||||
|
@ -120,8 +268,6 @@ EAPI void elm_panes_horizontal_set(Evas_Object *obj, Ein
|
||||||
* @ingroup Panes
|
* @ingroup Panes
|
||||||
*/
|
*/
|
||||||
EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj);
|
EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj);
|
||||||
EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed);
|
|
||||||
EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj);
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @}
|
* @}
|
||||||
|
|
Loading…
Reference in New Issue