summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefan Schmidt <s.schmidt@samsung.com>2019-10-02 17:45:07 +0200
committerStefan Schmidt <s.schmidt@samsung.com>2019-12-09 15:31:00 +0100
commit4ff8fb140cf6c9bda359c8872095d2c1c28fad86 (patch)
tree911554cc63aa874e8f7cc4acb0f69768a6d52f49 /doc
parent431f3b1fcef2b49b4c43539c51ad50fcd99a55bd (diff)
downloadefl-4ff8fb140cf6c9bda359c8872095d2c1c28fad86.tar.gz
elocation: remove beta library
This has never been fully finished or really used. The GeoClue project dbus API moved on to a newer version as well. We still have it marked as beta so we should take the chance and get rid of it to cleanup our tree a little bit. Reviewed-by: Chris Michael <cp.michael@samsung.com> Reviewed-by: Vincent Torri <vincent.torri@gmail.com> Differential Revision: https://phab.enlightenment.org/D10788
Diffstat (limited to 'doc')
-rw-r--r--doc/elementary_examples.dox1
-rw-r--r--doc/elementary_examples_cxx.dox226
-rw-r--r--doc/main.dox1
3 files changed, 0 insertions, 228 deletions
diff --git a/doc/elementary_examples.dox b/doc/elementary_examples.dox
index dc7acbab47..76aa37e953 100644
--- a/doc/elementary_examples.dox
+++ b/doc/elementary_examples.dox
@@ -6809,7 +6809,6 @@
* @example efl_thread_win32_2.c
* @example efl_thread_win32_3.c
* @example efl_thread_win32_4.c
- * @example location_example_01.c
* @example naviframe_example.c
*/
diff --git a/doc/elementary_examples_cxx.dox b/doc/elementary_examples_cxx.dox
index 6197450ac1..b0e083f331 100644
--- a/doc/elementary_examples_cxx.dox
+++ b/doc/elementary_examples_cxx.dox
@@ -33,8 +33,6 @@
*
* @ref icon_cxx_example_01
*
- * @ref location_cxx_example_01
- *
* @ref menu_cxx_example_01
*
* @ref popup_cxx_example_01
@@ -3201,230 +3199,6 @@
*/
/**
- * @page location_cxx_example_01 Location example with C++ Binding
- * @dontinclude location_cxx_example_01.cc
-
- * This example shows how to integrate the Elocation.h library with
- * elementary.
-
- * The first part consists of including the headers. In this case we
- * need to include both Elementary C++ binding and Elocation,
-
- * @skip Elementary.hh
- * @until endif
-
- * @attention All necessary libraries from Elementary, Elightenment, C
- * and/or C++ headers should be include here.
-
- * Before our main code, we need a set of callbacks to react on
- * incoming elocation events. They are standard ecore events and we
- * register callbacks on these events in the main function.
-
- * @skip void
- * @until ECORE_CALLBACK_DONE
- * @until }
-
- * Now we need to actually start the code and initializing pointers
- * for address, addr_geocode, position and pos_geocode and an integer
- * status. We also run a check for elm_need_elocation.
-
- * @skip EAPI_MAIN
- * @until -1
-
- * Now let's set the elm_policy, which defines for a given policy
- * group/identifier a new policy's value, respectively. In this
- * example the only policy we need to set a value for is @c
- * ELM_POLICY_QUIT, possibles values for it are:
-
- * @li @p ELM_POLICY_QUIT_NONE: Never quit the application
- * automatically;
-
- * @li @p ELM_POLICY_QUIT_LAST_WINDOW_CLOSED: quit when the
- * application's last window is closed;
-
- * @li @p ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN : quit when the
- * application's last window is hidden;
-
- * @skipline elm_policy_set
-
- * As you can see, the policy we chose was to quit when the last win
- * is hidden as opposed to examples with the C bindings where we
- * perpetually set it to quit when last win was closed. This changed
- * was necessary because in C++ binding as the elm mainloop stop
- * running all object are destroyed, references are unreferenced and
- * events are stopped at ELM_MAIN().
-
- * @see For more details consult elm_policy_set
-
- * Next step is creating an elementary window, in this example we use
- * the C++ binding method with the elm_win_util_standard_add that is a
- * elm_win_legacy function, better explained below. And then we set
- * the autohide state for it.
-
- * @p elm_win_util_standard_add (const char *name, const char *tittle)
- * Adds a window object with standard setup.
- * Parameters:
-
- * @li @p name - The name of the window;
-
- * @li @p title - The title for the window.
-
- * This creates a window but also puts in a standard background with
- * @p elm_bg_add(), as well as setting the window title to @p
- * title. The window type created is of type @c ELM_WIN_BASIC, with
- * the @c NULL as the parent widget. Returns the created object or @c
- * NULL on failure.
-
- * The autohide works similarly to @p autodel, automatically handling
- * "delete,request" signals when set to @p true, with the difference
- * that it will hide the window, instead of destroying it.
-
- * It is specially designed to work together with @p
- * ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN which allows exiting
- * Elementary's main loop when all the windows are hidden.
-
- * @skip ::elm::win
- * @until autohide_set
-
- * @note @p autodel and @a autohide are not mutually exclusive. The
- * window will be destructed if both autodel and autohide is set to @p
- * EINA_TRUE or @p true.
-
- * For this example we're using a label that will display the text
- * "Getting location ...". First we'll create our label, setting it's
- * parent, then setting the following label's options:
-
- * @li @p line_wrap_set: Set the wrapping behavior of the label, by
- * default no wrapping is done. Possible values for wrap are:
- * @p ELM_WRAP_NONE - No wrapping;
- * @p ELM_WRAP_CHAR - wrap between characters;
- * @p ELM_WRAP_WORD - wrap between words;
- * @p ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap.
-
- * @ skipline wrap
-
- * @li @p text_set: Set the text that label will display.
-
- * @skipline text
-
- * @li @p slide_mode_set: Set the slide mode of the label widget. By
- * default, slide mode is none. Possible values for mode are:
-
- * ELM_LABEL_SLIDE_MODE_NONE - no slide effect
-
- * ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger
- * than the text width length
-
- * ELM_LABEL_SLIDE_MODE_ALWAYS -slide always
-
- * @attention ELM_LABEL_SLIDE_MODE_AUTO, ELM_LABEL_SLIDE_MODE_ALWAYS
- * only work with the themes "slide_short", "slide_long" and
- * "slide_bounce". ELM_LABEL_SLIDE_MODE_AUTO,
- * ELM_LABEL_SLIDE_MODE_ALWAYS don't work if the line
- * wrap(elm_label_line_wrap_set()) or
- * ellipsis(elm_label_ellipsis_set()) is set.
-
- * @skipline slide
-
- * To better understand, the function @c size_hint_weight_set for C++
- * bindings originated from C bindings function
- * evas_object_size_hint_weight_set, that is EFL Evas type function.
- * With this function we set the hints for an object's weight. The
- * parameters are:
-
- * @li x - Nonnegative double value to use as horizontal weight hint.
-
- * @li y - Nonnegative double value to use as vertical weight hint.
-
- * This is not a size enforcement in any way, it's just a hint that
- * should be used whenever appropriate. This is a hint on how a
- * container object should resize a given child within its area.
-
- * Containers may adhere to the simpler logic of just expanding the
- * child object's dimensions to fit its own (see the EVAS_HINT_EXPAND
- * helper weight macro in the EFL Evas Documentation) or the complete
- * one of taking each child's weight hint as real weights to how much
- * of its size to allocate for them in each axis. A container is
- * supposed to, after normalizing the weights of its children (with
- * weight hints), distribute the space it has to layout them by those
- * factors – most weighted children get larger in this process than
- * the least ones.
-
- * @dontinclude location_cxx_example_01.cc
- * @skipline weight_set
-
- * @note Default weight hint values are 0.0, for both axis.
-
- * The function @c size_hint_align_set for C++ bindings originated
- * from C bindings function evas_object_size_hint_align_set, that is
- * EFL Evas type function. With this function we set the hints for an
- * object's alignment. The parameters are:
-
- * @li x - Double, ranging from 0.0 to 1.0 or with the special value
- * EVAS_HINT_FILL, to use as horizontal alignment hint.
-
- * @li y - Double, ranging from 0.0 to 1.0 or with the special value
- * EVAS_HINT_FILL, to use as vertical alignment hint.
-
- * These are hints on how to align an object inside the boundaries of
- * a container/manager. Accepted values are in the 0.0 to 1.0 range,
- * with the special value EVAS_HINT_FILL used to specify "justify" or
- * "fill" by some users. In this case, maximum size hints should be
- * enforced with higher priority, if they are set. Also, any padding
- * hint set on objects should add up to the alignment space on the
- * final scene composition.
-
- * For the horizontal component, 0.0 means to the left, 1.0 means to
- * the right. Analogously, for the vertical component, 0.0 to the top,
- * 1.0 means to the bottom.
-
- * This is not a size enforcement in any way, it's just a hint that
- * should be used whenever appropriate.
-
- * @note Default alignment hint values are 0.5, for both axis.
-
- * @skipline align_set
-
- * Setting the size for label and make it visible.
-
- * @skip size
- * @until visibility
-
- * Going back to our elocation, first we'll create an address
- * and position object that we'll use for all our operations.
-
- * @skip address
- * @until position
-
- * We also have to register our callback so we get updates later on.
-
- * @skipline ecore
-
- * Now we need to get the elocation position and print it, using our
- * label. This fills in the object with the data from GeoClue.
-
- * @skip elocation
- * @until print
-
- * Now we only have to set the size for our window and make it
- * visible.
-
- * @skip size_set
- * @until visibility_set
-
- * And finally, start the elm mainloop, starting to handle events and
- * drawing operations.
-
- * @skip elm_run
- * @until ELM_MAIN
-
- * The full code for this example can be found at @ref location_cxx_example_01.cc
-
- * @example location_cxx_example_01.cc
- */
-
-
-/**
* @page menu_cxx_example_01 Menu Example with C++ Binding
* @dontinclude menu_cxx_example_01.cc
diff --git a/doc/main.dox b/doc/main.dox
index a0e32886e4..46f3c4edca 100644
--- a/doc/main.dox
+++ b/doc/main.dox
@@ -43,7 +43,6 @@
* <h3>Early stage libraries (BETA testing)</h3>
*
* @li @ref eolian_main an EO file parser and code generator.
- * @li @ref elocation_main awareness library.
*
* If you are looking for methods that do not fit into the above list you can
* see the full <a href="modules.html" />module listing</a>.