aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/io/reader
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/io/reader')
-rw-r--r--pages/develop/api/efl/io/reader/event/can_read_changed.txt22
-rw-r--r--pages/develop/api/efl/io/reader/event/eos.txt26
-rw-r--r--pages/develop/api/efl/io/reader/fd.txt42
-rw-r--r--pages/develop/api/efl/io/reader/fd/method/read.txt22
-rw-r--r--pages/develop/api/efl/io/reader/fd/property/can_read.txt22
-rw-r--r--pages/develop/api/efl/io/reader/fd/property/eos.txt22
-rw-r--r--pages/develop/api/efl/io/reader/fd/property/reader_fd.txt22
-rw-r--r--pages/develop/api/efl/io/reader/method/read.txt22
-rw-r--r--pages/develop/api/efl/io/reader/property/can_read.txt22
-rw-r--r--pages/develop/api/efl/io/reader/property/eos.txt22
10 files changed, 126 insertions, 118 deletions
diff --git a/pages/develop/api/efl/io/reader/event/can_read_changed.txt b/pages/develop/api/efl/io/reader/event/can_read_changed.txt
index d04267ce3..ba871a1ad 100644
--- a/pages/develop/api/efl/io/reader/event/can_read_changed.txt
+++ b/pages/develop/api/efl/io/reader/event/can_read_changed.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Reader: can_read,changed~~
+===== Description =====
+
+%%Notifies can_read property changed.%%
+
+%%If %%[[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]%% is %%''true''%% there is data to %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% without blocking/error. If %%[[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]%% is %%''false''%%, %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% would either block or fail.%%
+
+%%Note that usually this event is dispatched from inside %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%%, thus before it returns.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:event:can_read_changed:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -32,14 +43,3 @@ setup_event_handler(Eo *obj, Data *d)
</code>
-===== Description =====
-
-%%Notifies can_read property changed.%%
-
-%%If %%[[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]%% is %%''true''%% there is data to %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% without blocking/error. If %%[[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]%% is %%''false''%%, %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% would either block or fail.%%
-
-%%Note that usually this event is dispatched from inside %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%%, thus before it returns.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:event:can_read_changed:description&nouser&nolink&nodate}}
-
diff --git a/pages/develop/api/efl/io/reader/event/eos.txt b/pages/develop/api/efl/io/reader/event/eos.txt
index 292f8fdb5..de3957e66 100644
--- a/pages/develop/api/efl/io/reader/event/eos.txt
+++ b/pages/develop/api/efl/io/reader/event/eos.txt
@@ -1,4 +1,17 @@
~~Title: Efl.Io.Reader: eos~~
+===== Description =====
+
+%%Notifies end of stream, when property is marked as true.%%
+
+%%If this is used alongside with an %%[[:develop:api:efl:io:closer|Efl.Io.Closer]]%%, then it should be emitted before that call.%%
+
+%%It should be emitted only once for an object unless it implements %%[[:develop:api:efl:io:positioner:method:seek|Efl.Io.Positioner.seek]]%%.%%
+
+%%The property %%[[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]%% should change to %%''false''%% before this event is dispatched.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:event:eos:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -32,16 +45,3 @@ setup_event_handler(Eo *obj, Data *d)
</code>
-===== Description =====
-
-%%Notifies end of stream, when property is marked as true.%%
-
-%%If this is used alongside with an %%[[:develop:api:efl:io:closer|Efl.Io.Closer]]%%, then it should be emitted before that call.%%
-
-%%It should be emitted only once for an object unless it implements %%[[:develop:api:efl:io:positioner:method:seek|Efl.Io.Positioner.seek]]%%.%%
-
-%%The property %%[[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]%% should change to %%''false''%% before this event is dispatched.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:event:eos:description&nouser&nolink&nodate}}
-
diff --git a/pages/develop/api/efl/io/reader/fd.txt b/pages/develop/api/efl/io/reader/fd.txt
index 1ac0b5496..404551c83 100644
--- a/pages/develop/api/efl/io/reader/fd.txt
+++ b/pages/develop/api/efl/io/reader/fd.txt
@@ -40,29 +40,37 @@ digraph hierarchy {
++++
===== Members =====
-**[[:develop:api:efl:io:reader:fd:property:reader_fd|reader_fd]]** //**(get, set)**// ''protected set''
+**[[:develop:api:efl:io:reader:fd:method:read|read]]**// [Overridden from [[:develop:api:efl:io:reader|Efl.Io.Reader]]]//\\
+> %%Reads data into a pre-allocated buffer.%%
+<code c>
+Eina_Error efl_io_reader_read(Eo *obj, Eina_Rw_Slice rw_slice);
+</code>
+\\
+**[[:develop:api:efl:io:reader:fd:property:can_read|can_read]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:io:reader|Efl.Io.Reader]]]// ''protected set''\\
+> %%If %%''true''%% will notify %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
+<code c>
+Eina_Bool efl_io_reader_can_read_get(const Eo *obj);
+void efl_io_reader_can_read_set(Eo *obj, Eina_Bool can_read);
+</code>
+\\
+**[[:develop:api:efl:io:reader:fd:property:eos|eos]]** //**(get, set)**//// [Overridden from [[:develop:api:efl:io:reader|Efl.Io.Reader]]]// ''protected set''\\
+> %%If %%''true''%% will notify end of stream.%%
+<code c>
+Eina_Bool efl_io_reader_eos_get(const Eo *obj);
+void efl_io_reader_eos_set(Eo *obj, Eina_Bool is_eos);
+</code>
+\\
+**[[:develop:api:efl:io:reader:fd:property:reader_fd|reader_fd]]** //**(get, set)**// ''protected set''\\
+> %%Reader file descriptor%%
<code c>
int efl_io_reader_fd_get(const Eo *obj);
void efl_io_reader_fd_set(Eo *obj, int fd);
</code>
-
-%%Reader file descriptor%%\\
-\\
-
-==== Inherited ====
-
-[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:fd:method:read|read]]** //[Overridden here]//
-\\
-[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:fd:property:can_read|can_read]]** //**(get, set)**// //[Overridden here]// ''protected set''
-\\
-[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:fd:property:eos|eos]]** //**(get, set)**// //[Overridden here]// ''protected set''
-\\
+\\
===== Events =====
==== Inherited ====
-[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:event:can_read_changed|can_read,changed]]**
-\\
-[[:develop:api:efl:io:reader|Efl.Io.Reader]].**[[:develop:api:efl:io:reader:event:eos|eos]]**
-\\
+[[:develop:api:efl:io:reader|Efl.Io.Reader]]\\
+> **[[:develop:api:efl:io:reader:event:can_read_changed|can_read,changed]]**, **[[:develop:api:efl:io:reader:event:eos|eos]]** \ No newline at end of file
diff --git a/pages/develop/api/efl/io/reader/fd/method/read.txt b/pages/develop/api/efl/io/reader/fd/method/read.txt
index 1aa7753b4..f06f629b1 100644
--- a/pages/develop/api/efl/io/reader/fd/method/read.txt
+++ b/pages/develop/api/efl/io/reader/fd/method/read.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Reader.Fd.read~~
+===== Description =====
+
+%%Reads data into a pre-allocated buffer.%%
+
+%%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 implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
+
+%%You can understand this method as read(2) libc function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:fd:method:read:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]].//===== Signature =====
<code>
@@ -20,17 +31,6 @@ Eina_Error efl_io_reader_read(Eo *obj, Eina_Rw_Slice rw_slice);
* **rw_slice** //(inout)// - %%Provides a pre-allocated memory to be filled up to rw_slice.len. It will be populated and the length will be set to the actually used amount of bytes, which can be smaller than the request.%%
-===== Description =====
-
-%%Reads data into a pre-allocated buffer.%%
-
-%%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 implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
-
-%%You can understand this method as read(2) libc function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:fd:method:read:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]
diff --git a/pages/develop/api/efl/io/reader/fd/property/can_read.txt b/pages/develop/api/efl/io/reader/fd/property/can_read.txt
index a0732179e..0c7ec4fe4 100644
--- a/pages/develop/api/efl/io/reader/fd/property/can_read.txt
+++ b/pages/develop/api/efl/io/reader/fd/property/can_read.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Reader.Fd.can_read~~
+===== Values =====
+
+ * **can_read** - %%%%''true''%% if it can be read without blocking or failing, %%''false''%% otherwise%%
+===== Description =====
+
+%%If %%''true''%% will notify %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:fd:property:can_read:description&nouser&nolink&nodate}}
+
+
//Overridden from [[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]] **(get, set)**.//===== Signature =====
<code>
@@ -23,17 +34,6 @@ Eina_Bool efl_io_reader_can_read_get(const Eo *obj);
void efl_io_reader_can_read_set(Eo *obj, Eina_Bool can_read);
</code>
-===== Values =====
-
- * **can_read** - %%%%''true''%% if it can be read without blocking or failing, %%''false''%% otherwise%%
-===== Description =====
-
-%%If %%''true''%% will notify %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:fd:property:can_read:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* [[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]
diff --git a/pages/develop/api/efl/io/reader/fd/property/eos.txt b/pages/develop/api/efl/io/reader/fd/property/eos.txt
index 3feca07cf..18c3dfe1f 100644
--- a/pages/develop/api/efl/io/reader/fd/property/eos.txt
+++ b/pages/develop/api/efl/io/reader/fd/property/eos.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Reader.Fd.eos~~
+===== Values =====
+
+ * **is_eos** - %%%%''true''%% if end of stream, %%''false''%% otherwise%%
+===== Description =====
+
+%%If %%''true''%% will notify end of stream.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:fd:property:eos:description&nouser&nolink&nodate}}
+
+
//Overridden from [[:develop:api:efl:io:reader:property:eos|Efl.Io.Reader.eos]] **(get, set)**.//===== Signature =====
<code>
@@ -23,17 +34,6 @@ Eina_Bool efl_io_reader_eos_get(const Eo *obj);
void efl_io_reader_eos_set(Eo *obj, Eina_Bool is_eos);
</code>
-===== Values =====
-
- * **is_eos** - %%%%''true''%% if end of stream, %%''false''%% otherwise%%
-===== Description =====
-
-%%If %%''true''%% will notify end of stream.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:fd:property:eos:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* [[:develop:api:efl:io:reader:property:eos|Efl.Io.Reader.eos]]
diff --git a/pages/develop/api/efl/io/reader/fd/property/reader_fd.txt b/pages/develop/api/efl/io/reader/fd/property/reader_fd.txt
index ad12fa28e..20bf75090 100644
--- a/pages/develop/api/efl/io/reader/fd/property/reader_fd.txt
+++ b/pages/develop/api/efl/io/reader/fd/property/reader_fd.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Reader.Fd.reader_fd~~
+===== Values =====
+
+ * **fd** - %%File descriptor%%
+===== Description =====
+
+%%Reader file descriptor%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:fd:property:reader_fd:description&nouser&nolink&nodate}}
+
+
===== Signature =====
<code>
@@ -23,17 +34,6 @@ int efl_io_reader_fd_get(const Eo *obj);
void efl_io_reader_fd_set(Eo *obj, int fd);
</code>
-===== Values =====
-
- * **fd** - %%File descriptor%%
-===== Description =====
-
-%%Reader file descriptor%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:fd:property:reader_fd:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* **Efl.Io.Reader.Fd.reader_fd**
diff --git a/pages/develop/api/efl/io/reader/method/read.txt b/pages/develop/api/efl/io/reader/method/read.txt
index 6698722cb..e968112a3 100644
--- a/pages/develop/api/efl/io/reader/method/read.txt
+++ b/pages/develop/api/efl/io/reader/method/read.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Reader.read~~
+===== Description =====
+
+%%Reads data into a pre-allocated buffer.%%
+
+%%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 implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
+
+%%You can understand this method as read(2) libc function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:method:read:description&nouser&nolink&nodate}}
+
===== Signature =====
<code>
@@ -20,17 +31,6 @@ Eina_Error efl_io_reader_read(Eo *obj, Eina_Rw_Slice rw_slice);
* **rw_slice** //(inout)// - %%Provides a pre-allocated memory to be filled up to rw_slice.len. It will be populated and the length will be set to the actually used amount of bytes, which can be smaller than the request.%%
-===== Description =====
-
-%%Reads data into a pre-allocated buffer.%%
-
-%%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 implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
-
-%%You can understand this method as read(2) libc function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:method:read:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* **Efl.Io.Reader.read**
diff --git a/pages/develop/api/efl/io/reader/property/can_read.txt b/pages/develop/api/efl/io/reader/property/can_read.txt
index d6cf65bc4..fb8d5917c 100644
--- a/pages/develop/api/efl/io/reader/property/can_read.txt
+++ b/pages/develop/api/efl/io/reader/property/can_read.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Reader.can_read~~
+===== Values =====
+
+ * **can_read** - %%%%''true''%% if it can be read without blocking or failing, %%''false''%% otherwise%%
+===== Description =====
+
+%%If %%''true''%% will notify %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:property:can_read:description&nouser&nolink&nodate}}
+
+
===== Signature =====
<code>
@@ -23,17 +34,6 @@ Eina_Bool efl_io_reader_can_read_get(const Eo *obj);
void efl_io_reader_can_read_set(Eo *obj, Eina_Bool can_read);
</code>
-===== Values =====
-
- * **can_read** - %%%%''true''%% if it can be read without blocking or failing, %%''false''%% otherwise%%
-===== Description =====
-
-%%If %%''true''%% will notify %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:property:can_read:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* **Efl.Io.Reader.can_read**
diff --git a/pages/develop/api/efl/io/reader/property/eos.txt b/pages/develop/api/efl/io/reader/property/eos.txt
index 4797693ad..1500b2111 100644
--- a/pages/develop/api/efl/io/reader/property/eos.txt
+++ b/pages/develop/api/efl/io/reader/property/eos.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.Reader.eos~~
+===== Values =====
+
+ * **is_eos** - %%%%''true''%% if end of stream, %%''false''%% otherwise%%
+===== Description =====
+
+%%If %%''true''%% will notify end of stream.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:reader:property:eos:description&nouser&nolink&nodate}}
+
+
===== Signature =====
<code>
@@ -23,17 +34,6 @@ Eina_Bool efl_io_reader_eos_get(const Eo *obj);
void efl_io_reader_eos_set(Eo *obj, Eina_Bool is_eos);
</code>
-===== Values =====
-
- * **is_eos** - %%%%''true''%% if end of stream, %%''false''%% otherwise%%
-===== Description =====
-
-%%If %%''true''%% will notify end of stream.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:reader:property:eos:description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* **Efl.Io.Reader.eos**