aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/io/file
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/io/file')
-rw-r--r--pages/develop/api/efl/io/file/method/close.txt22
-rw-r--r--pages/develop/api/efl/io/file/method/constructor.txt14
-rw-r--r--pages/develop/api/efl/io/file/method/destructor.txt14
-rw-r--r--pages/develop/api/efl/io/file/method/finalize.txt10
-rw-r--r--pages/develop/api/efl/io/file/method/read.txt22
-rw-r--r--pages/develop/api/efl/io/file/method/resize.txt14
-rw-r--r--pages/develop/api/efl/io/file/method/seek.txt14
-rw-r--r--pages/develop/api/efl/io/file/method/write.txt22
-rw-r--r--pages/develop/api/efl/io/file/property/close_on_exec.txt44
-rw-r--r--pages/develop/api/efl/io/file/property/fd_file.txt32
-rw-r--r--pages/develop/api/efl/io/file/property/file.txt54
-rw-r--r--pages/develop/api/efl/io/file/property/flags.txt48
-rw-r--r--pages/develop/api/efl/io/file/property/mode.txt40
13 files changed, 175 insertions, 175 deletions
diff --git a/pages/develop/api/efl/io/file/method/close.txt b/pages/develop/api/efl/io/file/method/close.txt
index d74881d17..f4fa78e5b 100644
--- a/pages/develop/api/efl/io/file/method/close.txt
+++ b/pages/develop/api/efl/io/file/method/close.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.File.close~~
+===== Description =====
+
+%%Closes the Input/Output object.%%
+
+%%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 close(2) libc function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:file:method:close:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:closer:fd:method:close|Efl.Io.Closer.close]].//===== Signature =====
<code>
@@ -13,17 +24,6 @@ close @pure_virtual {
Eina_Error efl_io_closer_close(Eo *obj);
</code>
-===== Description =====
-
-%%Closes the Input/Output object.%%
-
-%%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 close(2) libc function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:file:method:close:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]]
diff --git a/pages/develop/api/efl/io/file/method/constructor.txt b/pages/develop/api/efl/io/file/method/constructor.txt
index 24e5e66d9..9e1ca90f3 100644
--- a/pages/develop/api/efl/io/file/method/constructor.txt
+++ b/pages/develop/api/efl/io/file/method/constructor.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Io.File.constructor~~
+===== Description =====
+
+%%Call the object's constructor.%%
+
+%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
+{{page>:develop:api-include:efl:io:file:method:constructor:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:loop:fd:method:constructor|Efl.Object.constructor]].//===== Signature =====
<code>
@@ -13,13 +20,6 @@ constructor {
Efl_Object *efl_constructor(Eo *obj);
</code>
-===== Description =====
-
-%%Call the object's constructor.%%
-
-%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
-{{page>:develop:api-include:efl:io:file:method:constructor:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:object:method:constructor|Efl.Object.constructor]]
diff --git a/pages/develop/api/efl/io/file/method/destructor.txt b/pages/develop/api/efl/io/file/method/destructor.txt
index 4e719979e..57747498c 100644
--- a/pages/develop/api/efl/io/file/method/destructor.txt
+++ b/pages/develop/api/efl/io/file/method/destructor.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Io.File.destructor~~
+===== Description =====
+
+%%Call the object's destructor.%%
+
+%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
+{{page>:develop:api-include:efl:io:file:method:destructor:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:loop:fd:method:destructor|Efl.Object.destructor]].//===== Signature =====
<code>
@@ -11,13 +18,6 @@ destructor {}
void efl_destructor(Eo *obj);
</code>
-===== Description =====
-
-%%Call the object's destructor.%%
-
-%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
-{{page>:develop:api-include:efl:io:file:method:destructor:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]]
diff --git a/pages/develop/api/efl/io/file/method/finalize.txt b/pages/develop/api/efl/io/file/method/finalize.txt
index 698e87cd6..35dd7ee4a 100644
--- a/pages/develop/api/efl/io/file/method/finalize.txt
+++ b/pages/develop/api/efl/io/file/method/finalize.txt
@@ -1,4 +1,9 @@
~~Title: Efl.Io.File.finalize~~
+===== Description =====
+
+%%Called at the end of #eo_add. Should not be called, just overridden.%%
+{{page>:develop:api-include:efl:io:file:method:finalize:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]].//===== Signature =====
<code>
@@ -13,11 +18,6 @@ finalize {
Efl_Object *efl_finalize(Eo *obj);
</code>
-===== Description =====
-
-%%Called at the end of #eo_add. Should not be called, just overridden.%%
-{{page>:develop:api-include:efl:io:file:method:finalize:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]]
diff --git a/pages/develop/api/efl/io/file/method/read.txt b/pages/develop/api/efl/io/file/method/read.txt
index eccb184dc..741585fc2 100644
--- a/pages/develop/api/efl/io/file/method/read.txt
+++ b/pages/develop/api/efl/io/file/method/read.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.File.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:file:method:read:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:reader:fd: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:file: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/file/method/resize.txt b/pages/develop/api/efl/io/file/method/resize.txt
index 2aaaf3a13..e9309bc51 100644
--- a/pages/develop/api/efl/io/file/method/resize.txt
+++ b/pages/develop/api/efl/io/file/method/resize.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Io.File.resize~~
+===== Description =====
+
+%%Resize object%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:file:method:resize:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:sizer:fd:method:resize|Efl.Io.Sizer.resize]].//===== Signature =====
<code>
@@ -20,13 +27,6 @@ Eina_Error efl_io_sizer_resize(Eo *obj, uint64_t size);
* **size** //(in)// - %%Object size%%
-===== Description =====
-
-%%Resize object%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:file:method:resize:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:sizer:method:resize|Efl.Io.Sizer.resize]]
diff --git a/pages/develop/api/efl/io/file/method/seek.txt b/pages/develop/api/efl/io/file/method/seek.txt
index 269733c43..3310d60e6 100644
--- a/pages/develop/api/efl/io/file/method/seek.txt
+++ b/pages/develop/api/efl/io/file/method/seek.txt
@@ -1,4 +1,11 @@
~~Title: Efl.Io.File.seek~~
+===== Description =====
+
+%%Seek in data%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:file:method:seek:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:positioner:fd:method:seek|Efl.Io.Positioner.seek]].//===== Signature =====
<code>
@@ -22,13 +29,6 @@ Eina_Error efl_io_positioner_seek(Eo *obj, int64_t offset, Efl_Io_Positioner_Whe
* **offset** //(in)// - %%Offset in byte relative to whence%%
* **whence** //(in)// - %%Whence%%
-===== Description =====
-
-%%Seek in data%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:file:method:seek:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:positioner:method:seek|Efl.Io.Positioner.seek]]
diff --git a/pages/develop/api/efl/io/file/method/write.txt b/pages/develop/api/efl/io/file/method/write.txt
index 9a2845167..30a0d8275 100644
--- a/pages/develop/api/efl/io/file/method/write.txt
+++ b/pages/develop/api/efl/io/file/method/write.txt
@@ -1,4 +1,15 @@
~~Title: Efl.Io.File.write~~
+===== Description =====
+
+%%Writes data from a pre-populated 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 write(2) libc function.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:file:method:write:description&nouser&nolink&nodate}}
+
//Overridden from [[:develop:api:efl:io:writer:fd:method:write|Efl.Io.Writer.write]].//===== Signature =====
<code>
@@ -22,17 +33,6 @@ Eina_Error efl_io_writer_write(Eo *obj, Eina_Slice slice, Eina_Slice *remaining)
* **slice** //(inout)// - %%Provides a pre-populated memory to be used up to slice.len. The returned slice will be adapted as length will be set to the actually used amount of bytes, which can be smaller than the request.%%
* **remaining** //(out)// - %%Convenience to output the remaining parts of slice that was not written. If the full slice was written, this will be a slice of zero-length.%%
-===== Description =====
-
-%%Writes data from a pre-populated 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 write(2) libc function.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:file:method:write:description&nouser&nolink&nodate}}
-
===== Implemented by =====
* [[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]]
diff --git a/pages/develop/api/efl/io/file/property/close_on_exec.txt b/pages/develop/api/efl/io/file/property/close_on_exec.txt
index 5dd518e3f..40c2b8eb7 100644
--- a/pages/develop/api/efl/io/file/property/close_on_exec.txt
+++ b/pages/develop/api/efl/io/file/property/close_on_exec.txt
@@ -1,4 +1,26 @@
~~Title: Efl.Io.File.close_on_exec~~
+===== Values =====
+
+ * **close_on_exec** - %%%%''true''%% if close on exec(), %%''false''%% otherwise%%
+===== Description =====
+
+%%If true will automatically close resources on exec() calls.%%
+
+%%When using file descriptors this should set FD_CLOEXEC so they are not inherited by the processes (children or self) doing exec().%%
+
+//Since 1.19//
+
+
+{{page>:develop:api-include:efl:io:file:property:close_on_exec:description&nouser&nolink&nodate}}
+
+==== Setter ====
+
+%%If %%''true''%%, will close on exec() call.%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:file:property:close_on_exec:getter_description&nouser&nolink&nodate}}
+
+
//Overridden from [[:develop:api:efl:io:closer:fd:property:close_on_exec|Efl.Io.Closer.close_on_exec]] **(set)**.//===== Signature =====
<code>
@@ -24,28 +46,6 @@ Eina_Bool efl_io_closer_close_on_exec_get(const Eo *obj);
Eina_Bool efl_io_closer_close_on_exec_set(Eo *obj, Eina_Bool close_on_exec);
</code>
-===== Values =====
-
- * **close_on_exec** - %%%%''true''%% if close on exec(), %%''false''%% otherwise%%
-===== Description =====
-
-%%If true will automatically close resources on exec() calls.%%
-
-%%When using file descriptors this should set FD_CLOEXEC so they are not inherited by the processes (children or self) doing exec().%%
-
-//Since 1.19//
-
-
-{{page>:develop:api-include:efl:io:file:property:close_on_exec:description&nouser&nolink&nodate}}
-
-==== Setter ====
-
-%%If %%''true''%%, will close on exec() call.%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:file:property:close_on_exec:getter_description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* [[:develop:api:efl:io:closer:property:close_on_exec|Efl.Io.Closer.close_on_exec]]
diff --git a/pages/develop/api/efl/io/file/property/fd_file.txt b/pages/develop/api/efl/io/file/property/fd_file.txt
index 3c4819165..ad9147e78 100644
--- a/pages/develop/api/efl/io/file/property/fd_file.txt
+++ b/pages/develop/api/efl/io/file/property/fd_file.txt
@@ -1,4 +1,20 @@
~~Title: Efl.Io.File.fd_file~~
+===== Values =====
+
+ * **fd** - %%The file descriptor.%%
+===== Description =====
+
+%%Defines which file descriptor to watch when watching a file.%%
+
+
+{{page>:develop:api-include:efl:io:file:property:fd_file:description&nouser&nolink&nodate}}
+
+==== Setter ====
+
+%%Defines the fd to watch on.%%
+{{page>:develop:api-include:efl:io:file:property:fd_file:getter_description&nouser&nolink&nodate}}
+
+
//Overridden from [[:develop:api:efl:loop:fd:property:fd_file|Efl.Loop.Fd.fd_file]] **(set)**.//===== Signature =====
<code>
@@ -23,22 +39,6 @@ int efl_loop_fd_file_get(const Eo *obj);
void efl_loop_fd_file_set(Eo *obj, int fd);
</code>
-===== Values =====
-
- * **fd** - %%The file descriptor.%%
-===== Description =====
-
-%%Defines which file descriptor to watch when watching a file.%%
-
-
-{{page>:develop:api-include:efl:io:file:property:fd_file:description&nouser&nolink&nodate}}
-
-==== Setter ====
-
-%%Defines the fd to watch on.%%
-{{page>:develop:api-include:efl:io:file:property:fd_file:getter_description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* [[:develop:api:efl:loop:fd:property:fd_file|Efl.Loop.Fd.fd_file]]
diff --git a/pages/develop/api/efl/io/file/property/file.txt b/pages/develop/api/efl/io/file/property/file.txt
index 4596cefb6..17f8320e2 100644
--- a/pages/develop/api/efl/io/file/property/file.txt
+++ b/pages/develop/api/efl/io/file/property/file.txt
@@ -1,31 +1,4 @@
~~Title: Efl.Io.File.file~~
-//Overridden from [[:develop:api:efl:file:property:file|Efl.File.file]] **(get, set)**.//===== Signature =====
-
-<code>
-@property file {
- get {
- values {
- file: free(string, free);
- key: free(string, free);
- }
- }
- set {
- values {
- file: free(string, free);
- key: free(string, free);
- }
- return: bool;
- }
-}
-</code>
-
-===== C signature =====
-
-<code c>
-void efl_file_get(const Eo *obj, const char **file, const char **key);
-Eina_Bool efl_file_set(Eo *obj, const char *file, const char *key);
-</code>
-
===== Values =====
* **file** - %%The image file path.%%
@@ -58,6 +31,33 @@ Eina_Bool efl_file_set(Eo *obj, const char *file, const char *key);
{{page>:develop:api-include:efl:io:file:property:file:getter_description&nouser&nolink&nodate}}
+//Overridden from [[:develop:api:efl:file:property:file|Efl.File.file]] **(get, set)**.//===== Signature =====
+
+<code>
+@property file {
+ get {
+ values {
+ file: free(string, free);
+ key: free(string, free);
+ }
+ }
+ set {
+ values {
+ file: free(string, free);
+ key: free(string, free);
+ }
+ return: bool;
+ }
+}
+</code>
+
+===== C signature =====
+
+<code c>
+void efl_file_get(const Eo *obj, const char **file, const char **key);
+Eina_Bool efl_file_set(Eo *obj, const char *file, const char *key);
+</code>
+
===== Implemented by =====
* [[:develop:api:efl:file:property:file|Efl.File.file]]
diff --git a/pages/develop/api/efl/io/file/property/flags.txt b/pages/develop/api/efl/io/file/property/flags.txt
index 53b8a0596..69a4a185e 100644
--- a/pages/develop/api/efl/io/file/property/flags.txt
+++ b/pages/develop/api/efl/io/file/property/flags.txt
@@ -1,28 +1,4 @@
~~Title: Efl.Io.File.flags~~
-===== Signature =====
-
-<code>
-@property flags {
- get {
- values {
- flags: uint32;
- }
- }
- set {
- values {
- flags: uint32;
- }
- }
-}
-</code>
-
-===== C signature =====
-
-<code c>
-uint32_t efl_io_file_flags_get(const Eo *obj);
-void efl_io_file_flags_set(Eo *obj, uint32_t flags);
-</code>
-
===== Values =====
* **flags** - %%Flags to open file, see man:open(2).%%
@@ -47,6 +23,30 @@ void efl_io_file_flags_set(Eo *obj, uint32_t flags);
{{page>:develop:api-include:efl:io:file:property:flags:getter_description&nouser&nolink&nodate}}
+===== Signature =====
+
+<code>
+@property flags {
+ get {
+ values {
+ flags: uint32;
+ }
+ }
+ set {
+ values {
+ flags: uint32;
+ }
+ }
+}
+</code>
+
+===== C signature =====
+
+<code c>
+uint32_t efl_io_file_flags_get(const Eo *obj);
+void efl_io_file_flags_set(Eo *obj, uint32_t flags);
+</code>
+
===== Implemented by =====
* **Efl.Io.File.flags**
diff --git a/pages/develop/api/efl/io/file/property/mode.txt b/pages/develop/api/efl/io/file/property/mode.txt
index 5abadaf0a..cb1fb7794 100644
--- a/pages/develop/api/efl/io/file/property/mode.txt
+++ b/pages/develop/api/efl/io/file/property/mode.txt
@@ -1,4 +1,24 @@
~~Title: Efl.Io.File.mode~~
+===== Values =====
+
+ * **mode** - %%Mode to open file, see man:open(2).%%
+===== Description =====
+
+%%Mode property%%
+
+//Since 1.19//
+
+
+{{page>:develop:api-include:efl:io:file:property:mode:description&nouser&nolink&nodate}}
+
+==== Setter ====
+
+%%Constructor property to define mode to open the file%%
+
+//Since 1.19//
+{{page>:develop:api-include:efl:io:file:property:mode:getter_description&nouser&nolink&nodate}}
+
+
===== Signature =====
<code>
@@ -23,26 +43,6 @@ uint32_t efl_io_file_mode_get(const Eo *obj);
void efl_io_file_mode_set(Eo *obj, uint32_t mode);
</code>
-===== Values =====
-
- * **mode** - %%Mode to open file, see man:open(2).%%
-===== Description =====
-
-%%Mode property%%
-
-//Since 1.19//
-
-
-{{page>:develop:api-include:efl:io:file:property:mode:description&nouser&nolink&nodate}}
-
-==== Setter ====
-
-%%Constructor property to define mode to open the file%%
-
-//Since 1.19//
-{{page>:develop:api-include:efl:io:file:property:mode:getter_description&nouser&nolink&nodate}}
-
-
===== Implemented by =====
* **Efl.Io.File.mode**