enable "make doc", improve doxygen support for client library.
Some methods are missing and the in-process thumbnail needs to be done, the documentation is almost the same as the client, so I really appreciate someone else do it :-) SVN revision: 42541
This commit is contained in:
Gustavo Sverzut Barbieri
parent
5dc1e3900f
commit
4be6ac7921
|
|
@ -1,16 +1,19 @@
|
|||
Installation Instructions
|
||||
*************************
|
||||
|
||||
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
|
||||
Software Foundation, Inc.
|
||||
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
|
||||
2006, 2007, 2008 Free Software Foundation, Inc.
|
||||
|
||||
This file is free documentation; the Free Software Foundation gives
|
||||
This file is free documentation; the Free Software Foundation gives
|
||||
unlimited permission to copy, distribute and modify it.
|
||||
|
||||
Basic Installation
|
||||
==================
|
||||
|
||||
These are generic installation instructions.
|
||||
Briefly, the shell commands `./configure; make; make install' should
|
||||
configure, build, and install this package. The following
|
||||
more-detailed instructions are generic; see the `README' file for
|
||||
instructions specific to this package.
|
||||
|
||||
The `configure' shell script attempts to guess correct values for
|
||||
various system-dependent variables used during compilation. It uses
|
||||
|
|
@ -23,9 +26,9 @@ debugging `configure').
|
|||
|
||||
It can also use an optional file (typically called `config.cache'
|
||||
and enabled with `--cache-file=config.cache' or simply `-C') that saves
|
||||
the results of its tests to speed up reconfiguring. (Caching is
|
||||
the results of its tests to speed up reconfiguring. Caching is
|
||||
disabled by default to prevent problems with accidental use of stale
|
||||
cache files.)
|
||||
cache files.
|
||||
|
||||
If you need to do unusual things to compile the package, please try
|
||||
to figure out how `configure' could check whether to do them, and mail
|
||||
|
|
@ -35,20 +38,17 @@ some point `config.cache' contains results you don't want to keep, you
|
|||
may remove or edit it.
|
||||
|
||||
The file `configure.ac' (or `configure.in') is used to create
|
||||
`configure' by a program called `autoconf'. You only need
|
||||
`configure.ac' if you want to change it or regenerate `configure' using
|
||||
a newer version of `autoconf'.
|
||||
`configure' by a program called `autoconf'. You need `configure.ac' if
|
||||
you want to change it or regenerate `configure' using a newer version
|
||||
of `autoconf'.
|
||||
|
||||
The simplest way to compile this package is:
|
||||
|
||||
1. `cd' to the directory containing the package's source code and type
|
||||
`./configure' to configure the package for your system. If you're
|
||||
using `csh' on an old version of System V, you might need to type
|
||||
`sh ./configure' instead to prevent `csh' from trying to execute
|
||||
`configure' itself.
|
||||
`./configure' to configure the package for your system.
|
||||
|
||||
Running `configure' takes awhile. While running, it prints some
|
||||
messages telling which features it is checking for.
|
||||
Running `configure' might take a while. While running, it prints
|
||||
some messages telling which features it is checking for.
|
||||
|
||||
2. Type `make' to compile the package.
|
||||
|
||||
|
|
@ -67,42 +67,57 @@ The simplest way to compile this package is:
|
|||
all sorts of other programs in order to regenerate files that came
|
||||
with the distribution.
|
||||
|
||||
6. Often, you can also type `make uninstall' to remove the installed
|
||||
files again.
|
||||
|
||||
Compilers and Options
|
||||
=====================
|
||||
|
||||
Some systems require unusual options for compilation or linking that the
|
||||
`configure' script does not know about. Run `./configure --help' for
|
||||
details on some of the pertinent environment variables.
|
||||
Some systems require unusual options for compilation or linking that
|
||||
the `configure' script does not know about. Run `./configure --help'
|
||||
for details on some of the pertinent environment variables.
|
||||
|
||||
You can give `configure' initial values for configuration parameters
|
||||
by setting variables in the command line or in the environment. Here
|
||||
is an example:
|
||||
|
||||
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
|
||||
./configure CC=c99 CFLAGS=-g LIBS=-lposix
|
||||
|
||||
*Note Defining Variables::, for more details.
|
||||
|
||||
Compiling For Multiple Architectures
|
||||
====================================
|
||||
|
||||
You can compile the package for more than one kind of computer at the
|
||||
You can compile the package for more than one kind of computer at the
|
||||
same time, by placing the object files for each architecture in their
|
||||
own directory. To do this, you must use a version of `make' that
|
||||
supports the `VPATH' variable, such as GNU `make'. `cd' to the
|
||||
own directory. To do this, you can use GNU `make'. `cd' to the
|
||||
directory where you want the object files and executables to go and run
|
||||
the `configure' script. `configure' automatically checks for the
|
||||
source code in the directory that `configure' is in and in `..'.
|
||||
|
||||
If you have to use a `make' that does not support the `VPATH'
|
||||
variable, you have to compile the package for one architecture at a
|
||||
time in the source code directory. After you have installed the
|
||||
package for one architecture, use `make distclean' before reconfiguring
|
||||
for another architecture.
|
||||
With a non-GNU `make', it is safer to compile the package for one
|
||||
architecture at a time in the source code directory. After you have
|
||||
installed the package for one architecture, use `make distclean' before
|
||||
reconfiguring for another architecture.
|
||||
|
||||
On MacOS X 10.5 and later systems, you can create libraries and
|
||||
executables that work on multiple system types--known as "fat" or
|
||||
"universal" binaries--by specifying multiple `-arch' options to the
|
||||
compiler but only a single `-arch' option to the preprocessor. Like
|
||||
this:
|
||||
|
||||
./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
|
||||
CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
|
||||
CPP="gcc -E" CXXCPP="g++ -E"
|
||||
|
||||
This is not guaranteed to produce working output in all cases, you
|
||||
may have to build one architecture at a time and combine the results
|
||||
using the `lipo' tool if you have problems.
|
||||
|
||||
Installation Names
|
||||
==================
|
||||
|
||||
By default, `make install' installs the package's commands under
|
||||
By default, `make install' installs the package's commands under
|
||||
`/usr/local/bin', include files under `/usr/local/include', etc. You
|
||||
can specify an installation prefix other than `/usr/local' by giving
|
||||
`configure' the option `--prefix=PREFIX'.
|
||||
|
|
@ -125,7 +140,7 @@ option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
|
|||
Optional Features
|
||||
=================
|
||||
|
||||
Some packages pay attention to `--enable-FEATURE' options to
|
||||
Some packages pay attention to `--enable-FEATURE' options to
|
||||
`configure', where FEATURE indicates an optional part of the package.
|
||||
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
|
||||
is something like `gnu-as' or `x' (for the X Window System). The
|
||||
|
|
@ -137,14 +152,36 @@ find the X include and library files automatically, but if it doesn't,
|
|||
you can use the `configure' options `--x-includes=DIR' and
|
||||
`--x-libraries=DIR' to specify their locations.
|
||||
|
||||
Particular systems
|
||||
==================
|
||||
|
||||
On HP-UX, the default C compiler is not ANSI C compatible. If GNU
|
||||
CC is not installed, it is recommended to use the following options in
|
||||
order to use an ANSI C compiler:
|
||||
|
||||
./configure CC="cc -Ae"
|
||||
|
||||
and if that doesn't work, install pre-built binaries of GCC for HP-UX.
|
||||
|
||||
On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
|
||||
parse its `<wchar.h>' header file. The option `-nodtk' can be used as
|
||||
a workaround. If GNU CC is not installed, it is therefore recommended
|
||||
to try
|
||||
|
||||
./configure CC="cc"
|
||||
|
||||
and if that doesn't work, try
|
||||
|
||||
./configure CC="cc -nodtk"
|
||||
|
||||
Specifying the System Type
|
||||
==========================
|
||||
|
||||
There may be some features `configure' cannot figure out automatically,
|
||||
but needs to determine by the type of machine the package will run on.
|
||||
Usually, assuming the package is built to be run on the _same_
|
||||
architectures, `configure' can figure that out, but if it prints a
|
||||
message saying it cannot guess the machine type, give it the
|
||||
There may be some features `configure' cannot figure out
|
||||
automatically, but needs to determine by the type of machine the package
|
||||
will run on. Usually, assuming the package is built to be run on the
|
||||
_same_ architectures, `configure' can figure that out, but if it prints
|
||||
a message saying it cannot guess the machine type, give it the
|
||||
`--build=TYPE' option. TYPE can either be a short name for the system
|
||||
type, such as `sun4', or a canonical name which has the form:
|
||||
|
||||
|
|
@ -170,9 +207,9 @@ eventually be run) with `--host=TYPE'.
|
|||
Sharing Defaults
|
||||
================
|
||||
|
||||
If you want to set default values for `configure' scripts to share, you
|
||||
can create a site shell script called `config.site' that gives default
|
||||
values for variables like `CC', `cache_file', and `prefix'.
|
||||
If you want to set default values for `configure' scripts to share,
|
||||
you can create a site shell script called `config.site' that gives
|
||||
default values for variables like `CC', `cache_file', and `prefix'.
|
||||
`configure' looks for `PREFIX/share/config.site' if it exists, then
|
||||
`PREFIX/etc/config.site' if it exists. Or, you can set the
|
||||
`CONFIG_SITE' environment variable to the location of the site script.
|
||||
|
|
@ -181,7 +218,7 @@ A warning: not all `configure' scripts look for a site script.
|
|||
Defining Variables
|
||||
==================
|
||||
|
||||
Variables not defined in a site shell script can be set in the
|
||||
Variables not defined in a site shell script can be set in the
|
||||
environment passed to `configure'. However, some packages may run
|
||||
configure again during the build, and the customized values of these
|
||||
variables may be lost. In order to avoid this problem, you should set
|
||||
|
|
@ -190,21 +227,29 @@ them in the `configure' command line, using `VAR=value'. For example:
|
|||
./configure CC=/usr/local2/bin/gcc
|
||||
|
||||
causes the specified `gcc' to be used as the C compiler (unless it is
|
||||
overridden in the site shell script). Here is a another example:
|
||||
overridden in the site shell script).
|
||||
|
||||
/bin/bash ./configure CONFIG_SHELL=/bin/bash
|
||||
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
|
||||
an Autoconf bug. Until the bug is fixed you can use this workaround:
|
||||
|
||||
Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
|
||||
configuration-related scripts to be executed by `/bin/bash'.
|
||||
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
|
||||
|
||||
`configure' Invocation
|
||||
======================
|
||||
|
||||
`configure' recognizes the following options to control how it operates.
|
||||
`configure' recognizes the following options to control how it
|
||||
operates.
|
||||
|
||||
`--help'
|
||||
`-h'
|
||||
Print a summary of the options to `configure', and exit.
|
||||
Print a summary of all of the options to `configure', and exit.
|
||||
|
||||
`--help=short'
|
||||
`--help=recursive'
|
||||
Print a summary of the options unique to this package's
|
||||
`configure', and exit. The `short' variant lists options used
|
||||
only in the top level, while the `recursive' variant lists options
|
||||
also present in any nested packages.
|
||||
|
||||
`--version'
|
||||
`-V'
|
||||
|
|
@ -231,6 +276,16 @@ configuration-related scripts to be executed by `/bin/bash'.
|
|||
Look for the package's source code in directory DIR. Usually
|
||||
`configure' can determine that directory automatically.
|
||||
|
||||
`--prefix=DIR'
|
||||
Use DIR as the installation prefix. *Note Installation Names::
|
||||
for more details, including other options available for fine-tuning
|
||||
the installation locations.
|
||||
|
||||
`--no-create'
|
||||
`-n'
|
||||
Run the configure checks, but stop before creating any output
|
||||
files.
|
||||
|
||||
`configure' also accepts some other, not widely useful, options. Run
|
||||
`configure --help' for more details.
|
||||
|
||||
|
|
|
|||
|
|
@ -29,6 +29,12 @@ service_DATA = org.enlightenment.Ethumb.service
|
|||
|
||||
endif
|
||||
|
||||
SUBDIRS = m4 src data
|
||||
SUBDIRS = m4 src data doc
|
||||
|
||||
ACLOCAL_AMFLAGS = -I m4
|
||||
|
||||
.PHONY: doc
|
||||
|
||||
doc:
|
||||
@echo "entering doc/"
|
||||
$(MAKE) -C doc doc
|
||||
|
|
|
|||
|
|
@ -1,13 +1,6 @@
|
|||
#!/bin/sh
|
||||
|
||||
rm -rf autom4te.cache
|
||||
rm -f aclocal.m4 ltmain.sh
|
||||
|
||||
echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS -I m4 || exit 1
|
||||
echo "Running autoheader..." ; autoheader || exit 1
|
||||
echo "Running autoconf..." ; autoconf || exit 1
|
||||
echo "Running libtoolize..." ; (libtoolize --copy --automake || glibtoolize --automake) || exit 1
|
||||
echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
|
||||
autoreconf -f -i
|
||||
|
||||
if [ -z "$NOCONFIGURE" ]; then
|
||||
./configure "$@"
|
||||
|
|
|
|||
|
|
@ -40,6 +40,8 @@ AC_SUBST(pluginsdir)
|
|||
AS_AC_EXPAND(PLUGINSDIR, $pluginsdir)
|
||||
AC_DEFINE_UNQUOTED(PLUGINSDIR, ["$PLUGINSDIR"], [Where plugins are installed.])
|
||||
|
||||
EFL_CHECK_DOXYGEN([build_doc="yes"], [build_doc="no"])
|
||||
|
||||
PKG_CHECK_MODULES(EINA, [eina-0])
|
||||
PKG_CHECK_MODULES(EVAS, [evas])
|
||||
PKG_CHECK_MODULES(ECORE, [ecore])
|
||||
|
|
@ -110,4 +112,5 @@ src/tests/Makefile
|
|||
data/Makefile
|
||||
data/frames/Makefile
|
||||
m4/Makefile
|
||||
doc/Makefile
|
||||
])
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,23 @@
|
|||
|
||||
MAINTAINERCLEANFILES = Makefile.in
|
||||
|
||||
.PHONY: doc
|
||||
|
||||
if EFL_BUILD_DOC
|
||||
|
||||
doc: all
|
||||
rm -rf html/ latex/ man/
|
||||
$(efl_doxygen)
|
||||
cp img/* html/
|
||||
|
||||
else
|
||||
|
||||
doc:
|
||||
@echo "Documentation not built. Run ./configure --help"
|
||||
|
||||
endif
|
||||
|
||||
clean-local:
|
||||
@rm -rf html/ latex/ man/
|
||||
|
||||
EXTRA_DIST = Doxyfile $(wildcard img/*.*) e.css head.html foot.html
|
||||
|
|
@ -0,0 +1,218 @@
|
|||
/*
|
||||
Author:
|
||||
Andres Blanc <andresblanc@gmail.com>
|
||||
DaveMDS Andreoli <dave@gurumeditation.it>
|
||||
|
||||
Supported Browsers:
|
||||
ie7, opera9, konqueror4 and firefox3
|
||||
|
||||
Please use a different file for ie6, ie5, etc. hacks.
|
||||
*/
|
||||
|
||||
|
||||
/* Necessary to place the footer at the bottom of the page */
|
||||
html, body {
|
||||
height: 100%;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
#container {
|
||||
min-height: 100%;
|
||||
height: auto !important;
|
||||
height: 100%;
|
||||
margin: 0 auto -53px;
|
||||
}
|
||||
|
||||
#footer, #push {
|
||||
height: 53px;
|
||||
}
|
||||
|
||||
|
||||
* html #container {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
/* Prevent floating elements overflowing containers */
|
||||
.clear {
|
||||
clear: both;
|
||||
width: 0px;
|
||||
height: 0px;
|
||||
}
|
||||
|
||||
/* Flexible & centered layout from 750 to 960 pixels */
|
||||
.layout {
|
||||
max-width: 960px;
|
||||
min-width: 760px;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
body {
|
||||
/*font-family: Lucida Grande, Helvetica, sans-serif;*/
|
||||
font-family: "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif
|
||||
}
|
||||
|
||||
/* Prevent design overflowing the viewport in small resolutions */
|
||||
#container {
|
||||
padding-right: 17px;
|
||||
padding-left: 17px;
|
||||
background-image: url(head_bg.png);
|
||||
background-repeat: repeat-x;
|
||||
}
|
||||
|
||||
#header {
|
||||
width: 100%;
|
||||
height: 102px;
|
||||
}
|
||||
|
||||
#header h1 {
|
||||
width: 63px;
|
||||
height: 63px;
|
||||
background-image: url(e.png);
|
||||
background-repeat: no-repeat;
|
||||
position: absolute;
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
#header h1 span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#header h2 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* .menu-container is used to set properties common to .menu and .submenu */
|
||||
#header .menu-container {
|
||||
}
|
||||
|
||||
#header .menu-container ul {
|
||||
list-style-type: none;
|
||||
list-style-position: inside;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
#header .menu-container li {
|
||||
display: block;
|
||||
float: right;
|
||||
}
|
||||
|
||||
#header .menu {
|
||||
height: 63px;
|
||||
display: block;
|
||||
background-image: url(menu_bg.png);
|
||||
background-repeat: repeat-x;
|
||||
}
|
||||
|
||||
#header .menu ul {
|
||||
height: 100%;
|
||||
display: block;
|
||||
background-image: url(menu_bg_last.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: top right;
|
||||
padding-right: 17px;
|
||||
}
|
||||
|
||||
#header .menu li {
|
||||
height: 100%;
|
||||
text-align: center;
|
||||
background-image: url(menu_bg_unsel.png);
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
#header .menu a {
|
||||
height: 100%;
|
||||
display: block;
|
||||
color: #cdcdcd;
|
||||
text-decoration: none;
|
||||
font-size: 10pt;
|
||||
line-height: 59px;
|
||||
text-align: center;
|
||||
padding: 0px 15px 0px 15px;
|
||||
}
|
||||
|
||||
#header .menu li:hover {
|
||||
background-image: url(menu_bg_hover.png);
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
#header .menu li:hover a {
|
||||
color: #FFFFFF;
|
||||
}
|
||||
|
||||
#header .menu li.current {
|
||||
background-image: url(menu_bg_current.png);
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
#header .menu li.current a {
|
||||
color: #646464;
|
||||
}
|
||||
|
||||
|
||||
/* Hide all the submenus but the current */
|
||||
#header .submenu ul {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#header .submenu .current {
|
||||
display: block;
|
||||
}
|
||||
|
||||
#header .submenu {
|
||||
font: bold 10px verdana,'Bitstream Vera Sans',helvetica,arial,sans-serif;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
#header .submenu a {
|
||||
color: #888888;
|
||||
text-decoration: none;
|
||||
font-size: 0.9em;
|
||||
line-height: 15px;
|
||||
padding:0px 5px 0px 5px;
|
||||
}
|
||||
|
||||
#header .submenu a:hover {
|
||||
color: #444444;
|
||||
}
|
||||
|
||||
#header .submenu li {
|
||||
border-left: 1px solid #DDDDDD;
|
||||
}
|
||||
|
||||
#header .submenu li:last-child {
|
||||
border-left: 0;
|
||||
}
|
||||
|
||||
#header .doxytitle {
|
||||
position: absolute;
|
||||
font-size: 1.8em;
|
||||
font-weight: bold;
|
||||
color: #444444;
|
||||
line-height: 35px;
|
||||
}
|
||||
|
||||
#header small {
|
||||
font-size: 0.4em;
|
||||
}
|
||||
|
||||
#footer {
|
||||
background-image: url(foot_bg.png);
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
#footer table {
|
||||
width: 100%;
|
||||
text-align: center;
|
||||
white-space: nowrap;
|
||||
padding: 5px 30px 5px 30px;
|
||||
font-size: 0.8em;
|
||||
font-family: "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif;
|
||||
color: #888888;
|
||||
}
|
||||
|
||||
#footer td.copyright {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
|
||||
<div id="push"></div>
|
||||
</div> <!-- #content -->
|
||||
</div> <!-- .layout -->
|
||||
|
||||
</div> <!-- #container -->
|
||||
|
||||
|
||||
<div id="footer">
|
||||
<table><tr>
|
||||
<td class="poweredby"><img src="doxygen.png"></td>
|
||||
<td class="copyright">Copyright ©$year Enlightenment</td>
|
||||
<td class="generated">Docs generated $datetime</td>
|
||||
</tr></table>
|
||||
</div>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>$title</title>
|
||||
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
|
||||
<meta name="author" content="Andres Blanc" >
|
||||
|
||||
<link rel="icon" href="img/favicon.png" type="image/x-icon">
|
||||
<link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
|
||||
<link rel="icon" href="img/favicon.png" type="image/ico">
|
||||
<link rel="shortcut icon" href="img/favicon.png" type="image/ico">
|
||||
|
||||
<link rel="stylesheet" type="text/css" media="screen" href="e.css">
|
||||
<link rel="stylesheet" type="text/css" media="screen" href="edoxy.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="header">
|
||||
<div class="layout">
|
||||
|
||||
<h1><span>Enlightenment</span></h1>
|
||||
<h2><span>Beauty at your fingertips</span></h2>
|
||||
|
||||
<div class="menu-container">
|
||||
<div class="menu">
|
||||
<ul>
|
||||
<li class="current"><a href="http://web.enlightenment.org/p.php?p=docs">Docs</a></li>
|
||||
<li><a href="http://trac.enlightenment.org/e">Tracker</a></li>
|
||||
<li><a href="http://www.enlightenment.org/p.php?p=contact">Contact</a></li>
|
||||
<li><a href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></li>
|
||||
<li><a href="http://www.enlightenment.org/p.php?p=support">Support</a></li>
|
||||
<li><a href="http://www.enlightenment.org/p.php?p=download">Download</a></li>
|
||||
<li><a href="http://www.enlightenment.org/p.php?p=about">About</a></li>
|
||||
<li><a href="http://www.enlightenment.org/p.php?p=news">News</a></li>
|
||||
<li><a href="http://www.enlightenment.org/">Home</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="doxytitle">
|
||||
$projectname Documentation <small>at $date</small>
|
||||
</div>
|
||||
|
||||
<div class="menu-container">
|
||||
<div class="submenu">
|
||||
<ul class="current">
|
||||
<li><a href="pages.html">Tutorials</a></li>
|
||||
<!-- <li><a href="globals.html">Globals</a></li>-->
|
||||
<!-- <li><a href="files.html">Files</a></li>-->
|
||||
<li><a href="modules.html">Modules</a></li>
|
||||
<li class="current"><a href="index.html">Main Page</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="clear"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
<div class="layout">
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 3.7 KiB |
|
|
@ -0,0 +1,483 @@
|
|||
/*
|
||||
* This file contain a custom doxygen style to match e.org graphics
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/* BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
|
||||
font-family: Geneva, Arial, Helvetica, sans-serif;
|
||||
}*/
|
||||
BODY, TD {
|
||||
font-size: 12px;
|
||||
}
|
||||
H1 {
|
||||
text-align: center;
|
||||
font-size: 160%;
|
||||
}
|
||||
H2 {
|
||||
font-size: 120%;
|
||||
}
|
||||
H3 {
|
||||
font-size: 100%;
|
||||
}
|
||||
CAPTION {
|
||||
font-weight: bold
|
||||
}
|
||||
DIV.qindex {
|
||||
width: 100%;
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
padding: 2px;
|
||||
line-height: 140%;
|
||||
}
|
||||
DIV.navpath {
|
||||
width: 100%;
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
padding: 2px;
|
||||
line-height: 140%;
|
||||
}
|
||||
DIV.navtab {
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
margin-right: 15px;
|
||||
padding: 2px;
|
||||
}
|
||||
TD.navtab {
|
||||
font-size: 70%;
|
||||
}
|
||||
A.qindex {
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
color: #1A419D;
|
||||
}
|
||||
A.qindex:visited {
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
color: #1A419D
|
||||
}
|
||||
A.qindex:hover {
|
||||
text-decoration: none;
|
||||
background-color: #ddddff;
|
||||
}
|
||||
A.qindexHL {
|
||||
text-decoration: none;
|
||||
font-weight: bold;
|
||||
background-color: #6666cc;
|
||||
color: #ffffff;
|
||||
border: 1px double #9295C2;
|
||||
}
|
||||
A.qindexHL:hover {
|
||||
text-decoration: none;
|
||||
background-color: #6666cc;
|
||||
color: #ffffff;
|
||||
}
|
||||
A.qindexHL:visited {
|
||||
text-decoration: none;
|
||||
background-color: #6666cc;
|
||||
color: #ffffff
|
||||
}
|
||||
A.el {
|
||||
text-decoration: none;
|
||||
font-weight: bold
|
||||
}
|
||||
A.elRef {
|
||||
font-weight: bold
|
||||
}
|
||||
A.code:link {
|
||||
text-decoration: none;
|
||||
font-weight: normal;
|
||||
color: #0000FF
|
||||
}
|
||||
A.code:visited {
|
||||
text-decoration: none;
|
||||
font-weight: normal;
|
||||
color: #0000FF
|
||||
}
|
||||
A.codeRef:link {
|
||||
font-weight: normal;
|
||||
color: #0000FF
|
||||
}
|
||||
A.codeRef:visited {
|
||||
font-weight: normal;
|
||||
color: #0000FF
|
||||
}
|
||||
A:hover, A:visited:hover {
|
||||
text-decoration: none;
|
||||
/* background-color: #f2f2ff; */
|
||||
color: #000055;
|
||||
}
|
||||
A.anchor {
|
||||
color: #000;
|
||||
}
|
||||
DL.el {
|
||||
margin-left: -1cm
|
||||
}
|
||||
.fragment {
|
||||
font-family: monospace, fixed;
|
||||
font-size: 95%;
|
||||
}
|
||||
PRE.fragment {
|
||||
border: 1px solid #CCCCCC;
|
||||
background-color: #f5f5f5;
|
||||
margin-top: 4px;
|
||||
margin-bottom: 4px;
|
||||
margin-left: 2px;
|
||||
margin-right: 8px;
|
||||
padding-left: 6px;
|
||||
padding-right: 6px;
|
||||
padding-top: 4px;
|
||||
padding-bottom: 4px;
|
||||
}
|
||||
DIV.ah {
|
||||
background-color: black;
|
||||
font-weight: bold;
|
||||
color: #ffffff;
|
||||
margin-bottom: 3px;
|
||||
margin-top: 3px
|
||||
}
|
||||
|
||||
DIV.groupHeader {
|
||||
margin-left: 16px;
|
||||
margin-top: 12px;
|
||||
margin-bottom: 6px;
|
||||
font-weight: bold;
|
||||
}
|
||||
DIV.groupText {
|
||||
margin-left: 16px;
|
||||
font-style: italic;
|
||||
font-size: 90%
|
||||
}
|
||||
/*BODY {
|
||||
background: white;
|
||||
color: black;
|
||||
margin-right: 20px;
|
||||
margin-left: 20px;
|
||||
}*/
|
||||
TD.indexkey {
|
||||
background-color: #e8eef2;
|
||||
font-weight: bold;
|
||||
padding-right : 10px;
|
||||
padding-top : 2px;
|
||||
padding-left : 10px;
|
||||
padding-bottom : 2px;
|
||||
margin-left : 0px;
|
||||
margin-right : 0px;
|
||||
margin-top : 2px;
|
||||
margin-bottom : 2px;
|
||||
border: 1px solid #CCCCCC;
|
||||
}
|
||||
TD.indexvalue {
|
||||
background-color: #e8eef2;
|
||||
font-style: italic;
|
||||
padding-right : 10px;
|
||||
padding-top : 2px;
|
||||
padding-left : 10px;
|
||||
padding-bottom : 2px;
|
||||
margin-left : 0px;
|
||||
margin-right : 0px;
|
||||
margin-top : 2px;
|
||||
margin-bottom : 2px;
|
||||
border: 1px solid #CCCCCC;
|
||||
}
|
||||
TR.memlist {
|
||||
background-color: #f0f0f0;
|
||||
}
|
||||
P.formulaDsp {
|
||||
text-align: center;
|
||||
}
|
||||
IMG.formulaDsp {
|
||||
}
|
||||
IMG.formulaInl {
|
||||
vertical-align: middle;
|
||||
}
|
||||
SPAN.keyword { color: #008000 }
|
||||
SPAN.keywordtype { color: #604020 }
|
||||
SPAN.keywordflow { color: #e08000 }
|
||||
SPAN.comment { color: #800000 }
|
||||
SPAN.preprocessor { color: #806020 }
|
||||
SPAN.stringliteral { color: #002080 }
|
||||
SPAN.charliteral { color: #008080 }
|
||||
SPAN.vhdldigit { color: #ff00ff }
|
||||
SPAN.vhdlchar { color: #000000 }
|
||||
SPAN.vhdlkeyword { color: #700070 }
|
||||
SPAN.vhdllogic { color: #ff0000 }
|
||||
|
||||
.mdescLeft {
|
||||
padding: 0px 8px 4px 8px;
|
||||
font-size: 80%;
|
||||
font-style: italic;
|
||||
background-color: #FAFAFA;
|
||||
border-top: 1px none #E0E0E0;
|
||||
border-right: 1px none #E0E0E0;
|
||||
border-bottom: 1px none #E0E0E0;
|
||||
border-left: 1px none #E0E0E0;
|
||||
margin: 0px;
|
||||
}
|
||||
.mdescRight {
|
||||
padding: 0px 8px 4px 8px;
|
||||
font-size: 80%;
|
||||
font-style: italic;
|
||||
background-color: #FAFAFA;
|
||||
border-top: 1px none #E0E0E0;
|
||||
border-right: 1px none #E0E0E0;
|
||||
border-bottom: 1px none #E0E0E0;
|
||||
border-left: 1px none #E0E0E0;
|
||||
margin: 0px;
|
||||
}
|
||||
.memItemLeft {
|
||||
padding: 1px 0px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: solid;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.memItemRight {
|
||||
padding: 1px 8px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: solid;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.memTemplItemLeft {
|
||||
padding: 1px 0px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: none;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.memTemplItemRight {
|
||||
padding: 1px 8px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: none;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.memTemplParams {
|
||||
padding: 1px 0px 0px 8px;
|
||||
margin: 4px;
|
||||
border-top-width: 1px;
|
||||
border-right-width: 1px;
|
||||
border-bottom-width: 1px;
|
||||
border-left-width: 1px;
|
||||
border-top-color: #E0E0E0;
|
||||
border-right-color: #E0E0E0;
|
||||
border-bottom-color: #E0E0E0;
|
||||
border-left-color: #E0E0E0;
|
||||
border-top-style: solid;
|
||||
border-right-style: none;
|
||||
border-bottom-style: none;
|
||||
border-left-style: none;
|
||||
color: #606060;
|
||||
background-color: #FAFAFA;
|
||||
font-size: 80%;
|
||||
}
|
||||
.search {
|
||||
color: #003399;
|
||||
font-weight: bold;
|
||||
}
|
||||
FORM.search {
|
||||
margin-bottom: 0px;
|
||||
margin-top: 0px;
|
||||
}
|
||||
INPUT.search {
|
||||
font-size: 75%;
|
||||
color: #000080;
|
||||
font-weight: normal;
|
||||
background-color: #e8eef2;
|
||||
}
|
||||
TD.tiny {
|
||||
font-size: 75%;
|
||||
}
|
||||
a {
|
||||
color: #1A41A8;
|
||||
}
|
||||
a:visited {
|
||||
color: #2A3798;
|
||||
}
|
||||
.dirtab {
|
||||
padding: 4px;
|
||||
border-collapse: collapse;
|
||||
border: 1px solid #84b0c7;
|
||||
}
|
||||
TH.dirtab {
|
||||
background: #e8eef2;
|
||||
font-weight: bold;
|
||||
}
|
||||
HR {
|
||||
height: 1px;
|
||||
border: none;
|
||||
border-top: 1px solid black;
|
||||
}
|
||||
|
||||
/* Style for detailed member documentation */
|
||||
.memtemplate {
|
||||
font-size: 80%;
|
||||
color: #606060;
|
||||
font-weight: normal;
|
||||
margin-left: 3px;
|
||||
}
|
||||
.memnav {
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
margin-right: 15px;
|
||||
padding: 2px;
|
||||
}
|
||||
.memitem {
|
||||
padding: 4px;
|
||||
background-color: #eef3f5;
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #dedeee;
|
||||
-moz-border-radius: 8px 8px 8px 8px;
|
||||
}
|
||||
.memname {
|
||||
white-space: nowrap;
|
||||
font-weight: bold;
|
||||
}
|
||||
.memdoc{
|
||||
padding-left: 10px;
|
||||
}
|
||||
.memproto {
|
||||
background-color: #d5e1e8;
|
||||
width: 100%;
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #84b0c7;
|
||||
font-weight: bold;
|
||||
-moz-border-radius: 8px 8px 8px 8px;
|
||||
}
|
||||
.paramkey {
|
||||
text-align: right;
|
||||
}
|
||||
.paramtype {
|
||||
white-space: nowrap;
|
||||
}
|
||||
.paramname {
|
||||
color: #602020;
|
||||
font-style: italic;
|
||||
white-space: nowrap;
|
||||
}
|
||||
/* End Styling for detailed member documentation */
|
||||
|
||||
/* for the tree view */
|
||||
.ftvtree {
|
||||
font-family: sans-serif;
|
||||
margin:0.5em;
|
||||
}
|
||||
/* these are for tree view when used as main index */
|
||||
.directory {
|
||||
font-size: 9pt;
|
||||
font-weight: bold;
|
||||
}
|
||||
.directory h3 {
|
||||
margin: 0px;
|
||||
margin-top: 1em;
|
||||
font-size: 11pt;
|
||||
}
|
||||
|
||||
/* The following two styles can be used to replace the root node title */
|
||||
/* with an image of your choice. Simply uncomment the next two styles, */
|
||||
/* specify the name of your image and be sure to set 'height' to the */
|
||||
/* proper pixel height of your image. */
|
||||
|
||||
/* .directory h3.swap { */
|
||||
/* height: 61px; */
|
||||
/* background-repeat: no-repeat; */
|
||||
/* background-image: url("yourimage.gif"); */
|
||||
/* } */
|
||||
/* .directory h3.swap span { */
|
||||
/* display: none; */
|
||||
/* } */
|
||||
|
||||
.directory > h3 {
|
||||
margin-top: 0;
|
||||
}
|
||||
.directory p {
|
||||
margin: 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
.directory div {
|
||||
display: none;
|
||||
margin: 0px;
|
||||
}
|
||||
.directory img {
|
||||
vertical-align: -30%;
|
||||
}
|
||||
/* these are for tree view when not used as main index */
|
||||
.directory-alt {
|
||||
font-size: 100%;
|
||||
font-weight: bold;
|
||||
}
|
||||
.directory-alt h3 {
|
||||
margin: 0px;
|
||||
margin-top: 1em;
|
||||
font-size: 11pt;
|
||||
}
|
||||
.directory-alt > h3 {
|
||||
margin-top: 0;
|
||||
}
|
||||
.directory-alt p {
|
||||
margin: 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
.directory-alt div {
|
||||
display: none;
|
||||
margin: 0px;
|
||||
}
|
||||
.directory-alt img {
|
||||
vertical-align: -30%;
|
||||
}
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 173 B |
Binary file not shown.
|
After Width: | Height: | Size: 214 B |
Binary file not shown.
|
After Width: | Height: | Size: 192 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 637 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
|
|
@ -5,4 +5,5 @@ EXTRA_DIST = iconv.m4 \
|
|||
lib-prefix.m4 \
|
||||
progtest.m4 \
|
||||
as-expand.m4 \
|
||||
ac-modules.m4
|
||||
ac-modules.m4 \
|
||||
efl_doxygen.m4
|
||||
|
|
|
|||
|
|
@ -0,0 +1,97 @@
|
|||
dnl Copyright (C) 2008 Vincent Torri <vtorri at univ-evry dot fr>
|
||||
dnl That code is public domain and can be freely used or copied.
|
||||
|
||||
dnl Macro that check if doxygen is available or not.
|
||||
|
||||
dnl EFL_CHECK_DOXYGEN([ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]])
|
||||
dnl Test for the doxygen program
|
||||
dnl Defines efl_doxygen
|
||||
dnl Defines the automake conditionnal EFL_BUILD_DOC
|
||||
dnl
|
||||
AC_DEFUN([EFL_CHECK_DOXYGEN],
|
||||
[
|
||||
|
||||
dnl
|
||||
dnl Disable the build of the documentation
|
||||
dnl
|
||||
AC_ARG_ENABLE([doc],
|
||||
[AC_HELP_STRING(
|
||||
[--disable-doc],
|
||||
[Disable documentation build @<:@default=enabled@:>@])],
|
||||
[
|
||||
if test "x${enableval}" = "xyes" ; then
|
||||
efl_enable_doc="yes"
|
||||
else
|
||||
efl_enable_doc="no"
|
||||
fi
|
||||
],
|
||||
[efl_enable_doc="yes"])
|
||||
|
||||
AC_MSG_CHECKING([whether to build documentation])
|
||||
AC_MSG_RESULT([${efl_enable_doc}])
|
||||
|
||||
if test "x${efl_enable_doc}" = "xyes" ; then
|
||||
|
||||
dnl Specify the file name, without path
|
||||
|
||||
efl_doxygen="doxygen"
|
||||
|
||||
AC_ARG_WITH([doxygen],
|
||||
[AC_HELP_STRING(
|
||||
[--with-doxygen=FILE],
|
||||
[doxygen program to use @<:@default=doxygen@:>@])],
|
||||
|
||||
dnl Check the given doxygen program.
|
||||
|
||||
[efl_doxygen=${withval}
|
||||
AC_CHECK_PROG([efl_have_doxygen],
|
||||
[${efl_doxygen}],
|
||||
[yes],
|
||||
[no])
|
||||
if test "x${efl_have_doxygen}" = "xno" ; then
|
||||
echo "WARNING:"
|
||||
echo "The doxygen program you specified:"
|
||||
echo "${efl_doxygen}"
|
||||
echo "was not found. Please check the path and make sure "
|
||||
echo "the program exists and is executable."
|
||||
AC_MSG_WARN([no doxygen detected. Documentation will not be built])
|
||||
fi
|
||||
],
|
||||
[AC_CHECK_PROG([efl_have_doxygen],
|
||||
[${efl_doxygen}],
|
||||
[yes],
|
||||
[no])
|
||||
if test "x${efl_have_doxygen}" = "xno" ; then
|
||||
echo "WARNING:"
|
||||
echo "The doxygen program was not found in your execute path."
|
||||
echo "You may have doxygen installed somewhere not covered by your path."
|
||||
echo ""
|
||||
echo "If this is the case make sure you have the packages installed, AND"
|
||||
echo "that the doxygen program is in your execute path (see your"
|
||||
echo "shell manual page on setting the \$PATH environment variable), OR"
|
||||
echo "alternatively, specify the program to use with --with-doxygen."
|
||||
AC_MSG_WARN([no doxygen detected. Documentation will not be built])
|
||||
fi
|
||||
])
|
||||
fi
|
||||
|
||||
dnl
|
||||
dnl Substitution
|
||||
dnl
|
||||
AC_SUBST([efl_doxygen])
|
||||
|
||||
if ! test "x${efl_have_doxygen}" = "xyes" ; then
|
||||
efl_enable_doc="no"
|
||||
fi
|
||||
|
||||
AM_CONDITIONAL(EFL_BUILD_DOC, test "x${efl_enable_doc}" = "xyes")
|
||||
|
||||
if test "x${efl_enable_doc}" = "xyes" ; then
|
||||
m4_default([$1], [:])
|
||||
else
|
||||
m4_default([$2], [:])
|
||||
fi
|
||||
|
||||
])
|
||||
|
||||
dnl End of efl_doxygen.m4
|
||||
|
|
@ -1,6 +1,9 @@
|
|||
/**
|
||||
* @file
|
||||
*
|
||||
* This is the client-server thumbnail library, see @ref
|
||||
* tutorial_ethumb_client.
|
||||
*
|
||||
* Copyright (C) 2009 by ProFUSION embedded systems
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
|
|
@ -19,7 +22,46 @@
|
|||
* USA.
|
||||
*
|
||||
* @author Rafael Antognolli <antognolli@profusion.mobi>
|
||||
* @author Gustavo Sverzut Barbieri <barbieri@profusion.mobi>
|
||||
*/
|
||||
|
||||
/**
|
||||
* @page tutorial_ethumb_client Client-Server Thumbnailing Tutorial
|
||||
*
|
||||
* @section tutorial_ethumb_client_intro Introduction
|
||||
*
|
||||
* Ethumb provides both in process and client-server generation
|
||||
* methods. The advantage of the client-server method is that current
|
||||
* process will not do the heavy operations that may block, stopping
|
||||
* animations and other user interactions. Instead the client library
|
||||
* will configure a local #Ethumb instance and mirrors/controls a
|
||||
* remote process using DBus. The simple operations like most setters
|
||||
* and getters as well as checking for thumbnail existence
|
||||
* (ethumb_client_thumb_exists()) is done locally, while expensive
|
||||
* (ethumb_client_generate()) are done on server and then reported
|
||||
* back to application when it is finished (both success or failure).
|
||||
*
|
||||
* @section tutorial_ethumb_client_connect Connecting to Server
|
||||
*
|
||||
* TODO
|
||||
*
|
||||
* @section tutorial_ethumb_client_generate Requesting Thumbnail Generation
|
||||
*
|
||||
* TODO
|
||||
*
|
||||
* @section tutorial_ethumb_client_setup Setup Extra Thumbnail Parameters
|
||||
*
|
||||
* TODO
|
||||
*
|
||||
* @section tutorial_ethumb_client_server_died Handle Server Disconnection
|
||||
*
|
||||
* TODO
|
||||
*/
|
||||
|
||||
/**
|
||||
* @cond LOCAL
|
||||
*/
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include "config.h"
|
||||
#endif
|
||||
|
|
@ -417,6 +459,10 @@ error:
|
|||
_ethumb_client_report_connect(client, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* @endcond
|
||||
*/
|
||||
|
||||
EAPI int
|
||||
ethumb_client_init(void)
|
||||
{
|
||||
|
|
@ -676,6 +722,10 @@ ethumb_client_on_server_die_callback_set(Ethumb_Client *client, Ethumb_Client_Di
|
|||
client->die.free_data = free_data;
|
||||
}
|
||||
|
||||
/**
|
||||
* @cond LOCAL
|
||||
*/
|
||||
|
||||
static void
|
||||
_ethumb_client_ethumb_setup_cb(void *data, DBusMessage *msg, DBusError *error)
|
||||
{
|
||||
|
|
@ -734,6 +784,10 @@ _ethumb_client_dbus_append_bytearray(DBusMessageIter *iter, const char *string)
|
|||
dbus_message_iter_close_container(iter, &viter);
|
||||
}
|
||||
|
||||
/**
|
||||
* @endcond
|
||||
*/
|
||||
|
||||
/**
|
||||
* Send setup to server.
|
||||
*
|
||||
|
|
@ -769,6 +823,9 @@ ethumb_client_ethumb_setup(Ethumb_Client *client)
|
|||
dbus_message_iter_init_append(msg, &iter);
|
||||
dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "{sv}", &aiter);
|
||||
|
||||
/**
|
||||
* @cond LOCAL
|
||||
*/
|
||||
#define _open_variant_iter(str_entry, str_type, end_iter) \
|
||||
entry = str_entry; \
|
||||
dbus_message_iter_open_container(&aiter, DBUS_TYPE_DICT_ENTRY, NULL, &diter); \
|
||||
|
|
@ -779,6 +836,9 @@ ethumb_client_ethumb_setup(Ethumb_Client *client)
|
|||
#define _close_variant_iter(end_iter) \
|
||||
dbus_message_iter_close_container(&diter, &end_iter); \
|
||||
dbus_message_iter_close_container(&aiter, &diter);
|
||||
/**
|
||||
* @endcond
|
||||
*/
|
||||
|
||||
/* starting array elements */
|
||||
|
||||
|
|
@ -880,6 +940,10 @@ ethumb_client_ethumb_setup(Ethumb_Client *client)
|
|||
dbus_message_unref(msg);
|
||||
}
|
||||
|
||||
/**
|
||||
* @cond LOCAL
|
||||
*/
|
||||
|
||||
static void
|
||||
_ethumb_client_generated_cb(void *data, DBusMessage *msg)
|
||||
{
|
||||
|
|
@ -1057,6 +1121,9 @@ end:
|
|||
pending->free_data(pending->data);
|
||||
free(pending);
|
||||
}
|
||||
/**
|
||||
* @endcond
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ask server to cancel generation of thumbnail.
|
||||
|
|
@ -1154,6 +1221,9 @@ end:
|
|||
dbus_message_unref(msg);
|
||||
}
|
||||
|
||||
/**
|
||||
* @cond LOCAL
|
||||
*/
|
||||
static void
|
||||
_ethumb_client_queue_clear_cb(void *data, DBusMessage *msg __UNUSED__, DBusError *error __UNUSED__)
|
||||
{
|
||||
|
|
@ -1161,6 +1231,9 @@ _ethumb_client_queue_clear_cb(void *data, DBusMessage *msg __UNUSED__, DBusError
|
|||
|
||||
client->pending_clear = NULL;
|
||||
}
|
||||
/**
|
||||
* @endcond
|
||||
*/
|
||||
|
||||
/**
|
||||
* Ask server to cancel generation of all thumbnails.
|
||||
|
|
|
|||
|
|
@ -37,10 +37,64 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @defgroup Ethumb_Client Client
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief client handle.
|
||||
*
|
||||
* The client handle is created by ethumb_client_connect() and
|
||||
* destroyed by ethumb_client_disconnect(). The connection and
|
||||
* requests are asynchronous and callbacks should be used to report
|
||||
* both success and failure of calls.
|
||||
*/
|
||||
typedef struct _Ethumb_Client Ethumb_Client;
|
||||
|
||||
/**
|
||||
* @brief reports results of ethumb_client_connect()
|
||||
*
|
||||
* @param data extra context given to ethumb_client_connect().
|
||||
* @param client handle of the current connection to server.
|
||||
* @param success #EINA_TRUE if connected or #EINA_FALSE if it was not possible.
|
||||
*/
|
||||
typedef void (*Ethumb_Client_Connect_Cb)(void *data, Ethumb_Client *client, Eina_Bool success);
|
||||
|
||||
/**
|
||||
* @brief reports server connection ended.
|
||||
*
|
||||
* Functions of this type may be called if they are set with
|
||||
* ethumb_client_on_server_die_callback_set().
|
||||
*
|
||||
* @param data extra context given to ethumb_client_on_server_die_callback_set().
|
||||
* @param client handle of the current connection to server.
|
||||
*/
|
||||
typedef void (*Ethumb_Client_Die_Cb)(void *data, Ethumb_Client *client);
|
||||
|
||||
/**
|
||||
* @brief reports results of ethumb_client_generate().
|
||||
*
|
||||
* @param data extra context given to ethumb_client_generate().
|
||||
* @param client handle of the current connection to server.
|
||||
* @param id identifier returned by ethumb_client_generate().
|
||||
* @param file path set with ethumb_client_file_set().
|
||||
* @param key value set with ethumb_client_file_set() or #NULL.
|
||||
* @param thumb_path where thumbnail was stored, either set with
|
||||
* ethumb_client_thumb_path_set() or automatically calculated
|
||||
* using parameters.
|
||||
* @param thumb_key key inside thumb_path where thumbnail was stored or #NULL.
|
||||
* @param success #EINA_TRUE if generated or #EINA_FALSE on errors.
|
||||
*/
|
||||
typedef void (*Ethumb_Client_Generate_Cb)(void *data, Ethumb_Client *client, int id, const char *file, const char *key, const char *thumb_path, const char *thumb_key, Eina_Bool success);
|
||||
|
||||
/**
|
||||
* @brief reports results of ethumb_client_generate_cancel()
|
||||
*
|
||||
* @param data extra context given to ethumb_client_generate_cancel()
|
||||
* @param client handle of the current connection to server.
|
||||
*/
|
||||
typedef void (*Ethumb_Client_Generate_Cancel_Cb)(void *data, Eina_Bool success);
|
||||
|
||||
EAPI int ethumb_client_init(void);
|
||||
|
|
@ -88,6 +142,11 @@ EAPI int ethumb_client_generate(Ethumb_Client *client, Ethumb_Client_Generate_C
|
|||
EAPI void ethumb_client_generate_cancel(Ethumb_Client *client, int id, Ethumb_Client_Generate_Cancel_Cb cancel_cb, const void *data, Eina_Free_Cb free_data);
|
||||
EAPI void ethumb_client_generate_cancel_all(Ethumb_Client *client);
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
|
|
|||
Loading…
Reference in New Issue