enlightenment/efl
enlightenment
/
efl
8
7
Fork 15
Code Issues 13 Pull Requests 2 Projects Releases Wiki Activity

docs: elm widget: start to document more items in the big elm widget eo file 

This can only be a start. Many more items need docs in here.
This commit is contained in:
Stefan Schmidt 2016-10-26 23:51:04 +02:00
parent c17d7429b6
commit 92cfac3262
1 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
src/lib/elementary/elm_widget.eo
View File

@ -9,12 +9,12 @@ type region_hook_func_type: __undefined_type;
enum Elm.Activate enum Elm.Activate
{ {
[[ Used in 'Virtual' function @Elm.Widget.activate. ]] [[ Used in 'Virtual' function @Elm.Widget.activate. ]]
default = 0, default = 0, [[Activate default]]
up, up, [[Activate up]]
down, down, [[Activate down]]
right, right, [[Activate right]]
left, left, [[Activate left]]
back, back, [[Activate back]]
} }
enum Elm.Theme.Apply enum Elm.Theme.Apply
@ -25,9 +25,9 @@ enum Elm.Theme.Apply
success = 3 [[Success to apply theme]] success = 3 [[Success to apply theme]]
} }
struct Elm.Tooltip; struct Elm.Tooltip; [[Elementary tooltip]]
struct Elm.Cursor; struct Elm.Cursor; [[Elementary cursor]]
struct @extern Elm.Theme; struct @extern Elm.Theme; [[Elementary theme]]
abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Interface.Atspi_Component) abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Interface.Atspi_Component)
{ {
@ -38,7 +38,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
methods { methods {
@property focus { @property focus {
values { values {
focus: bool; focus: bool; [[$true if the widget has focus, $false otherwise]]
} }
} }
@property drag_lock_y { @property drag_lock_y {
@ -72,7 +72,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
@property mirrored { @property mirrored {
[[Control the widget's mirrored mode.]] [[Control the widget's mirrored mode.]]
values { values {
mirrored: bool; mirrored: bool; [[$true if the widget is in mirrored mode, $false otherwise]]
} }
} }
@property theme { @property theme {
@ -82,7 +82,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
} }
@property disabled { @property disabled {
values { values {
disabled: bool; disabled: bool; [[$true if the widget is disabled, $false otherwise]]
} }
} }
@property highlight_ignore { @property highlight_ignore {
@ -93,7 +93,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
@property mirrored_automatic { @property mirrored_automatic {
[[Control the widget's mirrored mode setting.]] [[Control the widget's mirrored mode setting.]]
values { values {
automatic: bool; automatic: bool; [[$true if the widget uses automatic mirrored mode, $false otherwise]]
} }
} }
@property orientation_mode_disabled { @property orientation_mode_disabled {
@ -301,10 +301,10 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
return: bool; return: bool;
} }
values { values {
x: Evas.Coord; x: Evas.Coord; [[X coordinate]]
y: Evas.Coord; y: Evas.Coord; [[Y coordinate]]
w: Evas.Coord; w: Evas.Coord; [[Width]]
h: Evas.Coord; h: Evas.Coord; [[Height]]
} }
} }
@property top { @property top {
@ -445,10 +445,10 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
focus_highlight_geometry_get @const { focus_highlight_geometry_get @const {
[[Get the focus highlight geometry of widget.]] [[Get the focus highlight geometry of widget.]]
params { params {
@out x: Evas.Coord; @out x: Evas.Coord; [[X coordinate]]
@out y: Evas.Coord; @out y: Evas.Coord; [[Y coordinate]]
@out w: Evas.Coord; @out w: Evas.Coord; [[Width]]
@out h: Evas.Coord; @out h: Evas.Coord; [[Height]]
} }
} }
activate { activate {
@ -506,19 +506,19 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
} }
} }
on_focus { on_focus {
[['Virtual' function handling focus in/out events on the widget. return true if this widget can handle focus, false otherwise]] [['Virtual' function handling focus in/out events on the widget]]
params { params {
@in item: Elm.Widget.Item @nullable; @in item: Elm.Widget.Item @nullable;
} }
return: bool; return: bool; [[$true if this widget can handle focus, $false otherwise]]
} }
on_focus_region { on_focus_region {
[['Virtual' function returning an inner area of a widget that should be brought into the visible area of a broader viewport, may this context arise.]] [['Virtual' function returning an inner area of a widget that should be brought into the visible area of a broader viewport, may this context arise.]]
params { params {
@out x: Evas.Coord; @out x: Evas.Coord; [[X coordinate]]
@out y: Evas.Coord; @out y: Evas.Coord; [[Y coordinate]]
@out w: Evas.Coord; @out w: Evas.Coord; [[Width]]
@out h: Evas.Coord; @out h: Evas.Coord; [[Height]]
} }
return: bool; return: bool;
} }
@ -589,19 +589,19 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
} }
show_region_set { show_region_set {
params { params {
@in x: Evas.Coord; @in x: Evas.Coord; [[X coordinate]]
@in y: Evas.Coord; @in y: Evas.Coord; [[Y coordinate]]
@in w: Evas.Coord; @in w: Evas.Coord; [[Width]]
@in h: Evas.Coord; @in h: Evas.Coord; [[Height]]
@in forceshow: bool; @in forceshow: bool;
} }
} }
show_region_get @const { show_region_get @const {
params { params {
@out x: Evas.Coord @optional; @out x: Evas.Coord @optional; [[X coordinate]]
@out y: Evas.Coord @optional; @out y: Evas.Coord @optional; [[Y coordinate]]
@out w: Evas.Coord @optional; @out w: Evas.Coord @optional; [[Width]]
@out h: Evas.Coord @optional; @out h: Evas.Coord @optional; [[Height]]
} }
} }
scroll_freeze_pop { scroll_freeze_pop {
@ -779,10 +779,10 @@ abstract Elm.Widget (Efl.Canvas.Group, Elm.Interface.Atspi_Accessible, Elm.Inter
Elm.Interface.Atspi_Component.focus_grab; Elm.Interface.Atspi_Component.focus_grab;
} }
events { events {
moved; moved; [[Called when widget moved]]
focused; focused; [[Called when widget was focused]]
unfocused; unfocused; [[Called when widget was unfocused]]
language,changed; language,changed; [[Called when widget language changed]]
access,changed; access,changed; [[Called when accessibility changed]]
} }
} }