diff options
author | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-08-07 14:08:01 +0100 |
---|---|---|
committer | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-08-07 14:08:01 +0100 |
commit | 2e1f8a58d4f58ebf6e43e3ad376e8c2c6a7e8d37 (patch) | |
tree | e55e565f93bddb24e87b6425b23ab0f5e5cc520c | |
parent | 5ef1c3bfc93b613e7a3a4f3ad0a2031755a6d073 (diff) | |
download | elementary-2e1f8a58d4f58ebf6e43e3ad376e8c2c6a7e8d37.tar.gz |
table: convert docs
-rw-r--r-- | src/lib/elm_table.eo | 167 |
1 files changed, 61 insertions, 106 deletions
diff --git a/src/lib/elm_table.eo b/src/lib/elm_table.eo index ce803f3ae..2793f3545 100644 --- a/src/lib/elm_table.eo +++ b/src/lib/elm_table.eo @@ -4,159 +4,114 @@ class Elm.Table (Elm.Widget) data: null; methods { @property homogeneous { - set { - /*@ - @brief Set the homogeneous layout in the table - - @ingroup Table */ - } - get { - /*@ - @brief Get the current table homogeneous mode. - - @return A boolean to indicating if the layout is homogeneous in the table - (true = homogeneous, false = no homogeneous) - - @ingroup Table */ - } + [[Control the homogenous state in a table.]] + set {} + get {} values { - homogeneous: bool; /*@ A boolean to set if the layout is homogeneous in the - table (true = homogeneous, false = no homogeneous) */ + homogeneous: bool; [[A boolean to set if the layout is + homogeneous in the table.]] } } @property padding { set { - /*@ - @brief Set padding between cells. - - Default value is 0. - - @ingroup Table */ + [[Set padding between cells. Default value is 0.]] } get { - /*@ - @brief Get padding between cells. - - @ingroup Table */ + [[Get padding between cells.]] } values { - horizontal: Evas.Coord; /*@ set the horizontal padding. */ - vertical: Evas.Coord; /*@ set the vertical padding. */ + horizontal: Evas.Coord; [[The horizontal padding.]] + vertical: Evas.Coord; [[The vertical padding.]] } } @property align { set { - /*@ - @brief Set alignment of table - @since 1.13 + [[Set alignment of table. Default value is 0.5. - Default value is 0.5. - - @ingroup Table */ + @since 1.13 + ]] } get { - /*@ - @brief Get alignment of table. - @since 1.13 + [[Get alignment of table. - @ingroup Table */ + @since 1.13 + ]] } values { - horizontal: double; /*@ the horizontal alignment. */ - vertical: double; /*@ the vertical alignment. */ + horizontal: double; [[The horizontal alignment.]] + vertical: double; [[The vertical alignment.]] } } clear { - /*@ - @brief Faster way to remove all child objects from a table object. - - @ingroup Table */ - + [[Faster way to remove all child objects from a table object.]] params { - @in clear: bool; /*@ If true, will delete children, else just remove from table. */ + @in clear: bool; [[If true, will delete children, else just remove from table.]] } } child_get @const { - /*@ - @brief Get child object of table at given coordinates. - - @return Child of object if find if not return NULL. */ - return: Evas.Object *; + [[Get child object of table at given coordinates.]] + return: Evas.Object *; [[Child of object if find if not return $null.]] params { - @in col: int; /*@ Column number of child object */ - @in row: int; /*@ Row number of child object */ + @in col: int; [[Column number of child object.]] + @in row: int; [[Row number of child object.]] } } pack_set { - /*@ - @brief Set the packing location of an existing child of the table - - Modifies the position of an object already in the table. - - @note All positioning inside the table is relative to rows and columns, so - a value of 0 for col and row, means the top left cell of the table, and a - value of 1 for colspan and rowspan means $subobj only takes that 1 cell. + [[Set the packing location of an existing child of the table - @ingroup Table */ + Modifies the position of an object already in the table. + Note: All positioning inside the table is relative to rows and + columns, so a value of 0 for col and row, means the top left + cell of the table, and a value of 1 for colspan and rowspan + means only takes that 1 cell. + ]] params { - @in subobj: Evas.Object *; /*@ The subobject to be modified in the table */ - @in column: int; /*@ Column number */ - @in row: int; /*@ Row number */ - @in colspan: int; /*@ colspan */ - @in rowspan: int; /*@ rowspan */ + @in subobj: Evas.Object *; [[The subobject to be modified in the table.]] + @in column: int; [[Column number.]] + @in row: int; [[Row number.]] + @in colspan: int; + @in rowspan: int; } legacy: null; } pack_get { - /*@ - @brief Get the packing location of an existing child of the table - - @see elm_table_pack_set() - - @ingroup Table */ - + [[Get the packing location of an existing child of the table.]] params { - @in subobj: Evas.Object *; /*@ The subobject to be modified in the table */ - @out column: int; /*@ Column number */ - @out row: int; /*@ Row number */ - @out colspan: int; /*@ colspan */ - @out rowspan: int; /*@ rowspan */ + @in subobj: Evas.Object *; [[The subobject to be modified in the table.]] + @out column: int; [[Column number.]] + @out row: int; [[Row number.]] + @out colspan: int; + @out rowspan: int; } legacy: null; } unpack { - /*@ - @brief Remove child from table. - - @ingroup Table */ - + [[Remove child from table.]] params { - @in subobj: Evas.Object *; /*@ The subobject */ + @in subobj: Evas.Object *; [[The subobject.]] } } pack { - /*@ - @brief Add a subobject on the table with the coordinates passed - - @note All positioning inside the table is relative to rows and columns, so - a value of 0 for x and y, means the top left cell of the table, and a - value of 1 for w and h means $subobj only takes that 1 cell. - - Note that columns and rows only guarantee 16bit unsigned values at best. - That means that col + colspan AND row + rowspan must fit inside 16bit - unsigned values cleanly. You will be warned once values exceed 15bit - storage, and attempting to use values not able to fit in 16bits will - result in failure. - - @ingroup Table */ - + [[Add a subobject on the table with the coordinates passed. + + Note: All positioning inside the table is relative to rows and + columns, so a value of 0 for x and y, means the top left cell of + the table, and a value of 1 for w and h means $subobj only takes + that 1 cell. + + Note: Columns and rows only guarantee 16bit unsigned values + at best. That means that col + colspan AND row + rowspan must fit + inside 16bit unsigned values cleanly. You will be warned once + values exceed 15bit storage, and attempting to use values not + able to fit in 16bits will result in failure. + ]] params { - @in subobj: Evas.Object *; /*@ The subobject to be added to the table */ - @in column: int; /*@ Column number */ - @in row: int; /*@ Row number */ - @in colspan: int; /*@ colspan */ - @in rowspan: int; /*@ rowspan */ + @in subobj: Evas.Object *; [[The subobject to be added to the table.]] + @in column: int; [[Column number.]] + @in row: int; [[Row number.]] + @in colspan: int; + @in rowspan: int; } } } |