forked from enlightenment/efl
docs: elm: fill gaps in systray, table, thumb and web eo file documentation
This commit is contained in:
parent
6536837c59
commit
58a3fea061
|
@ -8,7 +8,7 @@ enum Elm.Systray.Category
|
|||
communications, [[Communications apps]]
|
||||
sys_services, [[System Service apps]]
|
||||
hardware, [[Hardware indicators]]
|
||||
other [[undefined category]]
|
||||
other [[Undefined category]]
|
||||
}
|
||||
|
||||
enum Elm.Systray.Status
|
||||
|
@ -24,6 +24,7 @@ enum Elm.Systray.Status
|
|||
|
||||
class Elm.Systray (Efl.Object)
|
||||
{
|
||||
[[Elementary systray class]]
|
||||
legacy_prefix: elm_systray;
|
||||
eo_prefix: elm_obj_systray;
|
||||
data: null;
|
||||
|
@ -36,7 +37,7 @@ class Elm.Systray (Efl.Object)
|
|||
[[Get the id of the Status Notifier Item.]]
|
||||
}
|
||||
values {
|
||||
id: string @nullable;
|
||||
id: string @nullable; [[Status notifier item ID]]
|
||||
}
|
||||
}
|
||||
@property category {
|
||||
|
@ -58,7 +59,7 @@ class Elm.Systray (Efl.Object)
|
|||
[[Get the path to the icon's theme currently in use.]]
|
||||
}
|
||||
values {
|
||||
icon_theme_path: string @nullable;
|
||||
icon_theme_path: string @nullable; [[Icon theme path]]
|
||||
}
|
||||
}
|
||||
@property menu {
|
||||
|
@ -69,7 +70,7 @@ class Elm.Systray (Efl.Object)
|
|||
[[Get the object path of the D-Bus Menu currently in use.]]
|
||||
}
|
||||
values {
|
||||
menu: const(Efl.Object) @nullable;
|
||||
menu: const(Efl.Object) @nullable; [[Object path for DBus menu]]
|
||||
}
|
||||
}
|
||||
@property att_icon_name {
|
||||
|
@ -80,7 +81,7 @@ class Elm.Systray (Efl.Object)
|
|||
[[Get the name of the attention icon used by the Status Notifier Item.]]
|
||||
}
|
||||
values {
|
||||
att_icon_name: string @nullable;
|
||||
att_icon_name: string @nullable; [[Attention icon name]]
|
||||
}
|
||||
}
|
||||
@property status {
|
||||
|
@ -102,7 +103,7 @@ class Elm.Systray (Efl.Object)
|
|||
[[Get the name of the icon used by the Status Notifier Item.]]
|
||||
}
|
||||
values {
|
||||
icon_name: string @nullable;
|
||||
icon_name: string @nullable; [[Status icon name]]
|
||||
}
|
||||
}
|
||||
@property title {
|
||||
|
@ -113,13 +114,12 @@ class Elm.Systray (Efl.Object)
|
|||
[[Get the title of the Status Notifier Item.]]
|
||||
}
|
||||
values {
|
||||
title: string @nullable;
|
||||
title: string @nullable; [[Title]]
|
||||
}
|
||||
}
|
||||
register {
|
||||
[[Register this Status Notifier Item in the System Tray Watcher. This function should only be called after the event #ELM_EVENT_SYSTRAY_READY is emitted.]]
|
||||
return: bool;
|
||||
return: bool; [[$true on success, $false otherwise]]
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
class Elm.Table (Elm.Widget)
|
||||
{
|
||||
[[Elementary table class]]
|
||||
legacy_prefix: elm_table;
|
||||
eo_prefix: elm_obj_table;
|
||||
data: null;
|
||||
|
@ -46,7 +47,7 @@ class Elm.Table (Elm.Widget)
|
|||
clear {
|
||||
[[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 {
|
||||
|
@ -129,5 +130,4 @@ class Elm.Table (Elm.Widget)
|
|||
Elm.Widget.theme_apply;
|
||||
Elm.Widget.sub_object_del;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
|
||||
class Elm.Thumb (Elm.Layout, Efl.File, Efl.Ui.Clickable,
|
||||
Efl.Ui.Draggable)
|
||||
{
|
||||
[[Elementary thumbnail class]]
|
||||
legacy_prefix: elm_thumb;
|
||||
eo_prefix: elm_obj_thumb;
|
||||
event_prefix: elm_thumb;
|
||||
|
@ -17,11 +17,10 @@ class Elm.Thumb (Elm.Layout, Efl.File, Efl.Ui.Clickable,
|
|||
Efl.Ui.Draggable.drag_target.get;
|
||||
}
|
||||
events {
|
||||
generate,error;
|
||||
generate,start;
|
||||
generate,stop;
|
||||
load,error;
|
||||
press;
|
||||
generate,error; [[Called when an error occurred during thumbnail generation]]
|
||||
generate,start; [[Called when thumbnail generation started]]
|
||||
generate,stop; [[Called when thumbnail generation stopped]]
|
||||
load,error; [[Called when an error occurred during loading]]
|
||||
press; [[Called when pressed]]
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
@ -289,7 +289,7 @@ class Elm.Web (Elm.Widget)
|
|||
]]
|
||||
}
|
||||
values {
|
||||
func: Elm_Web_Dialog_Alert @nullable; [[callback function to be used.]]
|
||||
func: Elm_Web_Dialog_Alert @nullable; [[Callback function to be used.]]
|
||||
data: void_ptr @optional; [[User data.]]
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue