forked from enlightenment/efl
docs: ecore: finish up eo file docs in ecore
This commit is contained in:
parent
e056e0b1d1
commit
6a322b1b2c
|
@ -15,9 +15,9 @@ struct Ecore.Exe.Event_Data
|
||||||
{
|
{
|
||||||
[[Ecore exe event data structure]]
|
[[Ecore exe event data structure]]
|
||||||
exe: Efl.Object; [[The handle to the process. FIXME: should actually be Ecore.Exe, workaround cyclic]]
|
exe: Efl.Object; [[The handle to the process. FIXME: should actually be Ecore.Exe, workaround cyclic]]
|
||||||
data: void_ptr; [[the raw binary data from the child process that was received]]
|
data: void_ptr; [[The raw binary data from the child process that was received]]
|
||||||
size: int; [[the size of this data in bytes]]
|
size: int; [[The size of this data in bytes]]
|
||||||
lines: ptr(Ecore.Exe.Event_Data.Line); [[an array of line data if line buffered, the last one has it's line member set to $NULL]]
|
lines: ptr(Ecore.Exe.Event_Data.Line); [[An array of line data if line buffered, the last one has it's line member set to $NULL]]
|
||||||
}
|
}
|
||||||
|
|
||||||
enum Ecore.Exe_Flags
|
enum Ecore.Exe_Flags
|
||||||
|
|
|
@ -6,10 +6,11 @@ mixin Efl.Io.Closer.Fd (Efl.Io.Closer) {
|
||||||
|
|
||||||
methods {
|
methods {
|
||||||
@property closer_fd {
|
@property closer_fd {
|
||||||
|
[[Closer file descriptor]]
|
||||||
get {}
|
get {}
|
||||||
set @protected {}
|
set @protected {}
|
||||||
values {
|
values {
|
||||||
fd: int;
|
fd: int; [[File descriptor]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -30,7 +30,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
|
||||||
[[Constructor-only property to set where to read data from]]
|
[[Constructor-only property to set where to read data from]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
source: Efl.Io.Reader;
|
source: Efl.Io.Reader; [[Reader source]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -41,7 +41,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
|
||||||
[[Constructor-only property to set where to write data to]]
|
[[Constructor-only property to set where to write data to]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
destination: Efl.Io.Writer;
|
destination: Efl.Io.Writer; [[Writer destination]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -79,11 +79,12 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
@property progress {
|
@property progress {
|
||||||
|
[[Progress for read or write]]
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
read: uint64 @optional; [[amount of bytes read from source]]
|
read: uint64 @optional; [[Amount of bytes read from source]]
|
||||||
written: uint64 @optional; [[amount of bytes written to destination]]
|
written: uint64 @optional; [[Amount of bytes written to destination]]
|
||||||
total: uint64 @optional; [[If @.source is an Efl.Io.Sizer, its total size. Otherwise 0 to report unknown size]]
|
total: uint64 @optional; [[If @.source is an Efl.Io.Sizer, its total size. Otherwise 0 to report unknown size]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -109,7 +110,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
|
||||||
The buffer is then owned by caller, which should call
|
The buffer is then owned by caller, which should call
|
||||||
eina_binbuf_free() when it's done.
|
eina_binbuf_free() when it's done.
|
||||||
]]
|
]]
|
||||||
return: free(own(ptr(Eina.Binbuf)), eina_binbuf_free) @warn_unused;
|
return: free(own(ptr(Eina.Binbuf)), eina_binbuf_free) @warn_unused; [[Binbuf]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ class Efl.Io.File (Efl.Loop.Fd, Efl.File, Efl.Io.Reader.Fd, Efl.Io.Writer.Fd, Ef
|
||||||
|
|
||||||
methods {
|
methods {
|
||||||
@property flags {
|
@property flags {
|
||||||
[[bitwise OR'ed flags to open the file, like O_CREAT, O_APPEND...
|
[[Bitwise OR'ed flags to open the file, like O_CREAT, O_APPEND...
|
||||||
|
|
||||||
Defaults to O_RDONLY | O_CLOEXEC.
|
Defaults to O_RDONLY | O_CLOEXEC.
|
||||||
|
|
||||||
|
@ -23,11 +23,11 @@ class Efl.Io.File (Efl.Loop.Fd, Efl.File, Efl.Io.Reader.Fd, Efl.Io.Writer.Fd, Ef
|
||||||
}
|
}
|
||||||
|
|
||||||
set {
|
set {
|
||||||
[[constructor property to define flags to open the file]]
|
[[Constructor property to define flags to open the file]]
|
||||||
}
|
}
|
||||||
|
|
||||||
values {
|
values {
|
||||||
flags: uint32; [[flags to open file, see man:open(2).]]
|
flags: uint32; [[Flags to open file, see man:open(2).]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -36,11 +36,11 @@ class Efl.Io.File (Efl.Loop.Fd, Efl.File, Efl.Io.Reader.Fd, Efl.Io.Writer.Fd, Ef
|
||||||
}
|
}
|
||||||
|
|
||||||
set {
|
set {
|
||||||
[[constructor property to define mode to open the file]]
|
[[Constructor property to define mode to open the file]]
|
||||||
}
|
}
|
||||||
|
|
||||||
values {
|
values {
|
||||||
mode: uint32; [[mode to open file, see man:open(2).]]
|
mode: uint32; [[Mode to open file, see man:open(2).]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,10 +6,11 @@ mixin Efl.Io.Positioner.Fd (Efl.Io.Positioner) {
|
||||||
|
|
||||||
methods {
|
methods {
|
||||||
@property positioner_fd {
|
@property positioner_fd {
|
||||||
|
[[Positionier file descriptor]]
|
||||||
get {}
|
get {}
|
||||||
set @protected {}
|
set @protected {}
|
||||||
values {
|
values {
|
||||||
fd: int;
|
fd: int; [[File descriptor]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,10 +6,11 @@ mixin Efl.Io.Reader.Fd (Efl.Io.Reader) {
|
||||||
|
|
||||||
methods {
|
methods {
|
||||||
@property reader_fd {
|
@property reader_fd {
|
||||||
|
[[Reader file descriptor]]
|
||||||
get {}
|
get {}
|
||||||
set @protected {}
|
set @protected {}
|
||||||
values {
|
values {
|
||||||
fd: int;
|
fd: int; [[File descriptor]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,10 +6,11 @@ mixin Efl.Io.Sizer.Fd (Efl.Io.Sizer) {
|
||||||
|
|
||||||
methods {
|
methods {
|
||||||
@property sizer_fd {
|
@property sizer_fd {
|
||||||
|
[[Sizer file descriptor]]
|
||||||
get {}
|
get {}
|
||||||
set @protected {}
|
set @protected {}
|
||||||
values {
|
values {
|
||||||
fd: int;
|
fd: int; [[File descriptor]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,10 +6,11 @@ mixin Efl.Io.Writer.Fd (Efl.Io.Writer) {
|
||||||
|
|
||||||
methods {
|
methods {
|
||||||
@property writer_fd {
|
@property writer_fd {
|
||||||
|
[[Writer file descriptor]]
|
||||||
get {}
|
get {}
|
||||||
set @protected {}
|
set @protected {}
|
||||||
values {
|
values {
|
||||||
fd: int;
|
fd: int; [[File descriptor]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -23,7 +23,7 @@ class Efl.Loop (Efl.Object)
|
||||||
[[Points to the main loop instance of the application.]]
|
[[Points to the main loop instance of the application.]]
|
||||||
get {}
|
get {}
|
||||||
values {
|
values {
|
||||||
main_loop: Efl.Loop;
|
main_loop: Efl.Loop; [[Application main loop]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property app_efl_version {
|
@property app_efl_version {
|
||||||
|
@ -33,7 +33,7 @@ class Efl.Loop (Efl.Object)
|
||||||
]]
|
]]
|
||||||
get {}
|
get {}
|
||||||
values {
|
values {
|
||||||
version: ptr(const(Efl.Version));
|
version: ptr(const(Efl.Version)); [[Efl version]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property efl_version {
|
@property efl_version {
|
||||||
|
@ -43,7 +43,7 @@ class Efl.Loop (Efl.Object)
|
||||||
]]
|
]]
|
||||||
get {}
|
get {}
|
||||||
values {
|
values {
|
||||||
version: ptr(const(Efl.Version));
|
version: ptr(const(Efl.Version)); [[Efl version]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
iterate {
|
iterate {
|
||||||
|
@ -53,7 +53,7 @@ class Efl.Loop (Efl.Object)
|
||||||
iterate_may_block {
|
iterate_may_block {
|
||||||
[[Runs a single iteration of the main loop to process everything on the
|
[[Runs a single iteration of the main loop to process everything on the
|
||||||
queue with block/non-blocking status.]]
|
queue with block/non-blocking status.]]
|
||||||
return: int;
|
return: int; [[Return from single iteration run]]
|
||||||
params {
|
params {
|
||||||
may_block: int; [[A flag if the main loop has a possibility of blocking.]]
|
may_block: int; [[A flag if the main loop has a possibility of blocking.]]
|
||||||
}
|
}
|
||||||
|
|
|
@ -34,9 +34,9 @@ class Efl.Loop.Fd (Efl.Loop_User)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
events {
|
events {
|
||||||
read;
|
read; [[Called when a read happened on the file descriptor]]
|
||||||
write;
|
write; [[Called when a write happened on the file descriptor]]
|
||||||
error;
|
error; [[Called when a error occurred on the file descriptor]]
|
||||||
}
|
}
|
||||||
implements {
|
implements {
|
||||||
Efl.Object.constructor;
|
Efl.Object.constructor;
|
||||||
|
|
|
@ -25,7 +25,7 @@ class Efl.Loop.Timer (Efl.Loop_User)
|
||||||
@property pending {
|
@property pending {
|
||||||
[[Pending time regarding a timer.]]
|
[[Pending time regarding a timer.]]
|
||||||
get {
|
get {
|
||||||
return: double;
|
return: double; [[Pending time]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
reset {
|
reset {
|
||||||
|
|
|
@ -6,7 +6,8 @@ class Efl.Loop_User (Efl.Object)
|
||||||
eo_prefix: efl_loop;
|
eo_prefix: efl_loop;
|
||||||
methods {
|
methods {
|
||||||
loop_get {
|
loop_get {
|
||||||
return: Efl.Loop;
|
[[Get loop]]
|
||||||
|
return: Efl.Loop; [[Efl loop]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
implements {
|
implements {
|
||||||
|
|
|
@ -2,6 +2,7 @@ import eina_types;
|
||||||
|
|
||||||
class Efl.Promise (Efl.Loop_User)
|
class Efl.Promise (Efl.Loop_User)
|
||||||
{
|
{
|
||||||
|
[[Efl promise class]]
|
||||||
methods {
|
methods {
|
||||||
progress_set {
|
progress_set {
|
||||||
[[Update the progress and send it immediately to all connected Efl_Future.
|
[[Update the progress and send it immediately to all connected Efl_Future.
|
||||||
|
@ -11,7 +12,7 @@ class Efl.Promise (Efl.Loop_User)
|
||||||
of the function call.
|
of the function call.
|
||||||
]]
|
]]
|
||||||
params {
|
params {
|
||||||
@in p: const(void_ptr);
|
@in p: const(void_ptr); [[Progress to be set]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property future {
|
@property future {
|
||||||
|
|
Loading…
Reference in New Issue