summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHermet Park <hermetpark@gmail.com>2019-12-10 19:23:20 +0900
committerHermet Park <hermetpark@gmail.com>2019-12-10 19:23:20 +0900
commit6fa91c71d8c63573883f57e397e788606029ba43 (patch)
tree432572834a811ee7d7b5bab0bdb474e2f6dba83b /doc
parenta1ea861d882da58431e15290f07e545762d589ae (diff)
parentcbd02d3d51c6cbb6c118467088c6cd40f8114820 (diff)
Merge branch 'master' into devs/hermet/lottie
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 @@
6809 * @example efl_thread_win32_2.c 6809 * @example efl_thread_win32_2.c
6810 * @example efl_thread_win32_3.c 6810 * @example efl_thread_win32_3.c
6811 * @example efl_thread_win32_4.c 6811 * @example efl_thread_win32_4.c
6812 * @example location_example_01.c
6813 * @example naviframe_example.c 6812 * @example naviframe_example.c
6814 */ 6813 */
6815 6814
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 @@
33 * 33 *
34 * @ref icon_cxx_example_01 34 * @ref icon_cxx_example_01
35 * 35 *
36 * @ref location_cxx_example_01
37 *
38 * @ref menu_cxx_example_01 36 * @ref menu_cxx_example_01
39 * 37 *
40 * @ref popup_cxx_example_01 38 * @ref popup_cxx_example_01
@@ -3201,230 +3199,6 @@
3201 */ 3199 */
3202 3200
3203/** 3201/**
3204 * @page location_cxx_example_01 Location example with C++ Binding
3205 * @dontinclude location_cxx_example_01.cc
3206
3207 * This example shows how to integrate the Elocation.h library with
3208 * elementary.
3209
3210 * The first part consists of including the headers. In this case we
3211 * need to include both Elementary C++ binding and Elocation,
3212
3213 * @skip Elementary.hh
3214 * @until endif
3215
3216 * @attention All necessary libraries from Elementary, Elightenment, C
3217 * and/or C++ headers should be include here.
3218
3219 * Before our main code, we need a set of callbacks to react on
3220 * incoming elocation events. They are standard ecore events and we
3221 * register callbacks on these events in the main function.
3222
3223 * @skip void
3224 * @until ECORE_CALLBACK_DONE
3225 * @until }
3226
3227 * Now we need to actually start the code and initializing pointers
3228 * for address, addr_geocode, position and pos_geocode and an integer
3229 * status. We also run a check for elm_need_elocation.
3230
3231 * @skip EAPI_MAIN
3232 * @until -1
3233
3234 * Now let's set the elm_policy, which defines for a given policy
3235 * group/identifier a new policy's value, respectively. In this
3236 * example the only policy we need to set a value for is @c
3237 * ELM_POLICY_QUIT, possibles values for it are:
3238
3239 * @li @p ELM_POLICY_QUIT_NONE: Never quit the application
3240 * automatically;
3241
3242 * @li @p ELM_POLICY_QUIT_LAST_WINDOW_CLOSED: quit when the
3243 * application's last window is closed;
3244
3245 * @li @p ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN : quit when the
3246 * application's last window is hidden;
3247
3248 * @skipline elm_policy_set
3249
3250 * As you can see, the policy we chose was to quit when the last win
3251 * is hidden as opposed to examples with the C bindings where we
3252 * perpetually set it to quit when last win was closed. This changed
3253 * was necessary because in C++ binding as the elm mainloop stop
3254 * running all object are destroyed, references are unreferenced and
3255 * events are stopped at ELM_MAIN().
3256
3257 * @see For more details consult elm_policy_set
3258
3259 * Next step is creating an elementary window, in this example we use
3260 * the C++ binding method with the elm_win_util_standard_add that is a
3261 * elm_win_legacy function, better explained below. And then we set
3262 * the autohide state for it.
3263
3264 * @p elm_win_util_standard_add (const char *name, const char *tittle)
3265 * Adds a window object with standard setup.
3266 * Parameters:
3267
3268 * @li @p name - The name of the window;
3269
3270 * @li @p title - The title for the window.
3271
3272 * This creates a window but also puts in a standard background with
3273 * @p elm_bg_add(), as well as setting the window title to @p
3274 * title. The window type created is of type @c ELM_WIN_BASIC, with
3275 * the @c NULL as the parent widget. Returns the created object or @c
3276 * NULL on failure.
3277
3278 * The autohide works similarly to @p autodel, automatically handling
3279 * "delete,request" signals when set to @p true, with the difference
3280 * that it will hide the window, instead of destroying it.
3281
3282 * It is specially designed to work together with @p
3283 * ELM_POLICY_QUIT_LAST_WINDOW_HIDDEN which allows exiting
3284 * Elementary's main loop when all the windows are hidden.
3285
3286 * @skip ::elm::win
3287 * @until autohide_set
3288
3289 * @note @p autodel and @a autohide are not mutually exclusive. The
3290 * window will be destructed if both autodel and autohide is set to @p
3291 * EINA_TRUE or @p true.
3292
3293 * For this example we're using a label that will display the text
3294 * "Getting location ...". First we'll create our label, setting it's
3295 * parent, then setting the following label's options:
3296
3297 * @li @p line_wrap_set: Set the wrapping behavior of the label, by
3298 * default no wrapping is done. Possible values for wrap are:
3299 * @p ELM_WRAP_NONE - No wrapping;
3300 * @p ELM_WRAP_CHAR - wrap between characters;
3301 * @p ELM_WRAP_WORD - wrap between words;
3302 * @p ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap.
3303
3304 * @ skipline wrap
3305
3306 * @li @p text_set: Set the text that label will display.
3307
3308 * @skipline text
3309
3310 * @li @p slide_mode_set: Set the slide mode of the label widget. By
3311 * default, slide mode is none. Possible values for mode are:
3312
3313 * ELM_LABEL_SLIDE_MODE_NONE - no slide effect
3314
3315 * ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger
3316 * than the text width length
3317
3318 * ELM_LABEL_SLIDE_MODE_ALWAYS -slide always
3319
3320 * @attention ELM_LABEL_SLIDE_MODE_AUTO, ELM_LABEL_SLIDE_MODE_ALWAYS
3321 * only work with the themes "slide_short", "slide_long" and
3322 * "slide_bounce". ELM_LABEL_SLIDE_MODE_AUTO,
3323 * ELM_LABEL_SLIDE_MODE_ALWAYS don't work if the line
3324 * wrap(elm_label_line_wrap_set()) or
3325 * ellipsis(elm_label_ellipsis_set()) is set.
3326
3327 * @skipline slide
3328
3329 * To better understand, the function @c size_hint_weight_set for C++
3330 * bindings originated from C bindings function
3331 * evas_object_size_hint_weight_set, that is EFL Evas type function.
3332 * With this function we set the hints for an object's weight. The
3333 * parameters are:
3334
3335 * @li x - Nonnegative double value to use as horizontal weight hint.
3336
3337 * @li y - Nonnegative double value to use as vertical weight hint.
3338
3339 * This is not a size enforcement in any way, it's just a hint that
3340 * should be used whenever appropriate. This is a hint on how a
3341 * container object should resize a given child within its area.
3342
3343 * Containers may adhere to the simpler logic of just expanding the
3344 * child object's dimensions to fit its own (see the EVAS_HINT_EXPAND
3345 * helper weight macro in the EFL Evas Documentation) or the complete
3346 * one of taking each child's weight hint as real weights to how much
3347 * of its size to allocate for them in each axis. A container is
3348 * supposed to, after normalizing the weights of its children (with
3349 * weight hints), distribute the space it has to layout them by those
3350 * factors – most weighted children get larger in this process than
3351 * the least ones.
3352
3353 * @dontinclude location_cxx_example_01.cc
3354 * @skipline weight_set
3355
3356 * @note Default weight hint values are 0.0, for both axis.
3357
3358 * The function @c size_hint_align_set for C++ bindings originated
3359 * from C bindings function evas_object_size_hint_align_set, that is
3360 * EFL Evas type function. With this function we set the hints for an
3361 * object's alignment. The parameters are:
3362
3363 * @li x - Double, ranging from 0.0 to 1.0 or with the special value
3364 * EVAS_HINT_FILL, to use as horizontal alignment hint.
3365
3366 * @li y - Double, ranging from 0.0 to 1.0 or with the special value
3367 * EVAS_HINT_FILL, to use as vertical alignment hint.
3368
3369 * These are hints on how to align an object inside the boundaries of
3370 * a container/manager. Accepted values are in the 0.0 to 1.0 range,
3371 * with the special value EVAS_HINT_FILL used to specify "justify" or
3372 * "fill" by some users. In this case, maximum size hints should be
3373 * enforced with higher priority, if they are set. Also, any padding
3374 * hint set on objects should add up to the alignment space on the
3375 * final scene composition.
3376
3377 * For the horizontal component, 0.0 means to the left, 1.0 means to
3378 * the right. Analogously, for the vertical component, 0.0 to the top,
3379 * 1.0 means to the bottom.
3380
3381 * This is not a size enforcement in any way, it's just a hint that
3382 * should be used whenever appropriate.
3383
3384 * @note Default alignment hint values are 0.5, for both axis.
3385
3386 * @skipline align_set
3387
3388 * Setting the size for label and make it visible.
3389
3390 * @skip size
3391 * @until visibility
3392
3393 * Going back to our elocation, first we'll create an address
3394 * and position object that we'll use for all our operations.
3395
3396 * @skip address
3397 * @until position
3398
3399 * We also have to register our callback so we get updates later on.
3400
3401 * @skipline ecore
3402
3403 * Now we need to get the elocation position and print it, using our
3404 * label. This fills in the object with the data from GeoClue.
3405
3406 * @skip elocation
3407 * @until print
3408
3409 * Now we only have to set the size for our window and make it
3410 * visible.
3411
3412 * @skip size_set
3413 * @until visibility_set
3414
3415 * And finally, start the elm mainloop, starting to handle events and
3416 * drawing operations.
3417
3418 * @skip elm_run
3419 * @until ELM_MAIN
3420
3421 * The full code for this example can be found at @ref location_cxx_example_01.cc
3422
3423 * @example location_cxx_example_01.cc
3424 */
3425
3426
3427/**
3428 * @page menu_cxx_example_01 Menu Example with C++ Binding 3202 * @page menu_cxx_example_01 Menu Example with C++ Binding
3429 * @dontinclude menu_cxx_example_01.cc 3203 * @dontinclude menu_cxx_example_01.cc
3430 3204
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 @@
43 * <h3>Early stage libraries (BETA testing)</h3> 43 * <h3>Early stage libraries (BETA testing)</h3>
44 * 44 *
45 * @li @ref eolian_main an EO file parser and code generator. 45 * @li @ref eolian_main an EO file parser and code generator.
46 * @li @ref elocation_main awareness library.
47 * 46 *
48 * If you are looking for methods that do not fit into the above list you can 47 * If you are looking for methods that do not fit into the above list you can
49 * see the full <a href="modules.html" />module listing</a>. 48 * see the full <a href="modules.html" />module listing</a>.