panel: added more documentations to panel.
This commit is contained in:
parent
c169b7d0ca
commit
a991adfa8a
|
@ -16,15 +16,15 @@ class Elm_Panel (Elm_Layout, Elm_Interface_Scrollable,
|
|||
/*@
|
||||
@brief Get the orientation of the panel.
|
||||
|
||||
@return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
|
||||
@return The Elm_Panel_Orient, or #ELM_PANEL_ORIENT_LEFT on failure.
|
||||
|
||||
@ingroup Panel */
|
||||
}
|
||||
values {
|
||||
Elm_Panel_Orient orient; /*@ The panel orientation. Can be one of the following:
|
||||
@li ELM_PANEL_ORIENT_TOP
|
||||
@li ELM_PANEL_ORIENT_LEFT
|
||||
@li ELM_PANEL_ORIENT_RIGHT */
|
||||
@li #ELM_PANEL_ORIENT_TOP
|
||||
@li #ELM_PANEL_ORIENT_LEFT
|
||||
@li #ELM_PANEL_ORIENT_RIGHT */
|
||||
}
|
||||
}
|
||||
hidden {
|
||||
|
|
|
@ -13,10 +13,10 @@
|
|||
* button on its edge.
|
||||
*
|
||||
* Orientations are as follows:
|
||||
* @li @c ELM_PANEL_ORIENT_TOP
|
||||
* @li @c ELM_PANEL_ORIENT_LEFT
|
||||
* @li @c ELM_PANEL_ORIENT_RIGHT
|
||||
* @li @c ELM_PANEL_ORIENT_BOTTOM
|
||||
* @li #ELM_PANEL_ORIENT_TOP
|
||||
* @li #ELM_PANEL_ORIENT_LEFT
|
||||
* @li #ELM_PANEL_ORIENT_RIGHT
|
||||
* @li #ELM_PANEL_ORIENT_BOTTOM
|
||||
*
|
||||
* This widget inherits from the @ref Layout one, so that all the
|
||||
* functions acting on it also work for panel objects (since 1.8).
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
/**
|
||||
* Panel orientation mode
|
||||
*
|
||||
* @ingroup Panel
|
||||
*/
|
||||
typedef enum
|
||||
{
|
||||
ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
|
||||
|
@ -6,6 +11,12 @@ typedef enum
|
|||
ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
|
||||
} Elm_Panel_Orient;
|
||||
|
||||
/**
|
||||
* Panel scroll information
|
||||
*
|
||||
* @since 1.11
|
||||
* @ingroup Panel
|
||||
*/
|
||||
typedef struct _Elm_Panel_Scroll_Info
|
||||
{
|
||||
double rel_x; /**<content scrolled position (0.0 ~ 1.0) in the panel>*/
|
||||
|
|
Loading…
Reference in New Issue