summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDave Andreoli <dave@gurumeditation.it>2016-01-03 16:48:13 +0100
committerDave Andreoli <dave@gurumeditation.it>2016-01-03 16:48:45 +0100
commit93d2c010025795923feff53317775910876bfd1d (patch)
tree4821d57fa9f31761a07a7bc8cbeb63cb0dc5dad9 /doc
parente963e6d061103d9aaff9ef0187184417638cfbf6 (diff)
Implemented efl.Ethumb.Ethumb class.
With docs and an example EthumbClient will follow asap
Diffstat (limited to 'doc')
-rw-r--r--doc/ethumb/class-ethumb.rst6
-rw-r--r--doc/ethumb/ethumb.rst50
-rw-r--r--doc/ethumb/ethumb_client.rst7
-rw-r--r--doc/ethumb/ethumb_module.rst5
-rw-r--r--doc/ethumb/module-ethumb.rst11
-rw-r--r--doc/ethumb/pyethumb.rst9
-rw-r--r--doc/index.rst1
7 files changed, 56 insertions, 33 deletions
diff --git a/doc/ethumb/class-ethumb.rst b/doc/ethumb/class-ethumb.rst
new file mode 100644
index 0000000..70b69b1
--- /dev/null
+++ b/doc/ethumb/class-ethumb.rst
@@ -0,0 +1,6 @@
1.. currentmodule:: efl.ethumb
2
3:class:`efl.ethumb.Ethumb` Class
4================================
5
6.. autoclass:: efl.ethumb.Ethumb
diff --git a/doc/ethumb/ethumb.rst b/doc/ethumb/ethumb.rst
index 88a5524..9f33fe0 100644
--- a/doc/ethumb/ethumb.rst
+++ b/doc/ethumb/ethumb.rst
@@ -1,28 +1,54 @@
1 1
2.. _ethumb_main_intro:
3
4
2What is Ethumb? 5What is Ethumb?
3---------------- 6===============
7
8Ethumb will use Evas to generate thumbnail images of given files. The API
9allows great customization of the generated files and also helps compling to
10FreeDesktop.Org Thumbnail Specification.
11
12(http://specifications.freedesktop.org/thumbnail-spec/thumbnail-spec-latest.html)
13
14However, thumbnailing can be an expensive process that will impact your
15application experience, blocking animations and user interaction during the
16generation. Another problem is that one should try to cache the thumbnails in
17a place that other applications can benefit from the file.
18
19:class:`~efl.ethumb_client.EthumbClient` exists to solve this. It will
20communicate with a server using standard D-Bus protocol. The server will use
21:class:`~efl.ethumb.Ethumb` itself to generate the thumbnail images and cache
22them using FreeDesktop.Org standard. It is recommended that most applications
23use :class:`~efl.ethumb_client.EthumbClient` instead of
24:class:`~efl.ethumb.Ethumb` directly.
25
26Another difference is that one :class:`~efl.ethumb.Ethumb` instance
27can only generate a single thumbnail at a given time, so you must implement
28some sort of queue mechanism if you need more than one. Instead
29:class:`~efl.ethumb_client.EthumbClient` is a able to receive more than one
30request at the same time.
31
32Recommended reading:
4 33
34 :class:`~efl.ethumb.Ethumb` to generate thumbnails in the local process.
5 35
6How to use the Ethumb object 36 :class:`~efl.ethumb_client.EthumbClient` to generate thumbnails using a
7----------------------------- 37 server (recommended).
8 38
9 39
10API Reference 40API Reference
11------------- 41=============
12 42
13.. toctree:: 43.. toctree::
14 :maxdepth: 4 44 :titlesonly:
15 45
16 ethumb_module 46 module-ethumb.rst
17 pyethumb
18 ethumb_client
19 47
20 48
21Inheritance diagram 49Inheritance diagram
22------------------- 50===================
23 51
24.. inheritance-diagram:: 52.. inheritance-diagram:: efl.ethumb
25 efl.ethumb
26 efl.ethumb_client
27 :parts: 2 53 :parts: 2
28 54
diff --git a/doc/ethumb/ethumb_client.rst b/doc/ethumb/ethumb_client.rst
deleted file mode 100644
index ebe7b15..0000000
--- a/doc/ethumb/ethumb_client.rst
+++ /dev/null
@@ -1,7 +0,0 @@
1.. currentmodule:: efl.ethumb
2
3
4:class:`efl.ethumb_client.Client` Class
5========================================
6
7.. autoclass:: efl.ethumb_client.Client
diff --git a/doc/ethumb/ethumb_module.rst b/doc/ethumb/ethumb_module.rst
deleted file mode 100644
index a7189f9..0000000
--- a/doc/ethumb/ethumb_module.rst
+++ /dev/null
@@ -1,5 +0,0 @@
1:mod:`efl.ethumb` Module
2========================
3
4.. automodule:: efl.ethumb
5 :exclude-members: PyEthumb
diff --git a/doc/ethumb/module-ethumb.rst b/doc/ethumb/module-ethumb.rst
new file mode 100644
index 0000000..2891d11
--- /dev/null
+++ b/doc/ethumb/module-ethumb.rst
@@ -0,0 +1,11 @@
1diff --git doc/ethumb/ethumb_module.rst doc/ethumb/ethumb_module.rst
2deleted file mode 100644
3index a7189f9..0000000
4--- doc/ethumb/ethumb_module.rst
5+++ /dev/null
6@@ -1,5 +0,0 @@
7-:mod:`efl.ethumb` Module
8-========================
9-
10-.. automodule:: efl.ethumb
11- :exclude-members: PyEthumb
diff --git a/doc/ethumb/pyethumb.rst b/doc/ethumb/pyethumb.rst
deleted file mode 100644
index 70e2bda..0000000
--- a/doc/ethumb/pyethumb.rst
+++ /dev/null
@@ -1,9 +0,0 @@
1.. currentmodule:: efl.ethumb
2
3:class:`efl.ethumb.PyEthumb` Class
4==================================
5
6.. autoclass:: efl.ethumb.PyEthumb
7
8.. currentmodule:: efl.ethumb
9
diff --git a/doc/index.rst b/doc/index.rst
index ad626cb..206894f 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -62,6 +62,7 @@ Ethumb
62====== 62======
63 63
64.. toctree:: ethumb/ethumb.rst 64.. toctree:: ethumb/ethumb.rst
65 :titlesonly:
65 66
66 67
67Edje 68Edje