forked from enlightenment/efl
docs: Fill last missing docs from EO files
Some docs have been filled with placeholder text ("TBD") or with preliminary
text (marked with //TODO).
Having 0 doc warning we can now enable Warnings as Errors in mono, and in Eolian later on.
This commit is contained in:
Xavi Artigas
parent
25ef604467
commit
10acaa67d9
|
|
@ -1,59 +1,62 @@
|
|||
enum @beta Efl.Exe_Signal {
|
||||
[[ ]]
|
||||
int,
|
||||
quit,
|
||||
term,
|
||||
kill,
|
||||
cont,
|
||||
stop,
|
||||
hup,
|
||||
usr1,
|
||||
usr2
|
||||
[[Signal is a notification, a message sent by either operating system or some application to our program.
|
||||
Signals are a mechanism for one-way asynchronous notifications. A signal may be sent from the kernel to
|
||||
a process, from a process to another process, or from a process to itself. Signal typically alert a
|
||||
process to some event, such as a segmentation fault, or the user pressing Ctrl-C.]]
|
||||
int, [[Terminal interrupt.]]
|
||||
quit, [[Terminal quit.]]
|
||||
term, [[Termination.]]
|
||||
kill, [[Kill(can't be caught or ignored).]]
|
||||
cont, [[Continue executing, if stopped.]]
|
||||
stop, [[Stop executing(can't be caught or ignored).]]
|
||||
hup, [[Hangup.]]
|
||||
usr1, [[User defined signal 1.]]
|
||||
usr2 [[User defined signal 2.]]
|
||||
}
|
||||
|
||||
enum @beta Efl.Exe_Flags {
|
||||
[[ ]]
|
||||
none = 0,
|
||||
group_leader = 1,
|
||||
exit_with_parent = 2,
|
||||
hide_io = 4
|
||||
[[Flags to customize task behavior.]] // TODO: This needs more detail.
|
||||
none = 0, [[No special flags.]]
|
||||
group_leader = 1, [[Process will be executed in its own session.]]
|
||||
exit_with_parent = 2, [[Exit process when parent process exits.]]
|
||||
hide_io = 4 [[All console IO will be hidden.]]
|
||||
}
|
||||
|
||||
class @beta Efl.Exe extends Efl.Task implements Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line
|
||||
{
|
||||
[[ ]]
|
||||
[[Further customization of @Efl.Task, including signals and environment control.]] // TODO: This needs more detail
|
||||
methods {
|
||||
signal {
|
||||
[[Send a signal to this task.]]
|
||||
params {
|
||||
sig: Efl.Exe_Signal; [[ Send this signal to the task ]]
|
||||
sig: Efl.Exe_Signal; [[Signal number to send.]]
|
||||
}
|
||||
}
|
||||
@property exe_flags {
|
||||
[[Customize the task's behavior.]]
|
||||
set { }
|
||||
get { }
|
||||
values {
|
||||
flags: Efl.Exe_Flags; [[ ]]
|
||||
flags: Efl.Exe_Flags; [[Flags.]]
|
||||
}
|
||||
}
|
||||
@property exit_signal {
|
||||
[[ The final exit signal of this task. ]]
|
||||
[[The final exit signal of this task.]]
|
||||
get { }
|
||||
values {
|
||||
sig: int; [[ The exit signal, or -1 if no exit signal happened ]]
|
||||
sig: int; [[The exit signal, or -1 if no exit signal happened.]]
|
||||
}
|
||||
}
|
||||
@property env {
|
||||
[[ If $env is $null then the process created by this object is
|
||||
[[If $env is $null then the process created by this object is
|
||||
going to inherit the environment of this process.
|
||||
|
||||
In case $env is not $null then the environment variables declared
|
||||
in this object will represent the environment passed to the new process.
|
||||
]]
|
||||
get {
|
||||
[[ Get the object assosiated with this object ]]
|
||||
}
|
||||
set {
|
||||
[[ Set the object assosiated with this object ]]
|
||||
}
|
||||
values {
|
||||
env : Efl.Core.Env; [[$env will be referenced until this object does not need it anymore.]]
|
||||
|
|
|
|||
|
|
@ -1,60 +1,62 @@
|
|||
enum Efl.Task_Priority {
|
||||
[[
|
||||
[[How much processor time will this task get compared to other tasks running on
|
||||
the same processor.
|
||||
@since 1.22
|
||||
]]
|
||||
normal,
|
||||
background,
|
||||
low,
|
||||
high,
|
||||
ultra
|
||||
normal, [[Neither above nor below average priority. This is the default.]]
|
||||
background, [[Far below average priority.]]
|
||||
low, [[Below average priority.]]
|
||||
high, [[Above average priority.]]
|
||||
ultra [[Far above average priority.]]
|
||||
}
|
||||
|
||||
enum Efl.Task_Flags {
|
||||
[[
|
||||
[[Flags to further customize task's behavior.
|
||||
@since 1.22
|
||||
]]
|
||||
none = 0,
|
||||
use_stdin = 1,
|
||||
use_stdout = 2,
|
||||
no_exit_code_error = 4,
|
||||
none = 0, [[No special flags.]]
|
||||
use_stdin = 1, [[Task will require console input.]]
|
||||
use_stdout = 2, [[Task will require console output.]]
|
||||
no_exit_code_error = 4, [[Task will not produce an exit code upon termination.]]
|
||||
}
|
||||
|
||||
abstract Efl.Task extends Efl.Loop_Consumer
|
||||
{
|
||||
[[
|
||||
[[EFL's abstraction for a task (process).
|
||||
@since 1.22
|
||||
]]
|
||||
]] // TODO: This needs more detail.
|
||||
methods {
|
||||
@property priority {
|
||||
[[ The priority of this task. ]]
|
||||
[[The priority of this task.]]
|
||||
get { }
|
||||
set { }
|
||||
values {
|
||||
priority: Efl.Task_Priority; [[ ]]
|
||||
priority: Efl.Task_Priority; [[Desired priority.]]
|
||||
}
|
||||
}
|
||||
@property exit_code {
|
||||
[[ The final exit code of this task. ]]
|
||||
[[The final exit code of this task. This is the code that will be produced upon task completion.]]
|
||||
get { }
|
||||
values {
|
||||
code: int; [[ ]]
|
||||
code: int; [[The exit code.]]
|
||||
}
|
||||
}
|
||||
@property flags {
|
||||
[[Flags to further customize task's behavior.]]
|
||||
set { }
|
||||
get { }
|
||||
values {
|
||||
flags: Efl.Task_Flags; [[ ]]
|
||||
flags: Efl.Task_Flags; [[Desired task flags.]]
|
||||
}
|
||||
}
|
||||
run @pure_virtual {
|
||||
[[ Actually run the task ]]
|
||||
return: future<void> @owned; [[ A future triggered when task exits and is passed int exit code ]]
|
||||
[[Actually run the task.]]
|
||||
return: future<void> @owned; [[A future triggered when task exits and is passed int exit code.]]
|
||||
}
|
||||
end @pure_virtual {
|
||||
[[ Request the task end (may send a signal or interrupt
|
||||
[[Request the task end (may send a signal or interrupt
|
||||
signal resulting in a terminate event being tiggered in the
|
||||
target task loop) ]]
|
||||
target task loop).]]
|
||||
}
|
||||
}
|
||||
events {
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
enum @beta Efl.Canvas.Layout_Part_Text_Expand
|
||||
{
|
||||
[[Text layout policy to enforce. If none is set, min/max descriptions
|
||||
are taken in considerations solely.
|
||||
[[Text layout policy to enforce. If none is set, only min/max descriptions
|
||||
are taken into account.
|
||||
]]
|
||||
none = 0, [[No policy. Use default description parameters.]]
|
||||
min_x = 1,
|
||||
min_y = 1 << 1,
|
||||
max_x = 1 << 2,
|
||||
max_y = 1 << 3,
|
||||
min_x = 1, [[Text is tied to the left side of the container.]]
|
||||
min_y = 1 << 1, [[Text is tied to the top side of the container.]]
|
||||
max_x = 1 << 2, [[Text is tied to the right side of the container.]]
|
||||
max_y = 1 << 3, [[Text is tied to the bottom side of the container.]]
|
||||
}
|
||||
|
||||
class @beta Efl.Canvas.Layout_Part_Text extends Efl.Canvas.Layout_Part implements Efl.Text,
|
||||
|
|
@ -27,7 +27,7 @@ Efl.Text_Markup, Efl.Text_Markup_Interactive, Efl.Text_Format, Efl.Text_Font, Ef
|
|||
line-wrapping etc.
|
||||
]]
|
||||
values {
|
||||
type: Efl.Canvas.Layout_Part_Text_Expand;
|
||||
type: Efl.Canvas.Layout_Part_Text_Expand; [[Desired sizing policy.]]
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
enum @beta Efl.Ui.Scrollbar_Mode
|
||||
{
|
||||
[[When should the scrollbar be shown.]]
|
||||
auto = 0, [[Visible if necessary]]
|
||||
on, [[Always visible]]
|
||||
off, [[Always invisible]]
|
||||
|
|
@ -8,12 +9,15 @@ enum @beta Efl.Ui.Scrollbar_Mode
|
|||
|
||||
enum @beta Efl.Ui.Scrollbar_Direction
|
||||
{
|
||||
horizontal = 0,
|
||||
vertical,
|
||||
last
|
||||
[[What kind of scrollbar is this.]]
|
||||
horizontal = 0, [[Goes along the X axis.]]
|
||||
vertical, [[Goes along the Y axis.]]
|
||||
last [[For internal use only]]
|
||||
}
|
||||
interface @beta Efl.Ui.Scrollbar
|
||||
{
|
||||
[[Interface used by widgets which can display scrollbars, enabling them to contain more content
|
||||
than actually fits inside them.]]
|
||||
methods {
|
||||
@property bar_mode {
|
||||
[[Scrollbar visibility policy]]
|
||||
|
|
@ -22,19 +26,19 @@ interface @beta Efl.Ui.Scrollbar
|
|||
get {
|
||||
}
|
||||
values {
|
||||
hbar: Efl.Ui.Scrollbar_Mode; [[Horizontal scrollbar]]
|
||||
vbar: Efl.Ui.Scrollbar_Mode; [[Vertical scrollbar]]
|
||||
hbar: Efl.Ui.Scrollbar_Mode; [[Horizontal scrollbar.]]
|
||||
vbar: Efl.Ui.Scrollbar_Mode; [[Vertical scrollbar.]]
|
||||
}
|
||||
}
|
||||
@property bar_size {
|
||||
[[Scrollbar size.
|
||||
It is calculated based on viewport size-content sizes.
|
||||
]]
|
||||
]] // TODO: This needs more details. What does 1.0 mean?
|
||||
get {
|
||||
}
|
||||
values {
|
||||
width: double; [[Value between 0.0 and 1.0]]
|
||||
height: double; [[Value between 0.0 and 1.0]]
|
||||
width: double; [[Value between 0.0 and 1.0.]]
|
||||
height: double; [[Value between 0.0 and 1.0.]]
|
||||
}
|
||||
}
|
||||
@property bar_position {
|
||||
|
|
@ -46,25 +50,25 @@ interface @beta Efl.Ui.Scrollbar
|
|||
get {
|
||||
}
|
||||
values {
|
||||
posx: double; [[Value between 0.0 and 1.0]]
|
||||
posy: double; [[Value between 0.0 and 1.0]]
|
||||
posx: double; [[Value between 0.0 and 1.0.]]
|
||||
posy: double; [[Value between 0.0 and 1.0.]]
|
||||
}
|
||||
}
|
||||
bar_visibility_update @protected @beta{
|
||||
[[ Update bar visibility.
|
||||
[[Update bar visibility.
|
||||
|
||||
The object will call this function whenever the bar
|
||||
need to be shown or hidden.
|
||||
needs to be shown or hidden.
|
||||
]]
|
||||
}
|
||||
}
|
||||
events {
|
||||
bar,press: Efl.Ui.Scrollbar_Direction; [[Called when bar is pressed]]
|
||||
bar,unpress: Efl.Ui.Scrollbar_Direction; [[Called when bar is unpressed]]
|
||||
bar,drag: Efl.Ui.Scrollbar_Direction; [[Called when bar is dragged]]
|
||||
bar,size,changed: void; [[Called when bar size is changed]]
|
||||
bar,pos,changed: void; [[Called when bar position is changed]]
|
||||
bar,show: Efl.Ui.Scrollbar_Direction; [[Callend when bar is shown]]
|
||||
bar,hide: Efl.Ui.Scrollbar_Direction; [[Called when bar is hidden]]
|
||||
bar,press: Efl.Ui.Scrollbar_Direction; [[Called when bar is pressed.]]
|
||||
bar,unpress: Efl.Ui.Scrollbar_Direction; [[Called when bar is unpressed.]]
|
||||
bar,drag: Efl.Ui.Scrollbar_Direction; [[Called when bar is dragged.]]
|
||||
bar,size,changed: void; [[Called when bar size is changed.]]
|
||||
bar,pos,changed: void; [[Called when bar position is changed.]]
|
||||
bar,show: Efl.Ui.Scrollbar_Direction; [[Callend when bar is shown.]]
|
||||
bar,hide: Efl.Ui.Scrollbar_Direction; [[Called when bar is hidden.]]
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -45,6 +45,7 @@ struct @beta Efl.Dnd.Drag_Accept {
|
|||
}
|
||||
|
||||
struct @beta Efl.Dnd.Drag_Pos {
|
||||
[[Dragging position information.]]
|
||||
pos: Eina.Position2D; [[Evas Coordinate]]
|
||||
action: Efl.Ui.Selection_Action; [[The drag action]]
|
||||
format: Efl.Ui.Selection_Format; [[The drag format]]
|
||||
|
|
@ -52,6 +53,7 @@ struct @beta Efl.Dnd.Drag_Pos {
|
|||
}
|
||||
|
||||
struct @beta Efl.Dnd.Drag_Item_Container_Drop {
|
||||
[[Drop information for a drag&drop operation.]]
|
||||
item: Efl.Canvas.Object; [[The item object]]
|
||||
data: Efl.Ui.Selection_Data; [[The selection data]]
|
||||
pos: Eina.Position2D; [[Position relative to item (left (-1), middle (0), right (1)]]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/* FIXME: Define these structs in EO, or they are useless to bindings */
|
||||
struct @extern Elm.Photocam.Error;
|
||||
struct @extern Elm.Photocam.Progress;
|
||||
/* TODO: Define these structs in EO, or they are useless to bindings */
|
||||
struct @extern Elm.Photocam.Error; [[Photocam error information.]]
|
||||
struct @extern Elm.Photocam.Progress; [[Photocam progress information.]]
|
||||
|
||||
class @beta Efl.Ui.Image_Zoomable extends Efl.Ui.Image implements Efl.Ui.Zoom,
|
||||
Efl.Ui.Scrollable_Interactive,
|
||||
|
|
|
|||
|
|
@ -2,9 +2,10 @@ import elm_general;
|
|||
|
||||
struct @beta Efl.Ui.List_View_Item_Event
|
||||
{
|
||||
layout: Efl.Ui.Layout;
|
||||
child: Efl.Model;
|
||||
index: int;
|
||||
[[Information related to item events.]] // TODO: This needs to be filled in.
|
||||
layout: Efl.Ui.Layout; [[TBD]]
|
||||
child: Efl.Model; [[TBD]]
|
||||
index: int; [[TBD]]
|
||||
}
|
||||
class @beta Efl.Ui.List_View extends Efl.Ui.Layout_Base implements Efl.Ui.Scrollable_Interactive, Efl.Ui.Scrollbar,
|
||||
Efl.Access.Widget.Action, Efl.Access.Selection, Efl.Ui.Focus.Composition, Efl.Ui.Focus.Manager_Sub,
|
||||
|
|
@ -12,15 +13,14 @@ class @beta Efl.Ui.List_View extends Efl.Ui.Layout_Base implements Efl.Ui.Scroll
|
|||
{
|
||||
methods {
|
||||
@property homogeneous {
|
||||
[[When in homogeneous mode, all items have the same height and width. Otherwise, each item's size is respected.
|
||||
]]
|
||||
get {
|
||||
[[Get whether the homogeneous mode is enabled.]]
|
||||
}
|
||||
set {
|
||||
[[Enable/disable homogeneous mode.]]
|
||||
}
|
||||
values {
|
||||
homogeneous: bool; [[Assume the items within the genlist are of
|
||||
the same height and width. Default is $false.]]
|
||||
homogeneous: bool; [[Homogeneous mode setting. Default is $false.]]
|
||||
}
|
||||
}
|
||||
@property select_mode {
|
||||
|
|
@ -32,8 +32,9 @@ class @beta Efl.Ui.List_View extends Efl.Ui.Layout_Base implements Efl.Ui.Scroll
|
|||
}
|
||||
}
|
||||
@property default_style {
|
||||
[[TBD]] // TODO: This needs to be filled in. Does not seem to be in use.
|
||||
values {
|
||||
style: stringshare;
|
||||
style: stringshare; [[TBD]]
|
||||
}
|
||||
}
|
||||
@property layout_factory {
|
||||
|
|
|
|||
|
|
@ -9,4 +9,4 @@ struct @beta @free(free) Efl.Ui.List_View_Layout_Item {
|
|||
pos: Eina.Position2D;
|
||||
}
|
||||
|
||||
struct @beta Efl_Ui_List_View_Seg_Array;
|
||||
struct @beta Efl_Ui_List_View_Seg_Array; [[TBD]]
|
||||
|
|
|
|||
|
|
@ -52,6 +52,7 @@ function @beta Efl.Ui.Selection_Data_Ready {
|
|||
|
||||
struct @beta Efl.Ui.Selection_Changed
|
||||
{
|
||||
[[Selection-changed specific information.]] // TODO: This needs to be filled in.
|
||||
type: Efl.Ui.Selection_Type; [[Selection type]]
|
||||
seat: int; [[The seat on which the selection changed, or NULL for "default"]]
|
||||
display: void_ptr; [[The display connection object, NULL under X11]]
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
enum @beta Efl.Ui.Tab_Page_Tab_Changed {
|
||||
label = 0, [[Label changed]]
|
||||
icon [[Icon changed]]
|
||||
[[Which part of the tab has changed.]]
|
||||
label = 0, [[Label has changed.]]
|
||||
icon [[Icon has changed.]]
|
||||
}
|
||||
|
||||
struct @beta Efl.Ui.Tab_Page_Tab_Changed_Event {
|
||||
[[Information of changed event]]
|
||||
changed_info: Efl.Ui.Tab_Page_Tab_Changed;
|
||||
[[Information of changed event.]]
|
||||
changed_info: Efl.Ui.Tab_Page_Tab_Changed; [[Which part of the tab has changed.]]
|
||||
}
|
||||
|
||||
class @beta Efl.Ui.Tab_Page extends Efl.Ui.Layout_Base implements Efl.Content
|
||||
|
|
|
|||
|
|
@ -35,10 +35,10 @@ enum @beta Efl.Ui.Win_Type
|
|||
a new E-Mail received.]]
|
||||
combo, [[A window holding the contents of a combo box. Not usually used in
|
||||
the EFL.]]
|
||||
dnd,
|
||||
inlined_image,
|
||||
socket_image,
|
||||
fake,
|
||||
dnd, [[Internal use.]]
|
||||
inlined_image, [[Internal use.]]
|
||||
socket_image, [[Internal use.]]
|
||||
fake, [[Internal use.]]
|
||||
/* Some types have been removed from EO. Skipping to 17. */
|
||||
naviframe_basic = 17 [[Used for naviframe style replacement with a back
|
||||
button instead of a close button.
|
||||
|
|
|
|||
Loading…
Reference in New Issue