docs: Update efl interface eo files for grammar and readability

Author: Nate Drake
This commit is contained in:
Andy Williams 2017-12-22 10:41:11 +00:00
parent f0d6a60cf8
commit 77dd065c52
20 changed files with 118 additions and 118 deletions

View File

@ -11,7 +11,7 @@ interface Efl.Gfx.Stack
[[Sets the layer of its canvas that the given object will be part of.
If you don't use this function, you'll be dealing with an unique
layer of objects, the default one. Additional layers are handy when
layer of objects (the default one). Additional layers are handy when
you don't want a set of objects to interfere with another set with
regard to stacking. Two layers are completely disjoint in that
matter.
@ -19,9 +19,9 @@ interface Efl.Gfx.Stack
This is a low-level function, which you'd be using when something
should be always on top, for example.
Warning: Be careful, it doesn't make sense to change the layer of
Warning: Don't change the layer of
smart objects' children. Smart objects have a layer of their own,
which should contain all their children objects.
which should contain all their child objects.
See also @.layer.get()]]
}
@ -62,12 +62,12 @@ interface Efl.Gfx.Stack
stack_below {
[[Stack $obj immediately $below
Objects, in a given canvas, are stacked in the order they get added
to it. This means that, if they overlap, the highest ones will
Objects, in a given canvas, are stacked in the order they're added.
This means that, if they overlap, the highest ones will
cover the lowest ones, in that order. This function is a way to
change the stacking order for the objects.
This function is intended to be used with objects belonging to
Its intended to be used with objects belonging to
the same layer in a given canvas, otherwise it will fail (and
accomplish nothing).
@ -96,12 +96,12 @@ interface Efl.Gfx.Stack
stack_above {
[[Stack $obj immediately $above
Objects, in a given canvas, are stacked in the order they get added
to it. This means that, if they overlap, the highest ones will
Objects, in a given canvas, are stacked in the order they're added.
This means that, if they overlap, the highest ones will
cover the lowest ones, in that order. This function is a way to
change the stacking order for the objects.
This function is intended to be used with objects belonging to
Its intended to be used with objects belonging to
the same layer in a given canvas, otherwise it will fail (and
accomplish nothing).

View File

@ -20,7 +20,7 @@ interface Efl.Image.Load ()
load_async_start {
[[Begin preloading an image object's image data in the background.
Once the background task is done, the event $load,done will be
Once the background task is complete the event $load,done will be
emitted.
]]
}
@ -28,7 +28,7 @@ interface Efl.Image.Load ()
[[Cancel preloading an image object's image data in the background.
The event $load,cancelled should be triggered soon after
cancellation happened, and the object should be left in a state
cancellation occurs and the object should be left in a state
where it has no image data. If cancel is called too late, the image
will be kept in memory.
]]
@ -51,7 +51,7 @@ interface Efl.Image.Load ()
[[The load size of an image.
The image will be loaded into memory as if it was the specified
size instead of its original size. This can save a lot of memory,
size instead of its original size. This can save a lot of memory
and is important for scalable types like svg.
By default, the load size is not specified, so it is 0x0.
@ -59,7 +59,7 @@ interface Efl.Image.Load ()
set {
[[Requests the canvas to load the image at the given size.
EFL will try to load the image at the requested size, but does
EFL will try to load an image of the requested size but does
not guarantee an exact match between the request and the loaded
image dimensions.
]]
@ -110,8 +110,8 @@ interface Efl.Image.Load ()
image's area on its image object.
Note: The image loader for the image format in question has
to support selective region loading in order to this function
to take effect.
to support selective region loading in order for this function
to work.
]]
}
get {
@ -144,11 +144,11 @@ interface Efl.Image.Load ()
@property load_scale_down {
[[The scale down factor is a divider on the original image size.
Setting the scale down factor can reduce load time and memory usage,
Setting the scale down factor can reduce load time and memory usage
at the cost of having a scaled down image in memory.
This function sets the scale down factor of a given canvas
image. Most useful for the SVG image loader, but also applies
image. Most useful for the SVG image loader but also applies
to JPEG, PNG and BMP.
Powers of two (2, 4, 8) are best supported (especially with JPEG)

View File

@ -10,7 +10,7 @@ enum Efl.Input.Device.Type
mouse, [[A mouse, trackball or touchpad relative motion device.]]
touch, [[A touchscreen with fingers or stylus.]]
pen, [[A special pen device.]]
wand, [[A laser pointer, wii-style or "minority report" pointing device.]]
wand, [[A laser pointer, wii-style or "Minority Report" pointing device.]]
gamepad, [[A gamepad controller or joystick.]]
}
@ -21,7 +21,7 @@ enum Efl.Input.Device.Type
class Efl.Input.Device (Efl.Object)
{
[[Represents a pointing device, such as a touch finger, a pen or a mouse.
[[Represents a pointing device such as a touch finger, pen or mouse.
@since 1.18
]]
@ -78,7 +78,7 @@ class Efl.Input.Device (Efl.Object)
Returns 1 for Mouse, Touch, Pen, Pointer, and Wand type devices.
If a seat device is passed, returns the number of pointer devices in the seat.
If a seat device is passed returns the number of pointer devices in the seat.
@since 1.20
]]

View File

@ -26,7 +26,7 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Ef
[[Adopt a read-only slice as buffer's backing store.
The slice memory will not be copied and must remain
alive during buffer's lifetime. Usually this is
alive during the buffer's lifetime. Usually this is
guaranteed by some global static-const memory or some
parent object and this buffer being a view of that -- be
aware of parent memory remaining alive, such as
@ -41,7 +41,7 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Ef
[[Adopt a read-write slice as buffer's backing store.
The slice memory will not be copied and must remain
alive during buffer's lifetime. Usually this is
alive during the buffer's lifetime. Usually this is
guaranteed by some global static memory or some
parent object and this buffer being a view of that -- be
aware of parent memory remaining alive, such as
@ -61,8 +61,8 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Ef
This affects both @.preallocate and how buffer grows
when @Efl.Io.Writer.write is called.
If you want a buffer of an exact size, always set the
limit before any further calls that can grow it.
If you want a buffer of an exact size always set the
limit before any further calls that can expand it.
]]
get { }
set {

View File

@ -26,7 +26,7 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) {
when @Efl.Io.Writer.write is called.
If you want a buffer of an exact size, always set the
limit before any further calls that can grow it.
limit before any further calls that can expand it.
]]
get { }
set {
@ -46,9 +46,9 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) {
}
@property slice {
[[Get a temporary access to queue's internal read memory.
[[Gain temporary access to queue's internal read memory.
The memory pointed by slice may be changed by other
The memory pointed to by slice may be changed by other
methods of this class. The event "slice,changed" will be
called in those situations.
]]
@ -70,11 +70,11 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) {
data must be discarded.
As an example, some protocols provide messages with a
"size" header, then @.slice is used to peek into the
"size" header, in which case @.slice is used to peek into the
available memory to see if there is a "size" and if the
rest of the slice is the full payload, in this case the
slice may be handled to some processing function. When
the function is done, that amount of data must be
rest of the slice is the full payload. In that situation the
slice may be handled by a processing function. When
the function is complete the defined amount of data must be
discarded -- with this function.
]]
params {
@ -83,9 +83,9 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) {
}
clear {
[[Clear the queue. Same as reading all data.
[[Clears the queue. Same as reading all data.
This is equivalent as calling @.discard with @.usage
This is equivalent to calling @.discard with @.usage
amount of bytes.
]]
}

View File

@ -4,10 +4,10 @@ interface Efl.Io.Writer {
[[Generic interface for objects that can write data from a provided memory.
This interface allows external objects to transparently write
data to this object and be notified if more data can be written
or it's topped capacity.
data to this object and be notified whether more data can be written
or if it's reached capacity.
Calls to @.write() may or may not block, that's not up to this
Calls to @.write() may or may not block: that's not up to this
interface to specify. The user can check with event
"can_write,changed" or property @.can_write to known whenever a write
could push more data.
@ -21,7 +21,7 @@ interface Efl.Io.Writer {
This operation will be executed immediately and may or
may not block the caller thread for some time. The
details of blocking behavior is to be defined by the
details of blocking behavior is defined by the
implementation and may be subject to other parameters
such as non-blocking flags, maximum timeout or even
retry attempts.

View File

@ -104,7 +104,7 @@ interface Efl.Model ()
[[Get children count.
When efl_model_load is completed efl_model_coildren_count_get
can be use to get the number of children. children_count_get
can be used to get the number of children. children_count_get
can also be used before calling children_slice_get so a valid
range is known. Event EFL_MODEL_CHILDREN_COUNT_CHANGED is
emitted when count is finished.

View File

@ -30,7 +30,7 @@ interface Efl.Pack (Efl.Container)
spot, replacing any already existing element or append to the end
of the container if there is no default part.
When this container is deleted, it will request deletion on the
When this container is deleted, it will request deletion of the
given $subobj. Use @.unpack to remove $subobj from this container
without deleting it.
]]

View File

@ -8,7 +8,7 @@ interface Efl.Pack.Linear (Efl.Pack)
This is the same as @.pack_at($subobj, 0).
When this container is deleted, it will request deletion on the
When this container is deleted, it will request deletion of the
given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
container without deleting it.
]]
@ -22,7 +22,7 @@ interface Efl.Pack.Linear (Efl.Pack)
This is the same as @.pack_at($subobj, -1).
When this container is deleted, it will request deletion on the
When this container is deleted, it will request deletion of the
given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
container without deleting it.
]]
@ -34,7 +34,7 @@ interface Efl.Pack.Linear (Efl.Pack)
pack_before {
[[Prepend item before other sub object.
When this container is deleted, it will request deletion on the
When this container is deleted, it will request deletion of the
given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
container without deleting it.
]]
@ -48,7 +48,7 @@ interface Efl.Pack.Linear (Efl.Pack)
pack_after {
[[Append item after other sub object.
When this container is deleted, it will request deletion on the
When this container is deleted, it will request deletion of the
given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
container without deleting it.
]]
@ -65,7 +65,7 @@ interface Efl.Pack.Linear (Efl.Pack)
Valid range: -$count to +$count. -1 refers to the last element.
Out of range indices will trigger an append.
When this container is deleted, it will request deletion on the
When this container is deleted, it will request deletion of the
given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
container without deleting it.
]]

View File

@ -8,7 +8,7 @@ interface Efl.Pack.Table (Efl.Pack.Linear)
pack_table {
[[Pack object at a given location in the table.
When this container is deleted, it will request deletion on the
When this container is deleted, it will request deletion of the
given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
container without deleting it.
]]

View File

@ -108,9 +108,9 @@ interface Efl.Text.Format {
}
@property replacement_char {
[[The character used to replace characters that can not be displayed
[[The character used to replace characters that can't be displayed
Currently, only used to replace characters if @.password
Currently only used to replace characters if @.password
is enabled.
]]
values {

View File

@ -6,13 +6,13 @@ interface Efl.Text.Properties
methods {
@property font {
set {
[[Set the font family or filename, and size on a given text object.
[[Set the font family, filename and size for a given text object.
This function allows the font name and size of a text object to
be set. The font string has to follow fontconfig's convention on
be set. The font string has to follow fontconfig's convention for
naming fonts, as it's the underlying library used to query system
fonts by Evas (see the fc-list command's output, on your system,
to get an idea). Alternatively, one can use a full path to a font
to get an idea). Alternatively, youe can use the full path to a font
file.
See also @.font.get, @.font_source.get.
@ -22,7 +22,7 @@ interface Efl.Text.Properties
[[Retrieve the font family and size in use on a given text object.
This function allows the font name and size of a text object to
be queried. Be aware that the font name string is still owned by
be queried. Remember that the font name string is still owned by
Evas and should not have free() called on it by the caller of the
function.

View File

@ -3,13 +3,13 @@ interface Efl.Ui.Clickable ()
[[Efl UI clickable interface]]
event_prefix: efl_ui;
events {
clicked; [[Called when object was clicked]]
clicked,double; [[Called when object received a double click]]
clicked,triple; [[Called when object received a triple click]]
clicked,right; [[Called when object received a right click]]
pressed; [[Called when the object was pressed]]
unpressed; [[Called when the object is now longer pressed]]
longpressed; [[Called when the object received a longpress]]
repeated; [[Called when the object received repeated presses/clicks]]
clicked; [[Called when object iss clicked]]
clicked,double; [[Called when object receives a double click]]
clicked,triple; [[Called when object receives a triple click]]
clicked,right; [[Called when object receives a right click]]
pressed; [[Called when the object is pressed]]
unpressed; [[Called when the object is no longer pressed]]
longpressed; [[Called when the object receives a long press]]
repeated; [[Called when the object receives repeated presses/clicks]]
}
}

View File

@ -10,31 +10,31 @@ interface Efl.Ui.Drag
]]
methods {
@property drag_value {
[[The dragable object relative location.
[[The draggable object relative location.
Some parts in Edje can be dragged along the X/Y axes, if the part
contains a "dragable" section (in EDC). For instance, scroll bars
can be dragable objects.
contains a "draggable" section (in EDC). For instance, scroll bars
can be draggable objects.
$dx and $dy are real numbers that range from 0 to 1, representing
the relative position to the dragable area on that axis.
the relative position to the draggable area on that axis.
This value means, for the vertical axis, that 0.0 will be at the top
if the first parameter of $y in the dragable part theme is 1, and at
if the first parameter of $y in the draggable part theme is 1 and at
the bottom if it is -1.
For the horizontal axis, 0.0 means left if the first parameter of $x
in the dragable part theme is 1, and right if it is -1.
in the draggable part theme is 1, and right if it is -1.
]]
set {
[[Sets the dragable object location.
[[Sets the draggable object location.
This places the dragable object at the given location.
This places the draggable object at the given location.
]]
return: bool; [[$true on success, $false otherwise]]
}
get {
[[Gets the dragable object location.]]
[[Gets the draggable object location.]]
return: bool; [[$true on success, $false otherwise]]
}
values {
@ -43,16 +43,16 @@ interface Efl.Ui.Drag
}
}
@property drag_size {
[[The dragable object relative size.
[[The draggable object relative size.
Values for $dw and $dh are real numbers that range from 0 to 1,
representing the relative size of the dragable area on that axis.
representing the relative size of the draggable area on that axis.
For instance a scroll bar handle size may depend on much large is
For instance a scroll bar handle size may depend on the size of
the scroller's content.
]]
set {
[[Sets the size of the dragable object.]]
[[Sets the size of the draggable object.]]
return: bool; [[$true on success, $false otherwise]]
}
get {
@ -65,14 +65,14 @@ interface Efl.Ui.Drag
}
}
@property drag_dir {
[[Determines the dragable directions (read-only).
[[Determines the draggable directions (read-only).
The dragable directions are defined in the EDC file, inside the
"dragable" section, by the attributes $x and $y. See the EDC
The draggable directions are defined in the EDC file, inside the
"draggable" section, by the attributes $x and $y. See the EDC
reference documentation for more information.
]]
get {
[[Gets the dragable direction.]]
[[Gets the draggable direction.]]
return: Efl.Ui.Drag.Dir; [[The direction(s) premitted for drag.]]
}
}
@ -80,7 +80,7 @@ interface Efl.Ui.Drag
[[The drag step increment.
Values for $dx and $dy are real numbers that range from 0 to 1,
representing the relative size of the dragable area on that axis by
representing the relative size of the draggable area on that axis by
which the part will be moved.
This differs from @.drag_page in that this is meant to
@ -89,11 +89,11 @@ interface Efl.Ui.Drag
See also @.drag_page.
]]
set {
[[Sets the x,y step increments for a dragable object.]]
[[Sets the x,y step increments for a draggable object.]]
return: bool; [[$true on success, $false otherwise]]
}
get {
[[Gets the x and y step increments for the dragable object.]]
[[Gets the x and y step increments for the draggable object.]]
return: bool; [[$true on success, $false otherwise]]
}
values {
@ -102,9 +102,9 @@ interface Efl.Ui.Drag
}
}
drag_step_move {
[[Moves the dragable by $dx,$dy steps.
[[Moves the draggable by $dx,$dy steps.
This moves the dragable part by $dx,$dy steps where the step
This moves the draggable part by $dx,$dy steps where the step
increment is the amount set by @.drag_step.set().
$dx and $dy can be positive or negative numbers, integer values are
@ -120,7 +120,7 @@ interface Efl.Ui.Drag
[[The page step increments.
Values for $dx and $dy are real numbers that range from 0 to 1,
representing the relative size of the dragable area on that axis by
representing the relative size of the draggable area on that axis by
which the part will be moved.
This differs from @.drag_step in that this is meant to be a
@ -134,7 +134,7 @@ interface Efl.Ui.Drag
return: bool; [[$true on success, $false otherwise]]
}
get {
[[Gets the x,y page step increments for the dragable object.]]
[[Gets the x,y page step increments for the draggable object.]]
return: bool; [[$true on success, $false otherwise]]
}
values {
@ -143,9 +143,9 @@ interface Efl.Ui.Drag
}
}
drag_page_move {
[[Moves the dragable by $dx,$dy pages.
[[Moves the draggable by $dx,$dy pages.
This moves the dragable by $dx,$dy pages where the increment is
This moves the draggable by $dx,$dy pages. The increment is
defined by @.drag_page.set().
$dx and $dy can be positive or negative numbers, integer values are

View File

@ -7,11 +7,11 @@ interface Efl.Ui.Draggable ()
@property drag_target {
[[Control whether the object's content is changed by drag and drop.
If $drag_target is true, the object can be target of dragging
object and the content of this object can be changed into
dragging content. For example, If object deals with image and
$drag_target is true, user can drag new image and drop it into
this object. And then this object's image can be changed into
If $drag_target is true the object can be the target of a dragging
object. The content of this object can then be changed into
dragging content. For example, if an object deals with image and
$drag_target is true, the user can drag the new image and drop it into
said object. This object's image can then be changed into a
new image.]]
set {
}

View File

@ -24,10 +24,10 @@ mixin Efl.Ui.Format
@property format_string {
[[Control the format string for a given units label
If $NULL is passed on $format, it will make $obj's units
area to be hidden completely. If not, it'll set the <b>format
string</b> for the units label's text. The units label is
provided a floating point value, so the units text is up display
If $NULL is passed to $format, it will hide $obj's units
area completely. If not, it'll set the <b>format
string</b> for the units label text. The units label is
provided as a floating point value, so the units text can display
at most one floating point value. Note that the units label is
optional. Use a format string such as "%1.2f meters" for example.

View File

@ -25,8 +25,8 @@ interface Efl.Ui.Range
Define the allowed range of values to be selected by the user.
If actual value is less than $min, it will be updated to $min.
If it is bigger then $max, will be updated to $max. Actual value
can be get with @Efl.Ui.Range.range_value.get
If it is bigger then $max, will be updated to $max. The actual value
can be obtained with @Efl.Ui.Range.range_value.get
The minimum and maximum values may be different for each class.

View File

@ -17,20 +17,20 @@ interface Efl.Ui.Scrollable ()
[[Efl UI scrollable interface]]
event_prefix: efl_ui;
events {
scroll,start; [[Called when scroll operation started]]
scroll; [[Called when scroll operation]]
scroll,stop; [[Called when scroll operation stopped]]
scroll,up; [[Called when scrolling to upwards]]
scroll,down; [[Called when scrolling to downwards]]
scroll,left; [[Called when scrolling to left]]
scroll,right; [[Called when scrolling to right]]
scroll,start; [[Called when scroll operation starts]]
scroll; [[Called when scrolling]]
scroll,stop; [[Called when scroll operation stops]]
scroll,up; [[Called when scrolling upwards]]
scroll,down; [[Called when scrolling downwards]]
scroll,left; [[Called when scrolling left]]
scroll,right; [[Called when scrolling right]]
edge,up; [[Called when hitting the top edge]]
edge,down; [[Called when hitting the bottom edge]]
edge,left; [[Called when hitting the left edge]]
edge,right; [[Called when hitting the right edge]]
scroll,anim,start; [[Called when scroll animation started]]
scroll,anim,stop; [[Called when scroll animation stopped]]
scroll,drag,start; [[Called when scroll drag started]]
scroll,drag,stop; [[Called when scroll drag stopped]]
scroll,anim,start; [[Called when scroll animation starts]]
scroll,anim,stop; [[Called when scroll animation stopps]]
scroll,drag,start; [[Called when scroll drag starts]]
scroll,drag,stop; [[Called when scroll drag stops]]
}
}

View File

@ -33,10 +33,10 @@ interface Efl.Ui.Scrollable.Interactive (Efl.Ui.Scrollable)
@property bounce_enabled {
[[Bouncing behavior
When scrolling, the scroller may "bounce" when reaching an edge of the
When scrolling, the scroller may "bounce" when reaching the edge of the
content object. This is a visual way to indicate the end has been reached.
This is enabled by default for both axis. This API will set if it is enabled
for the given axis with the boolean parameters for each axis.]]
This is enabled by default for both axes. This API will determine if it's enabled
for the given axis with the boolean parameters for each one.]]
set {
}
get {
@ -49,8 +49,8 @@ interface Efl.Ui.Scrollable.Interactive (Efl.Ui.Scrollable)
@property scroll_freeze {
[[Freeze property
This function will freeze scrolling movement (by input of a user).
Unlike efl_ui_scrollable_movement_block_set, this function freezes bidirectional.
If you want to freeze only one direction,
Unlike efl_ui_scrollable_movement_block_set, this function freezes bidirectionally.
If you want to freeze in only one direction,
See @.movement_block.set.
]]
get {
@ -88,7 +88,7 @@ interface Efl.Ui.Scrollable.Interactive (Efl.Ui.Scrollable)
[[Blocking of scrolling (per axis)
This function will block scrolling movement (by input of a user) in
a given direction. One can disable movements in the X axis, the Y
a given direction. You can disable movements in the X axis, the Y
axis or both. The default value is $none, where movements are
allowed in both directions.
]]

View File

@ -5,11 +5,11 @@ interface Efl.Ui.Selectable ()
events {
selected; [[Called when selected]]
unselected; [[Called when no longer selected]]
selection,paste; [[Called when selection got pasted]]
selection,copy; [[Called when selection was copied]]
selection,cut; [[Called when selection was cut]]
selection,paste; [[Called when selection is pasted]]
selection,copy; [[Called when selection is copied]]
selection,cut; [[Called when selection is cut]]
selection,start; [[Called at selection start]]
selection,changed; [[Called when selection changed]]
selection,cleared; [[Called when selection was cleared]]
selection,changed; [[Called when selection is changed]]
selection,cleared; [[Called when selection is cleared]]
}
}