kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: enhance docs for elm actionslider 

Class description and some cleanup for getter and setter.
This commit is contained in:
Stefan Schmidt 2016-04-27 11:12:00 +02:00
parent 3f82fd1658
commit 7d0dd857ce
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/lib/elementary/elm_actionslider.eo
View File

@ -12,45 +12,48 @@ enum Elm.Actionslider.Pos
class Elm.Actionslider (Elm.Layout, Evas.Selectable_Interface) class Elm.Actionslider (Elm.Layout, Evas.Selectable_Interface)
{ {
[[An actionslider is a switcher for 2 or 3 labels
with customizable magnet properties. The user drags and releases
the indicator, to choose a label. When the indicator is released,
it will move to its nearest "enabled and magnetized" position.
]]
eo_prefix: elm_obj_actionslider; eo_prefix: elm_obj_actionslider;
methods { methods {
@property indicator_pos { @property indicator_pos {
[[Actionslider position indicator]]
set { set {
[[Set actionslider indicator position.]]
} }
get { get {
[[Get actionslider indicator position.]]
} }
values { values {
pos: Elm.Actionslider.Pos; [[The position of the indicator.]] pos: Elm.Actionslider.Pos; [[The position of the indicator.]]
} }
} }
@property magnet_pos { @property magnet_pos {
[[Actionslider magnet position.]]
set { set {
[[Set actionslider magnet position. [[To make multiple positions magnets OR them together (e.g.
ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
To make multiple positions magnets OR them together (e.g.
ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT)
]] ]]
} }
get { get {
[[Get actionslider magnet position.]]
} }
values { values {
pos: Elm.Actionslider.Pos; [[Bit mask indicating the magnet positions.]] pos: Elm.Actionslider.Pos; [[Bit mask indicating the magnet positions.]]
} }
} }
@property enabled_pos { @property enabled_pos {
[[Actionslider enabled position.]]
set { set {
[[Set actionslider enabled position. To set multiple positions as [[To set multiple positions as enabled OR them together(e.g.
enabled OR them together(e.g. ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
#ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT).
Note: All the positions are enabled by default. Note: All the positions are enabled by default.
]] ]]
} }
get { get {
[[Get actionslider enabled position.]]
} }
values { values {
pos: Elm.Actionslider.Pos; [[Bit mask indicating the enabled positions.]] pos: Elm.Actionslider.Pos; [[Bit mask indicating the enabled positions.]]
@ -59,7 +62,7 @@ class Elm.Actionslider (Elm.Layout, Evas.Selectable_Interface)
@property selected_label { @property selected_label {
get { get {
[[Get actionslider selected label.]] [[Get actionslider selected label.]]
return: const(char)*; return: const(char)*; [[Selected label]]
} }
} }
} }
@ -76,7 +79,7 @@ class Elm.Actionslider (Elm.Layout, Evas.Selectable_Interface)
Elm.Layout.sizing_eval; Elm.Layout.sizing_eval;
} }
events { events {
pos_changed; pos_changed; [[The position of the actionslider has changed]]
} }
} }