forked from enlightenment/efl
docs: Fix typos and some wrong expressions in Ecore, Ecore_Audio, Ecore_Cocoa, Ecore_Con, and Ector API reference doxygen.
Summary: I had fixed some typos and wrong expressions, such as capital letters, $simbols in .eo and singulars in Ecore, Ecore_Audio, Ecore_Cocoa, Ecore_Con, and Ector API reference doxygen. Test Plan: Doxygen Revision Reviewers: Jaehyun_Cho, stefan, jpeg, cedric, raster Reviewed By: Jaehyun_Cho Differential Revision: https://phab.enlightenment.org/D4943
This commit is contained in:
parent
30b8c1ce82
commit
802b547310
|
@ -51,7 +51,7 @@ class Ecore.Exe (Efl.Object, Efl.Control)
|
||||||
event_prefix: ecore_exe;
|
event_prefix: ecore_exe;
|
||||||
methods {
|
methods {
|
||||||
@property command {
|
@property command {
|
||||||
[[Control the command that's executed. FIXME: May need a split/rename.]]
|
[[Controls the command that's executed. FIXME: May need a split/rename.]]
|
||||||
set {
|
set {
|
||||||
legacy: null;
|
legacy: null;
|
||||||
}
|
}
|
||||||
|
|
|
@ -50,7 +50,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
}
|
}
|
||||||
|
|
||||||
@property max_queue_size_input {
|
@property max_queue_size_input {
|
||||||
[[Limit how big the input queue can grow, in bytes.
|
[[Limits how big the input queue can grow, in bytes.
|
||||||
|
|
||||||
If limited and @.line_delimiter is set, "line" events
|
If limited and @.line_delimiter is set, "line" events
|
||||||
may be emitted with partial contents, without the
|
may be emitted with partial contents, without the
|
||||||
|
@ -66,7 +66,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
}
|
}
|
||||||
|
|
||||||
@property max_queue_size_output {
|
@property max_queue_size_output {
|
||||||
[[Limit how big the output queue can grow, in bytes.
|
[[Limits how big the output queue can grow, in bytes.
|
||||||
|
|
||||||
|
|
||||||
If limited, @Efl.Io.Writer.write will take less data than requested!
|
If limited, @Efl.Io.Writer.write will take less data than requested!
|
||||||
|
@ -84,7 +84,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
[[If set, incoming data will be checked for the delimiter and "line" events are The line may include the delimiter, unless it's end-of-stream on @.max_queue_size_input was reached.]]
|
[[If set, incoming data will be checked for the delimiter and "line" events are The line may include the delimiter, unless it's end-of-stream on @.max_queue_size_input was reached.]]
|
||||||
get { }
|
get { }
|
||||||
set {
|
set {
|
||||||
[[Change line delimiter to use. If empty, no delimiter is to be used]]
|
[[Changes line delimiter to use. If empty, no delimiter is to be used]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
// TODO: eolian generates wrong type for getter with const(Eina.Slice)
|
// TODO: eolian generates wrong type for getter with const(Eina.Slice)
|
||||||
|
@ -108,7 +108,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
}
|
}
|
||||||
|
|
||||||
@property read_chunk_size {
|
@property read_chunk_size {
|
||||||
[[Read chunk size property, in bytes.
|
[[Reads chunk size property, in bytes.
|
||||||
|
|
||||||
When reading the @.inner_io for data to be placed in
|
When reading the @.inner_io for data to be placed in
|
||||||
input queue, use this as chunk size.
|
input queue, use this as chunk size.
|
||||||
|
@ -124,7 +124,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
set {
|
set {
|
||||||
[[Set chunk size for each basic @Efl.Io.Reader.read operation.]]
|
[[Sets chunk size for each basic @Efl.Io.Reader.read operation.]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
size: size; [[This is the chunk size to use for read operations]]
|
size: size; [[This is the chunk size to use for read operations]]
|
||||||
|
@ -157,7 +157,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
}
|
}
|
||||||
|
|
||||||
@property slice {
|
@property slice {
|
||||||
[[Get a temporary access to input queue's internal read memory.
|
[[Gets a temporary access to input queue's internal read memory.
|
||||||
|
|
||||||
The memory pointed by slice may be changed by other
|
The memory pointed by slice may be changed by other
|
||||||
methods of this class. The event "slice,changed" will be
|
methods of this class. The event "slice,changed" will be
|
||||||
|
@ -170,7 +170,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
}
|
}
|
||||||
|
|
||||||
discard {
|
discard {
|
||||||
[[Discard the given number of bytes.
|
[[Discards the given number of bytes.
|
||||||
|
|
||||||
This has the same effect as reading and discarding the
|
This has the same effect as reading and discarding the
|
||||||
given amount of bytes, without executing the actual
|
given amount of bytes, without executing the actual
|
||||||
|
@ -194,7 +194,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
}
|
}
|
||||||
|
|
||||||
clear {
|
clear {
|
||||||
[[Clear the incoming queue. Same as reading all data.
|
[[Clears the incoming queue. Same as reading all data.
|
||||||
|
|
||||||
This is equivalent as calling @.discard with @.pending_read
|
This is equivalent as calling @.discard with @.pending_read
|
||||||
amount of bytes.
|
amount of bytes.
|
||||||
|
@ -202,7 +202,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
}
|
}
|
||||||
|
|
||||||
eos_mark {
|
eos_mark {
|
||||||
[[Mark this end-of-stream, signals nothing else will be written.
|
[[Marks this end-of-stream, signals nothing else will be written.
|
||||||
|
|
||||||
That will forbid any further writes.
|
That will forbid any further writes.
|
||||||
|
|
||||||
|
@ -230,7 +230,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_User, Efl.Io.Reader, Efl.Io.Writer, Efl.I
|
||||||
]]
|
]]
|
||||||
params {
|
params {
|
||||||
may_block: bool; [[If $true, then @Efl.Io.Reader.can_read and @Efl.Io.Writer.can_write are not checked and the call may block.]]
|
may_block: bool; [[If $true, then @Efl.Io.Reader.can_read and @Efl.Io.Writer.can_write are not checked and the call may block.]]
|
||||||
ignore_line_delimiter: bool; [[Force flush ignoring line delimiters]]
|
ignore_line_delimiter: bool; [[Forces flush ignoring line delimiters]]
|
||||||
}
|
}
|
||||||
return: bool(true); [[$true if all data was sent, $false otherwise]]
|
return: bool(true); [[$true if all data was sent, $false otherwise]]
|
||||||
}
|
}
|
||||||
|
|
|
@ -189,7 +189,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
|
||||||
[[If there is a line delimiter, the reads will buffer/queue up to the line delimiter before calling @Efl.Io.Writer.write on the @.destination and the event line is emitted with current line. The line may include the delimiter, unless it's end-of-stream on @.source or @.buffer_limit was reached.]]
|
[[If there is a line delimiter, the reads will buffer/queue up to the line delimiter before calling @Efl.Io.Writer.write on the @.destination and the event line is emitted with current line. The line may include the delimiter, unless it's end-of-stream on @.source or @.buffer_limit was reached.]]
|
||||||
get { }
|
get { }
|
||||||
set {
|
set {
|
||||||
[[Change line delimiter to use. If empty, no delimiter is to be used]]
|
[[Changes line delimiter to use. If empty, no delimiter is to be used]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
// TODO: eolian generates wrong type for getter with const(Eina.Slice)
|
// TODO: eolian generates wrong type for getter with const(Eina.Slice)
|
||||||
|
@ -272,7 +272,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
@property timeout_inactivity {
|
@property timeout_inactivity {
|
||||||
[[Terminate the copier with ETIMEDOUT if it becomes inactive for some time.
|
[[Terminates the copier with ETIMEDOUT if it becomes inactive for some time.
|
||||||
|
|
||||||
If the copier cannot do any read or write in the given
|
If the copier cannot do any read or write in the given
|
||||||
amount of seconds, then the copier will emit "error"
|
amount of seconds, then the copier will emit "error"
|
||||||
|
@ -355,7 +355,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
|
||||||
]]
|
]]
|
||||||
params {
|
params {
|
||||||
may_block: bool; [[If $true, then @Efl.Io.Reader.can_read and @Efl.Io.Writer.can_write are not checked and the call may block.]]
|
may_block: bool; [[If $true, then @Efl.Io.Reader.can_read and @Efl.Io.Writer.can_write are not checked and the call may block.]]
|
||||||
ignore_line_delimiter: bool; [[Force flush ignoring line delimiters]]
|
ignore_line_delimiter: bool; [[Forces flush ignoring line delimiters]]
|
||||||
}
|
}
|
||||||
return: bool(true); [[$true on success, $false otherwise]]
|
return: bool(true); [[$true on success, $false otherwise]]
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
mixin Efl.Io.Positioner.Fd (Efl.Io.Positioner) {
|
mixin Efl.Io.Positioner.Fd (Efl.Io.Positioner) {
|
||||||
[[Position fd using lseek(2).
|
[[Positions fd using lseek(2).
|
||||||
|
|
||||||
@since 1.19
|
@since 1.19
|
||||||
]]
|
]]
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
mixin Efl.Io.Reader.Fd (Efl.Io.Reader) {
|
mixin Efl.Io.Reader.Fd (Efl.Io.Reader) {
|
||||||
[[Read fd using read(2).
|
[[Reads fd using read(2).
|
||||||
|
|
||||||
@since 1.19
|
@since 1.19
|
||||||
]]
|
]]
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
mixin Efl.Io.Sizer.Fd (Efl.Io.Sizer) {
|
mixin Efl.Io.Sizer.Fd (Efl.Io.Sizer) {
|
||||||
[[Resize fd usign ftruncate(2).
|
[[Resizes fd usign ftruncate(2).
|
||||||
|
|
||||||
@since 1.19
|
@since 1.19
|
||||||
]]
|
]]
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
mixin Efl.Io.Writer.Fd (Efl.Io.Writer) {
|
mixin Efl.Io.Writer.Fd (Efl.Io.Writer) {
|
||||||
[[Write fd using write(2).
|
[[Writes fd using write(2).
|
||||||
|
|
||||||
@since 1.19
|
@since 1.19
|
||||||
]]
|
]]
|
||||||
|
|
|
@ -11,9 +11,9 @@ class Efl.Loop.Fd (Efl.Loop_User)
|
||||||
|
|
||||||
methods {
|
methods {
|
||||||
@property fd {
|
@property fd {
|
||||||
[[Define which file descriptor to watch. If it is a file, use file_fd variant.]]
|
[[Defines which file descriptor to watch. If it is a file, use file_fd variant.]]
|
||||||
set {
|
set {
|
||||||
[[Define the fd to watch on.]]
|
[[Defines the fd to watch on.]]
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
|
@ -22,9 +22,9 @@ class Efl.Loop.Fd (Efl.Loop_User)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property fd_file {
|
@property fd_file {
|
||||||
[[Define which file descriptor to watch when watching a file.]]
|
[[Defines which file descriptor to watch when watching a file.]]
|
||||||
set {
|
set {
|
||||||
[[Define the fd to watch on.]]
|
[[Defines the fd to watch on.]]
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
|
|
|
@ -33,7 +33,7 @@ class Efl.Loop.Timer (Efl.Loop_User)
|
||||||
* ecore_timer_delay(timer, ecore_timer_interval_get(timer) - ecore_timer_pending_get(timer));
|
* ecore_timer_delay(timer, ecore_timer_interval_get(timer) - ecore_timer_pending_get(timer));
|
||||||
* @endcode
|
* @endcode
|
||||||
*/
|
*/
|
||||||
[[Reset a timer to its full interval. This effectively makes the
|
[[Resets a timer to its full interval. This effectively makes the
|
||||||
timer start ticking off from zero now.
|
timer start ticking off from zero now.
|
||||||
|
|
||||||
@since 1.2
|
@since 1.2
|
||||||
|
@ -45,7 +45,7 @@ class Efl.Loop.Timer (Efl.Loop_User)
|
||||||
]]
|
]]
|
||||||
}
|
}
|
||||||
delay {
|
delay {
|
||||||
[[Add some delay for the next occurrence of a timer.
|
[[Adds some delay for the next occurrence of a timer.
|
||||||
This doesn't affect the interval of a timer.
|
This doesn't affect the interval of a timer.
|
||||||
]]
|
]]
|
||||||
params {
|
params {
|
||||||
|
|
|
@ -8,7 +8,7 @@ class Efl.Loop_User (Efl.Object)
|
||||||
@property loop {
|
@property loop {
|
||||||
[[The loop to which this object belongs to.]]
|
[[The loop to which this object belongs to.]]
|
||||||
get {
|
get {
|
||||||
[[Get a handle to the loop.]]
|
[[Gets a handle to the loop.]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
loop: Efl.Loop; [[Efl loop]]
|
loop: Efl.Loop; [[Efl loop]]
|
||||||
|
|
|
@ -13,7 +13,7 @@ class Efl.Model.Composite.Boolean (Efl.Object, Efl.Model)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
property_add {
|
property_add {
|
||||||
[[Add property]]
|
[[Adds property]]
|
||||||
params {
|
params {
|
||||||
@in name: string; [[Property name]]
|
@in name: string; [[Property name]]
|
||||||
@in initial_value: bool; [[Initial property value $bool]]
|
@in initial_value: bool; [[Initial property value $bool]]
|
||||||
|
|
|
@ -15,14 +15,14 @@ class Efl.Model.Container (Efl.Object, Efl.Model)
|
||||||
]]
|
]]
|
||||||
methods {
|
methods {
|
||||||
child_property_value_type_get {
|
child_property_value_type_get {
|
||||||
[[Get the type of the given property.]]
|
[[Gets the type of the given property.]]
|
||||||
params {
|
params {
|
||||||
name: string; [[Property name]]
|
name: string; [[Property name]]
|
||||||
}
|
}
|
||||||
return: ptr(const(Eina.Value.Type)); [[Property type]]
|
return: ptr(const(Eina.Value.Type)); [[Property type]]
|
||||||
}
|
}
|
||||||
child_property_values_get {
|
child_property_values_get {
|
||||||
[[Get the values for the given property.]]
|
[[Gets the values for the given property.]]
|
||||||
params {
|
params {
|
||||||
name: string; [[Property name]]
|
name: string; [[Property name]]
|
||||||
}
|
}
|
||||||
|
@ -30,7 +30,7 @@ class Efl.Model.Container (Efl.Object, Efl.Model)
|
||||||
[[The currently wrapped values]]
|
[[The currently wrapped values]]
|
||||||
}
|
}
|
||||||
child_property_add {
|
child_property_add {
|
||||||
[[Add the given property to child objects and supply the values.
|
[[Adds the given property to child objects and supply the values.
|
||||||
|
|
||||||
Each item will represent the value of the given property in the
|
Each item will represent the value of the given property in the
|
||||||
respective child within the data model.
|
respective child within the data model.
|
||||||
|
|
|
@ -11,7 +11,7 @@ class Efl.Model.Container.Item (Efl.Object, Efl.Model)
|
||||||
]]
|
]]
|
||||||
methods {
|
methods {
|
||||||
define {
|
define {
|
||||||
[[Define @Efl.Model.Container.Item internal data.]]
|
[[Defines @Efl.Model.Container.Item internal data.]]
|
||||||
params {
|
params {
|
||||||
parent_data: void_ptr; [[Pointer to the private data of the
|
parent_data: void_ptr; [[Pointer to the private data of the
|
||||||
@Efl.Model.Container parent object.]]
|
@Efl.Model.Container parent object.]]
|
||||||
|
@ -20,7 +20,7 @@ class Efl.Model.Container.Item (Efl.Object, Efl.Model)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
invalidate {
|
invalidate {
|
||||||
[[Invalidate the object preventing it from using the given parent
|
[[Invalidates the object preventing it from using the given parent
|
||||||
data.]]
|
data.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -5,7 +5,7 @@ class Efl.Promise (Efl.Loop_User)
|
||||||
[[Efl promise class]]
|
[[Efl promise class]]
|
||||||
methods {
|
methods {
|
||||||
progress_set {
|
progress_set {
|
||||||
[[Update the progress and send it immediately to all connected Efl_Future.
|
[[Updates the progress and send it immediately to all connected Efl_Future.
|
||||||
|
|
||||||
The progress is not kept and when the function return it will not be accessed
|
The progress is not kept and when the function return it will not be accessed
|
||||||
anymore. The pointer is owned by the caller and will remain so after the return
|
anymore. The pointer is owned by the caller and will remain so after the return
|
||||||
|
@ -16,7 +16,7 @@ class Efl.Promise (Efl.Loop_User)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property future {
|
@property future {
|
||||||
[[Request a new future linked to this promise.
|
[[Requests a new future linked to this promise.
|
||||||
|
|
||||||
Efl_Future are optional and will be automatically deleted if no then callback have
|
Efl_Future are optional and will be automatically deleted if no then callback have
|
||||||
been set before the next iteration of the main loop.
|
been set before the next iteration of the main loop.
|
||||||
|
@ -25,7 +25,7 @@ class Efl.Promise (Efl.Loop_User)
|
||||||
[[The returned new future.]]
|
[[The returned new future.]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
f: future<void_ptr, void_ptr>; [[Return a future where the value will be set by calling value_set while the progress will be updated by progress_set.]]
|
f: future<void_ptr, void_ptr>; [[Returns a future where the value will be set by calling value_set while the progress will be updated by progress_set.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property value {
|
@property value {
|
||||||
|
@ -43,7 +43,7 @@ class Efl.Promise (Efl.Loop_User)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property failed {
|
@property failed {
|
||||||
[[Define the failure state of this promise.]]
|
[[Defines the failure state of this promise.]]
|
||||||
set {
|
set {
|
||||||
[[
|
[[
|
||||||
This function can be called only once and you can not call #value.set after that.
|
This function can be called only once and you can not call #value.set after that.
|
||||||
|
@ -54,7 +54,7 @@ class Efl.Promise (Efl.Loop_User)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
connect {
|
connect {
|
||||||
[[Connect a future output to this promise.
|
[[Connects a future output to this promise.
|
||||||
|
|
||||||
This helper will automatically trigger #value.set or #failed.set when the future
|
This helper will automatically trigger #value.set or #failed.set when the future
|
||||||
succeed or fail respectively with the value provided by the future.
|
succeed or fail respectively with the value provided by the future.
|
||||||
|
@ -62,7 +62,7 @@ class Efl.Promise (Efl.Loop_User)
|
||||||
params {
|
params {
|
||||||
@in f: future<void_ptr, void_ptr>; [[The future to connect this promise to.]]
|
@in f: future<void_ptr, void_ptr>; [[The future to connect this promise to.]]
|
||||||
}
|
}
|
||||||
return: bool; [[Return false if unable to setup the connection.]]
|
return: bool; [[Returns $false if unable to setup the connection.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
events {
|
events {
|
||||||
|
|
|
@ -33,7 +33,7 @@ class Ecore.Audio (Efl.Object)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property paused {
|
@property paused {
|
||||||
[[Pause state of the object
|
[[Pauses state of the object
|
||||||
|
|
||||||
@since 1.8
|
@since 1.8
|
||||||
]]
|
]]
|
||||||
|
|
|
@ -54,7 +54,7 @@ class Ecore.Audio.In (Ecore.Audio)
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
preloaded: bool; [[$true if the input should be cached, false $otherwise]]
|
preloaded: bool; [[$true if the input should be cached, $false otherwise]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property looped {
|
@property looped {
|
||||||
|
|
|
@ -393,7 +393,7 @@ EAPI void ecore_cocoa_window_size_max_get(const Ecore_Cocoa_Window *window,
|
||||||
EINA_ARG_NONNULL(1);
|
EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set a Cocoa window's resize increment
|
* Sets a Cocoa window's resize increment
|
||||||
* @param window The Cocoa window which resize increment is to be set
|
* @param window The Cocoa window which resize increment is to be set
|
||||||
* @param w The width size increment
|
* @param w The width size increment
|
||||||
* @param h The height size increment
|
* @param h The height size increment
|
||||||
|
@ -405,7 +405,7 @@ EAPI void ecore_cocoa_window_size_step_set(Ecore_Cocoa_Window *window,
|
||||||
EINA_ARG_NONNULL(1);
|
EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a Cocoa window's resize increment
|
* Gets a Cocoa window's resize increment
|
||||||
* @param window The Cocoa window which resize increment queried
|
* @param window The Cocoa window which resize increment queried
|
||||||
* @param w The width size increment
|
* @param w The width size increment
|
||||||
* @param h The height size increment
|
* @param h The height size increment
|
||||||
|
@ -417,7 +417,7 @@ EAPI void ecore_cocoa_window_size_step_get(const Ecore_Cocoa_Window *window,
|
||||||
EINA_ARG_NONNULL(1);
|
EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Display a Cocoa window
|
* Displays a Cocoa window
|
||||||
* @param window The Cocoa window to be displayed
|
* @param window The Cocoa window to be displayed
|
||||||
* @since 1.18
|
* @since 1.18
|
||||||
*/
|
*/
|
||||||
|
@ -425,7 +425,7 @@ EAPI void ecore_cocoa_window_show(Ecore_Cocoa_Window *window)
|
||||||
EINA_ARG_NONNULL(1);
|
EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hide a Cocoa window
|
* Hides a Cocoa window
|
||||||
* @param window The Cocoa window to be hid
|
* @param window The Cocoa window to be hid
|
||||||
* @since 1.18
|
* @since 1.18
|
||||||
*/
|
*/
|
||||||
|
@ -467,7 +467,7 @@ EAPI void ecore_cocoa_window_title_set(Ecore_Cocoa_Window *window,
|
||||||
EINA_ARG_NONNULL(1);
|
EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Miniaturize or deminiaturize a Cocoa window
|
* Miniaturizes or deminiaturizes a Cocoa window
|
||||||
* @param window The Cocoa window which iconify status is to be changed
|
* @param window The Cocoa window which iconify status is to be changed
|
||||||
* @param on If #EINA_TRUE, will miniaturize the window. Will deminiaturize it if #EINA_FALSE
|
* @param on If #EINA_TRUE, will miniaturize the window. Will deminiaturize it if #EINA_FALSE
|
||||||
* @since 1.18
|
* @since 1.18
|
||||||
|
@ -477,7 +477,7 @@ EAPI void ecore_cocoa_window_iconified_set(Ecore_Cocoa_Window *window,
|
||||||
EINA_ARG_NONNULL(1);
|
EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Manage the borders of a Cocoa window
|
* Manages the borders of a Cocoa window
|
||||||
* @param window The Cocoa window which borders are to be changed
|
* @param window The Cocoa window which borders are to be changed
|
||||||
* @param on If #EINA_TRUE, will remove borders. Will restore them if #EINA_FALSE
|
* @param on If #EINA_TRUE, will remove borders. Will restore them if #EINA_FALSE
|
||||||
* @since 1.18
|
* @since 1.18
|
||||||
|
@ -487,7 +487,7 @@ EAPI void ecore_cocoa_window_borderless_set(Ecore_Cocoa_Window *window,
|
||||||
EINA_ARG_NONNULL(1);
|
EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the content view of a Cocoa window
|
* Sets the content view of a Cocoa window
|
||||||
*
|
*
|
||||||
* Refer to Apple's documentation of the property 'contentView' of
|
* Refer to Apple's documentation of the property 'contentView' of
|
||||||
* the NSWindow class for more details about the content view.
|
* the NSWindow class for more details about the content view.
|
||||||
|
@ -502,7 +502,7 @@ EAPI void ecore_cocoa_window_view_set(Ecore_Cocoa_Window *window,
|
||||||
EINA_ARG_NONNULL(2);
|
EINA_ARG_NONNULL(2);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the height of the title bar of Cocoa windows
|
* Gets the height of the title bar of Cocoa windows
|
||||||
* @return The height of the title bar of Cocoa windows
|
* @return The height of the title bar of Cocoa windows
|
||||||
* @since 1.18
|
* @since 1.18
|
||||||
*/
|
*/
|
||||||
|
@ -520,7 +520,7 @@ EAPI Ecore_Cocoa_Object *ecore_cocoa_window_get(const Ecore_Cocoa_Window *window
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the Cocoa cursor for a given Cocoa window
|
* Sets the Cocoa cursor for a given Cocoa window
|
||||||
* @param win The Cocoa window on which the cursor is to be changed.
|
* @param win The Cocoa window on which the cursor is to be changed.
|
||||||
* @param c The cursor to be set
|
* @param c The cursor to be set
|
||||||
* @since 1.18
|
* @since 1.18
|
||||||
|
@ -530,7 +530,7 @@ EAPI void ecore_cocoa_window_cursor_set(Ecore_Cocoa_Window *win,
|
||||||
EINA_ARG_NONNULL(1);
|
EINA_ARG_NONNULL(1);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Hide or show the Cocoa cursor for a given Cocoa window
|
* Hides or shows the Cocoa cursor for a given Cocoa window
|
||||||
* @param win The Cocoa window on which the cursor is to be hid
|
* @param win The Cocoa window on which the cursor is to be hid
|
||||||
* @param show Shows the cursor if EINA_TRUE. Hides it if EINA_FALSE
|
* @param show Shows the cursor if EINA_TRUE. Hides it if EINA_FALSE
|
||||||
* @since 1.18
|
* @since 1.18
|
||||||
|
@ -558,7 +558,7 @@ EAPI void ecore_cocoa_terminate_cb_set(Ecore_Cocoa_Terminate_Cb cb)
|
||||||
#ifdef EFL_BETA_API_SUPPORT
|
#ifdef EFL_BETA_API_SUPPORT
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Set the clipboard of Cocoa (NSPasteboard)
|
* Sets the clipboard of Cocoa (NSPasteboard)
|
||||||
* @param data The contents to be set in the clipboard
|
* @param data The contents to be set in the clipboard
|
||||||
* @param size The size in bytes of @c data
|
* @param size The size in bytes of @c data
|
||||||
* @param type
|
* @param type
|
||||||
|
@ -569,7 +569,7 @@ EAPI Eina_Bool ecore_cocoa_clipboard_set(const void *data,
|
||||||
Ecore_Cocoa_Cnp_Type type);
|
Ecore_Cocoa_Cnp_Type type);
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Get the contents of the Cocoa clipboard
|
* Gets the contents of the Cocoa clipboard
|
||||||
* @param size Pointer used to retrieve the size of the received contents
|
* @param size Pointer used to retrieve the size of the received contents
|
||||||
* @param type The type of object to retrieve from the clipboard
|
* @param type The type of object to retrieve from the clipboard
|
||||||
* @param retrieved_types The types of objects retrieved from the clipboard
|
* @param retrieved_types The types of objects retrieved from the clipboard
|
||||||
|
|
|
@ -37,7 +37,7 @@ struct Efl.Net.Control.Agent_Request_Input.Information {
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Efl.Net.Control.Agent_Request_Input {
|
struct Efl.Net.Control.Agent_Request_Input {
|
||||||
[[Request input to the agent.
|
[[Requests input to the agent.
|
||||||
|
|
||||||
@since 1.19
|
@since 1.19
|
||||||
]]
|
]]
|
||||||
|
@ -48,7 +48,7 @@ struct Efl.Net.Control.Agent_Request_Input {
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Efl.Net.Control.Agent_Error {
|
struct Efl.Net.Control.Agent_Error {
|
||||||
[[Report error to the agent.
|
[[Reports error to the agent.
|
||||||
|
|
||||||
@since 1.19
|
@since 1.19
|
||||||
]]
|
]]
|
||||||
|
@ -57,7 +57,7 @@ struct Efl.Net.Control.Agent_Error {
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Efl.Net.Control.Agent_Browser_Url {
|
struct Efl.Net.Control.Agent_Browser_Url {
|
||||||
[[Report to agent that it should open a browser at given URL.
|
[[Reports to agent that it should open a browser at given URL.
|
||||||
|
|
||||||
@since 1.19
|
@since 1.19
|
||||||
]]
|
]]
|
||||||
|
@ -66,7 +66,7 @@ struct Efl.Net.Control.Agent_Browser_Url {
|
||||||
}
|
}
|
||||||
|
|
||||||
class Efl.Net.Control (Efl.Loop_User) {
|
class Efl.Net.Control (Efl.Loop_User) {
|
||||||
[[Control network connectivity.
|
[[Controls network connectivity.
|
||||||
|
|
||||||
This class and its children objects are only useful to implement
|
This class and its children objects are only useful to implement
|
||||||
control of the network connectivity. If your application is only
|
control of the network connectivity. If your application is only
|
||||||
|
|
|
@ -154,7 +154,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
@property allow_redirects {
|
@property allow_redirects {
|
||||||
[[Allow HTTP redirects to be followed.
|
[[Allows HTTP redirects to be followed.
|
||||||
|
|
||||||
This should be set before dialing.
|
This should be set before dialing.
|
||||||
]]
|
]]
|
||||||
|
@ -166,7 +166,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
request_header_add {
|
request_header_add {
|
||||||
[[Add a request header 'key: value'.
|
[[Adds a request header 'key: value'.
|
||||||
|
|
||||||
See @.request_headers_clear
|
See @.request_headers_clear
|
||||||
|
|
||||||
|
@ -179,7 +179,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
request_headers_clear {
|
request_headers_clear {
|
||||||
[[Clear all request headers.
|
[[Clears all request headers.
|
||||||
|
|
||||||
See @.request_header_add
|
See @.request_header_add
|
||||||
|
|
||||||
|
@ -188,7 +188,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
request_headers_get {
|
request_headers_get {
|
||||||
[[Return an iterator to the key-value pairs for request headers]]
|
[[Returns an iterator to the key-value pairs for request headers]]
|
||||||
return: free(own(iterator<Efl.Net.Http.Header>), eina_iterator_free) @warn_unused; [[Iterator for request headers]]
|
return: free(own(iterator<Efl.Net.Http.Header>), eina_iterator_free) @warn_unused; [[Iterator for request headers]]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -242,7 +242,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
response_headers_get {
|
response_headers_get {
|
||||||
[[Return an iterator to the key-value pairs for the last response headers.
|
[[Returns an iterator to the key-value pairs for the last response headers.
|
||||||
|
|
||||||
Since multiple requests can happen if @.allow_redirects
|
Since multiple requests can happen if @.allow_redirects
|
||||||
is true, then all headers will be accumulated. This
|
is true, then all headers will be accumulated. This
|
||||||
|
@ -256,7 +256,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
response_headers_all_get {
|
response_headers_all_get {
|
||||||
[[Return an iterator to the key-value pairs for all response headers.
|
[[Returns an iterator to the key-value pairs for all response headers.
|
||||||
|
|
||||||
Since multiple requests can happen if @.allow_redirects
|
Since multiple requests can happen if @.allow_redirects
|
||||||
is true, then all headers will be accumulated. To know
|
is true, then all headers will be accumulated. To know
|
||||||
|
@ -281,7 +281,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
response_headers_clear {
|
response_headers_clear {
|
||||||
[[Save some memory by disposing the received headers]]
|
[[Saves some memory by disposing the received headers]]
|
||||||
}
|
}
|
||||||
|
|
||||||
@property progress_download {
|
@property progress_download {
|
||||||
|
@ -364,7 +364,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
date_parse @class {
|
date_parse @class {
|
||||||
[[Parse the given string as time in seconds since 1/1/1970.
|
[[Parses the given string as time in seconds since 1/1/1970.
|
||||||
|
|
||||||
This method is useful to parse header values such as
|
This method is useful to parse header values such as
|
||||||
"Last-Modified".
|
"Last-Modified".
|
||||||
|
@ -376,7 +376,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
|
||||||
}
|
}
|
||||||
|
|
||||||
date_serialize @class {
|
date_serialize @class {
|
||||||
[[Serialize the given GMT time in seconds since 1/1/1970.
|
[[Serializes the given GMT time in seconds since 1/1/1970.
|
||||||
|
|
||||||
The timezone must be GMT (ie: gmtime()).
|
The timezone must be GMT (ie: gmtime()).
|
||||||
]]
|
]]
|
||||||
|
|
|
@ -33,7 +33,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
|
||||||
}
|
}
|
||||||
|
|
||||||
@property dont_route {
|
@property dont_route {
|
||||||
[[Avoid sent UDP packets being routed by a gateway, limiting them to the local network.
|
[[Avoids sent UDP packets being routed by a gateway, limiting them to the local network.
|
||||||
|
|
||||||
This will use SO_DONTROUTE option to avoid gateways
|
This will use SO_DONTROUTE option to avoid gateways
|
||||||
routing sent packets to outside of local network. It's
|
routing sent packets to outside of local network. It's
|
||||||
|
@ -50,7 +50,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
|
||||||
}
|
}
|
||||||
|
|
||||||
multicast_join {
|
multicast_join {
|
||||||
[[Join a multicast group.
|
[[Joins a multicast group.
|
||||||
|
|
||||||
The multicast address should be in the format:
|
The multicast address should be in the format:
|
||||||
|
|
||||||
|
@ -71,7 +71,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
|
||||||
}
|
}
|
||||||
|
|
||||||
multicast_leave {
|
multicast_leave {
|
||||||
[[Leave a multicast group.
|
[[Leaves a multicast group.
|
||||||
|
|
||||||
This reverses the effect of @.multicast_join.
|
This reverses the effect of @.multicast_join.
|
||||||
]]
|
]]
|
||||||
|
@ -82,7 +82,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
|
||||||
}
|
}
|
||||||
|
|
||||||
multicast_groups_get {
|
multicast_groups_get {
|
||||||
[[Return the multicast groups this server has joined.
|
[[Returns the multicast groups this server has joined.
|
||||||
|
|
||||||
The iterator is only valid until a new group is joined
|
The iterator is only valid until a new group is joined
|
||||||
or left using @.multicast_join or @.multicast_leave.
|
or left using @.multicast_join or @.multicast_leave.
|
||||||
|
|
|
@ -72,7 +72,7 @@ mixin Ector.Buffer
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
pixels_set @pure_virtual {
|
pixels_set @pure_virtual {
|
||||||
[[Set the source pixels for this buffer, or allocate a new memory region]]
|
[[Sets the source pixels for this buffer, or allocate a new memory region]]
|
||||||
params {
|
params {
|
||||||
@in pixels: void_ptr; [[If $null, allocates an empty buffer]]
|
@in pixels: void_ptr; [[If $null, allocates an empty buffer]]
|
||||||
@in width: int; [[Buffer width]]
|
@in width: int; [[Buffer width]]
|
||||||
|
|
|
@ -21,7 +21,7 @@ abstract Ector.Renderer (Efl.Object)
|
||||||
[[Do not use.]]
|
[[Do not use.]]
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
[[Get the surface associated to this renderer. Can not be set.]]
|
[[Gets the surface associated to this renderer. Can not be set.]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
s: Ector.Surface; [[Associated surface]]
|
s: Ector.Surface; [[Associated surface]]
|
||||||
|
@ -108,7 +108,7 @@ abstract Ector.Renderer (Efl.Object)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
bounds_get @pure_virtual {
|
bounds_get @pure_virtual {
|
||||||
[[Retrieve the bounds of the renderer]]
|
[[Retrieves the bounds of the renderer]]
|
||||||
params {
|
params {
|
||||||
@out r: Eina.Rectangle; [[Bounds as @Eina.Rectangle]]
|
@out r: Eina.Rectangle; [[Bounds as @Eina.Rectangle]]
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue