Merge branch 'upstream'
[framework/uifw/elementary.git] / src / lib / elm_main.c
1 #ifdef HAVE_CONFIG_H
2 # include "elementary_config.h"
3 #endif
4
5 #include <dlfcn.h> /* dlopen,dlclose,etc */
6
7 #ifdef HAVE_CRT_EXTERNS_H
8 # include <crt_externs.h>
9 #endif
10
11 #ifdef HAVE_EVIL
12 # include <Evil.h>
13 #endif
14
15 #include <Elementary.h>
16 #include "elm_priv.h"
17
18 #define SEMI_BROKEN_QUICKLAUNCH 1
19
20 static Elm_Version _version = { VMAJ, VMIN, VMIC, VREV };
21 EAPI Elm_Version *elm_version = &_version;
22 /**
23  * @defgroup Main Main
24  * @ingroup Elementary
25  *
26  * This group includes functions of elm_main.c
27  */
28
29
30 Eina_Bool
31 _elm_dangerous_call_check(const char *call)
32 {
33    char buf[256];
34    const char *eval;
35
36    snprintf(buf, sizeof(buf), "%i.%i.%i.%i", VMAJ, VMIN, VMIC, VREV);
37    eval = getenv("ELM_NO_FINGER_WAGGLING");
38    if ((eval) && (!strcmp(eval, buf)))
39      return 0;
40    printf("ELEMENTARY FINGER WAGGLE!!!!!!!!!!\n"
41           "\n"
42           "  %s() used.\n"
43           "PLEASE see the API documentation for this function. This call\n"
44           "should almost never be used. Only in very special cases.\n"
45           "\n"
46           "To remove this warning please set the environment variable:\n"
47           "  ELM_NO_FINGER_WAGGLING\n"
48           "To the value of the Elementary version + revision number. e.g.:\n"
49           "  1.2.5.40295\n"
50           "\n"
51           ,
52           call);
53    return 1;
54 }
55
56 /**
57  * @defgroup Start Getting Started
58  * @ingroup Main
59  *
60  * To write an Elementary app, you can get started with the following:
61  *
62  * @code
63  * #include <Elementary.h>
64  * #ifndef ELM_LIB_QUICKLAUNCH
65  * EAPI int
66  * elm_main(int argc, char **argv)
67  * {
68  *    // create window(s) here and do any application init
69  *    elm_run(); // run main loop
70  *    elm_shutdown(); // after mainloop finishes running, shutdown
71  *    return 0; // exit 0 for exit code
72  * }
73  * #endif
74  * ELM_MAIN()
75  * @endcode
76  *
77  * To take full advantage of the quicklaunch architecture for launching
78  * processes as quickly as possible (saving time at startup time like
79  * connecting to X11, loading and linking shared libraries) you may want to
80  * use the following configure.in/configure.ac and Makefile.am and autogen.sh
81  * script to generate your files. It is assumed your application uses the
82  * main.c file for its code.
83  *
84  * configure.in/configure.ac:
85  *
86 @verbatim
87 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
88 AC_PREREQ(2.52)
89 AC_CONFIG_SRCDIR(configure.in)
90
91 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
92 AM_CONFIG_HEADER(config.h)
93
94 AC_C_BIGENDIAN
95 AC_ISC_POSIX
96 AC_PROG_CC
97 AM_PROG_CC_STDC
98 AC_HEADER_STDC
99 AC_C_CONST
100
101 AC_LIBTOOL_WIN32_DLL
102 define([AC_LIBTOOL_LANG_CXX_CONFIG], [:])dnl
103 define([AC_LIBTOOL_LANG_F77_CONFIG], [:])dnl
104 AC_PROG_LIBTOOL
105
106 PKG_CHECK_MODULES([ELEMENTARY], elementary)
107
108 AC_OUTPUT(Makefile)
109 @endverbatim
110  *
111  * Makefile.am:
112  *
113 @verbatim
114 AUTOMAKE_OPTIONS     = 1.4 foreign
115 MAINTAINERCLEANFILES = Makefile.in
116
117 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
118
119 bin_PROGRAMS      = myapp
120 myapp_LTLIBRARIES = myapp.la
121
122 myappdir = $(libdir)
123
124 myapp_la_SOURCES = main.c
125 myapp_la_LIBADD = @ELEMENTARY_LIBS@
126 myapp_la_CFLAGS =
127 myapp_la_LDFLAGS = -module -avoid-version -no-undefined
128
129 myapp_SOURCES = main.c
130 myapp_LDADD = @ELEMENTARY_LIBS@
131 myapp_CFLAGS = -DELM_LIB_QUICKLAUNCH=1
132 @endverbatim
133  *
134  * autogen.sh:
135  *
136 @verbatim
137 #!/bin/sh
138 rm -rf autom4te.cache
139 rm -f aclocal.m4 ltmain.sh
140 rm -rf m4
141 mkdir m4
142
143 touch README
144 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS -I m4 || exit 1
145 echo "Running autoheader..." ; autoheader || exit 1
146 echo "Running autoconf..." ; autoconf || exit 1
147 echo "Running libtoolize..." ; (libtoolize --copy --automake || glibtoolize --automake) || exit 1
148 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
149
150 if [ -z "$NOCONFIGURE" ]; then
151   ./configure "$@"
152 fi
153 @endverbatim
154  *
155  * To gnerate all the things needed to bootstrap just run:
156  *
157 @verbatim
158 ./autogen.sh
159 @endverbatim
160  *
161  * This will generate Makefile.in's, the confgure script and everything else.
162  * After this it works like all normal autotools projects:
163 @verbatim
164 ./configure
165 make
166 sudo make install
167 @endverbatim
168  *
169  * Note sudo was assumed to get root permissions, as this would install in
170  * /usr/local which is system-owned. Use any way you like to gain root, or
171  * specify a different prefix with configure:
172  *
173 @verbatim
174 ./confiugre --prefix=$HOME/mysoftware
175 @endverbatim
176  *
177  * Also remember that autotools buys you some useful commands like:
178 @verbatim
179 make uninstall
180 @endverbatim
181  *
182  * This uninstalls the software after it was installed with "make install".
183  * It is very useful to clear up what you built if you wish to clean the
184  * system.
185  *
186 @verbatim
187 make distcheck
188 @endverbatim
189  *
190  * This firstly checks if your build tree is "clean" and ready for
191  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
192  * ready to upload and distribute to the world, that contains the generated
193  * Makefile.in's and configure script. The users do not need to run
194  * autogen.sh - just configure and on. They don't need autotools installed.
195  * This tarball also builds cleanly, has all the sources it needs to build
196  * included (that is sources for your application, not libraries it depends
197  * on like Elementary). It builds cleanly in a buildroot and does not
198  * contain any files that are temporarily generated like binaries and other
199  * build-generated files, so the tarball is clean, and no need to worry
200  * about cleaning up your tree before packaging.
201  *
202 @verbatim
203 make clean
204 @endverbatim
205  *
206  * This cleans up all build files (binaries, objects etc.) from the tree.
207  *
208 @verbatim
209 make distclean
210 @endverbatim
211  *
212  * This cleans out all files from the build and from configure's output too.
213  *
214 @verbatim
215 make maintainer-clean
216 @endverbatim
217  *
218  * This deletes all the files autogen.sh will produce so the tree is clean
219  * to be put into a revision-control system (like CVS, SVN or GIT for example).
220  *
221  * The above will build a library - libmyapp.so and install in the target
222  * library directory (default is /usr/local/lib). You will also get a
223  * myapp.a and myapp.la - these are useless and can be deleted. Libtool likes
224  * to generate these all the time. You will also get a binary in the target
225  * binary directory (default is /usr/local/bin). This is a "debug binary".
226  * This will run and dlopen() the myapp.so and then jump to it's elm_main
227  * function. This allows for easy debugging with GDB and Valgrind. When you
228  * are ready to go to production do the following:
229  *
230  * 1. delete the myapp binary. i.e. rm /usr/local/bin/myapp
231  *
232  * 2. symlink the myapp binary to elementary_run (supplied by elementary).
233  * i.e. ln -s elmentary_run /usr/local/bin/myapp
234  *
235  * 3. run elementary_quicklaunch as part of your graphical login session and
236  * keep it running.
237  *
238  * This will man elementary_quicklaunch does pre-initialization before the
239  * application needs to be run, saving the effort at the time the application
240  * is needed, thus speeding up the time it takes to appear.
241  *
242  * If you don't want to use the quicklaunch infrastructure (which is
243  * optional), you can execute the old fashioned way by just running the
244  * myapp binary loader than will load the myapp.so for you, or you can
245  * remove the split-file binary and put it into one binary as things always
246  * have been with the following configure.in/configure.ac and Makfile.am
247  * files:
248  *
249  * configure.in/configure.ac:
250  *
251 @verbatim
252 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
253 AC_PREREQ(2.52)
254 AC_CONFIG_SRCDIR(configure.in)
255
256 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
257 AM_CONFIG_HEADER(config.h)
258
259 AC_C_BIGENDIAN
260 AC_ISC_POSIX
261 AC_PROG_CC
262 AM_PROG_CC_STDC
263 AC_HEADER_STDC
264 AC_C_CONST
265
266 PKG_CHECK_MODULES([ELEMENTARY], elementary)
267
268 AC_OUTPUT(Makefile)
269 @endverbatim
270  *
271  * Makefile.am:
272  *
273 @verbatim
274 AUTOMAKE_OPTIONS     = 1.4 foreign
275 MAINTAINERCLEANFILES = Makefile.in
276
277 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
278
279 bin_PROGRAMS      = myapp
280
281 myapp_SOURCES = main.c
282 myapp_LDADD = @ELEMENTARY_LIBS@
283 myapp_CFLAGS =
284 @endverbatim
285  *
286  * Notice that they are the same as before, just with libtool and library
287  * building sections removed. Both ways work for building elementary
288  * applications. It is up to you to decide what is best for you. If you just
289  * follow the template above, you can do it both ways and can decide at build
290  * time. The more advanced of you may suggest making it a configure option.
291  * That is perfectly valid, but has been left out here for simplicity, as our
292  * aim to have an Elementary (and EFL) tutorial, not an autoconf & automake
293  * document.
294  *
295  */
296
297 static Eina_Bool _elm_signal_exit(void *data,
298                                   int   ev_type,
299                                   void *ev);
300
301 static Eina_Prefix *pfx = NULL;
302 char *_elm_appname = NULL;
303 const char *_elm_data_dir = NULL;
304 const char *_elm_lib_dir = NULL;
305 int _elm_log_dom = -1;
306
307 EAPI int ELM_EVENT_POLICY_CHANGED = 0;
308
309 static int _elm_init_count = 0;
310 static int _elm_sub_init_count = 0;
311 static int _elm_ql_init_count = 0;
312 static int _elm_policies[ELM_POLICY_LAST];
313 static Ecore_Event_Handler *_elm_exit_handler = NULL;
314 static Eina_Bool quicklaunch_on = 0;
315
316 static Eina_Bool
317 _elm_signal_exit(void *data  __UNUSED__,
318                  int ev_type __UNUSED__,
319                  void *ev    __UNUSED__)
320 {
321    elm_exit();
322    return ECORE_CALLBACK_PASS_ON;
323 }
324
325 void
326 _elm_rescale(void)
327 {
328    edje_scale_set(_elm_config->scale);
329    _elm_win_rescale(NULL, EINA_FALSE);
330 }
331
332 static void *app_mainfunc = NULL;
333 static const char *app_domain = NULL;
334 static const char *app_checkfile = NULL;
335
336 static const char *app_compile_bin_dir = NULL;
337 static const char *app_compile_lib_dir = NULL;
338 static const char *app_compile_data_dir = NULL;
339 static const char *app_compile_locale_dir = NULL;
340 static const char *app_prefix_dir = NULL;
341 static const char *app_bin_dir = NULL;
342 static const char *app_lib_dir = NULL;
343 static const char *app_data_dir = NULL;
344 static const char *app_locale_dir = NULL;
345
346 static Eina_Prefix *app_pfx = NULL;
347
348 static void
349 _prefix_check(void)
350 {
351    int argc = 0;
352    char **argv = NULL;
353    const char *dirs[4] = { NULL, NULL, NULL, NULL };
354    char *caps = NULL, *p1, *p2;
355
356    if (app_pfx) return;
357    if (!app_domain) return;
358
359    ecore_app_args_get(&argc, &argv);
360    if (argc < 1) return;
361
362    dirs[0] = app_compile_bin_dir;
363    dirs[1] = app_compile_lib_dir;
364    dirs[2] = app_compile_data_dir;
365    dirs[3] = app_compile_locale_dir;
366
367    if (!dirs[1]) dirs[1] = dirs[0];
368    if (!dirs[0]) dirs[0] = dirs[1];
369    if (!dirs[3]) dirs[3] = dirs[2];
370    if (!dirs[2]) dirs[2] = dirs[3];
371
372    if (app_domain)
373      {
374         caps = alloca(strlen(app_domain) + 1);
375         for (p1 = (char *)app_domain, p2 = caps; *p1; p1++, p2++)
376            *p2 = toupper(*p1);
377         *p2 = 0;
378      }
379    app_pfx = eina_prefix_new(argv[0], app_mainfunc, caps, app_domain,
380                              app_checkfile, dirs[0], dirs[1], dirs[2], dirs[3]);
381 }
382
383 static void
384 _prefix_shutdown(void)
385 {
386    if (app_pfx) eina_prefix_free(app_pfx);
387    if (app_domain) eina_stringshare_del(app_domain);
388    if (app_checkfile) eina_stringshare_del(app_checkfile);
389    if (app_compile_bin_dir) eina_stringshare_del(app_compile_bin_dir);
390    if (app_compile_lib_dir) eina_stringshare_del(app_compile_lib_dir);
391    if (app_compile_data_dir) eina_stringshare_del(app_compile_data_dir);
392    if (app_compile_locale_dir) eina_stringshare_del(app_compile_locale_dir);
393    if (app_prefix_dir) eina_stringshare_del(app_prefix_dir);
394    if (app_bin_dir) eina_stringshare_del(app_bin_dir);
395    if (app_lib_dir) eina_stringshare_del(app_lib_dir);
396    if (app_data_dir) eina_stringshare_del(app_data_dir);
397    if (app_locale_dir) eina_stringshare_del(app_locale_dir);
398    app_mainfunc = NULL;
399    app_domain = NULL;
400    app_checkfile = NULL;
401    app_compile_bin_dir = NULL;
402    app_compile_lib_dir = NULL;
403    app_compile_data_dir = NULL;
404    app_compile_locale_dir = NULL;
405    app_prefix_dir = NULL;
406    app_bin_dir = NULL;
407    app_lib_dir = NULL;
408    app_data_dir = NULL;
409    app_locale_dir = NULL;
410    app_pfx = NULL;
411 }
412
413 EAPI int
414 elm_init(int    argc,
415          char **argv)
416 {
417    _elm_init_count++;
418    if (_elm_init_count > 1) return _elm_init_count;
419    elm_quicklaunch_init(argc, argv);
420    elm_quicklaunch_sub_init(argc, argv);
421    _prefix_shutdown();
422    return _elm_init_count;
423 }
424
425 EAPI int
426 elm_shutdown(void)
427 {
428    _elm_init_count--;
429    if (_elm_init_count > 0) return _elm_init_count;
430    _elm_win_shutdown();
431    while (_elm_win_deferred_free) ecore_main_loop_iterate();
432 // wrningz :(
433 //   _prefix_shutdown();
434    elm_quicklaunch_sub_shutdown();
435    elm_quicklaunch_shutdown();
436    return _elm_init_count;
437 }
438
439 EAPI void
440 elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile)
441 {
442    app_mainfunc = mainfunc;
443    eina_stringshare_replace(&app_domain, dom);
444    eina_stringshare_replace(&app_checkfile, checkfile);
445 }
446
447 EAPI void
448 elm_app_compile_bin_dir_set(const char *dir)
449 {
450    eina_stringshare_replace(&app_compile_bin_dir, dir);
451 }
452
453 EAPI void
454 elm_app_compile_lib_dir_set(const char *dir)
455 {
456    eina_stringshare_replace(&app_compile_lib_dir, dir);
457 }
458
459 EAPI void
460 elm_app_compile_data_dir_set(const char *dir)
461 {
462    eina_stringshare_replace(&app_compile_data_dir, dir);
463 }
464
465 EAPI void
466 elm_app_compile_locale_set(const char *dir)
467 {
468    eina_stringshare_replace(&app_compile_locale_dir, dir);
469 }
470
471 EAPI const char *
472 elm_app_prefix_dir_get(void)
473 {
474    if (app_prefix_dir) return app_prefix_dir;
475    _prefix_check();
476   if (!app_pfx) return "";
477    app_prefix_dir = eina_prefix_get(app_pfx);
478    return app_prefix_dir;
479 }
480
481 EAPI const char *
482 elm_app_bin_dir_get(void)
483 {
484    if (app_bin_dir) return app_bin_dir;
485    _prefix_check();
486    if (!app_pfx) return "";
487    app_bin_dir = eina_prefix_bin_get(app_pfx);
488    return app_bin_dir;
489 }
490
491 EAPI const char *
492 elm_app_lib_dir_get(void)
493 {
494    if (app_lib_dir) return app_lib_dir;
495    _prefix_check();
496    if (!app_pfx) return "";
497    app_lib_dir = eina_prefix_lib_get(app_pfx);
498    return app_lib_dir;
499 }
500
501 EAPI const char *
502 elm_app_data_dir_get(void)
503 {
504    if (app_data_dir) return app_data_dir;
505    _prefix_check();
506    if (!app_pfx) return "";
507    app_data_dir = eina_prefix_data_get(app_pfx);
508    return app_data_dir;
509 }
510
511 EAPI const char *
512 elm_app_locale_dir_get(void)
513 {
514    if (app_locale_dir) return app_locale_dir;
515    _prefix_check();
516    if (!app_pfx) return "";
517    app_locale_dir = eina_prefix_locale_get(app_pfx);
518    return app_locale_dir;
519 }
520
521 #ifdef ELM_EDBUS
522 static int _elm_need_e_dbus = 0;
523 #endif
524 EAPI Eina_Bool
525 elm_need_e_dbus(void)
526 {
527 #ifdef ELM_EDBUS
528    if (_elm_need_e_dbus++) return EINA_TRUE;
529    e_dbus_init();
530    return EINA_TRUE;
531 #else
532    return EINA_FALSE;
533 #endif
534 }
535
536 static void
537 _elm_unneed_e_dbus(void)
538 {
539 #ifdef ELM_EDBUS
540    if (--_elm_need_e_dbus) return;
541
542    _elm_need_e_dbus = 0;
543    e_dbus_shutdown();
544 #endif
545 }
546
547 #ifdef ELM_EFREET
548 static int _elm_need_efreet = 0;
549 #endif
550 EAPI Eina_Bool
551 elm_need_efreet(void)
552 {
553 #ifdef ELM_EFREET
554    if (_elm_need_efreet++) return EINA_TRUE;
555    efreet_init();
556    efreet_mime_init();
557    efreet_trash_init();
558     /*
559      {
560         Eina_List **list;
561
562         list = efreet_icon_extra_list_get();
563         if (list)
564           {
565              e_user_dir_concat_static(buf, "icons");
566              *list = eina_list_prepend(*list, (void *)eina_stringshare_add(buf));
567              e_prefix_data_concat_static(buf, "data/icons");
568              *list = eina_list_prepend(*list, (void *)eina_stringshare_add(buf));
569           }
570      }
571    */
572    return EINA_TRUE;
573 #else
574    return EINA_FALSE;
575 #endif
576 }
577
578 static void
579 _elm_unneed_efreet(void)
580 {
581 #ifdef ELM_EFREET
582    if (--_elm_need_efreet) return;
583
584    _elm_need_efreet = 0;
585    efreet_trash_shutdown();
586    efreet_mime_shutdown();
587    efreet_shutdown();
588 #endif
589 }
590
591 EAPI void
592 elm_quicklaunch_mode_set(Eina_Bool ql_on)
593 {
594    quicklaunch_on = ql_on;
595 }
596
597 EAPI Eina_Bool
598 elm_quicklaunch_mode_get(void)
599 {
600    return quicklaunch_on;
601 }
602
603 EAPI int
604 elm_quicklaunch_init(int    argc,
605                      char **argv)
606 {
607    _elm_ql_init_count++;
608    if (_elm_ql_init_count > 1) return _elm_ql_init_count;
609    eina_init();
610    _elm_log_dom = eina_log_domain_register("elementary", EINA_COLOR_LIGHTBLUE);
611    if (!_elm_log_dom)
612      {
613         EINA_LOG_ERR("could not register elementary log domain.");
614         _elm_log_dom = EINA_LOG_DOMAIN_GLOBAL;
615      }
616
617    eet_init();
618    ecore_init();
619
620 #ifdef HAVE_ELEMENTARY_EMAP
621    emap_init();
622 #endif
623    ecore_app_args_set(argc, (const char **)argv);
624
625    memset(_elm_policies, 0, sizeof(_elm_policies));
626    if (!ELM_EVENT_POLICY_CHANGED)
627      ELM_EVENT_POLICY_CHANGED = ecore_event_type_new();
628
629    ecore_file_init();
630
631    _elm_exit_handler = ecore_event_handler_add(ECORE_EVENT_SIGNAL_EXIT, _elm_signal_exit, NULL);
632
633    if (argv) _elm_appname = strdup(ecore_file_file_get(argv[0]));
634
635    pfx = eina_prefix_new(NULL, elm_quicklaunch_init,
636                          "ELM", "elementary", "config/profile.cfg",
637                          PACKAGE_LIB_DIR, /* don't have a bin dir currently */
638                          PACKAGE_LIB_DIR,
639                          PACKAGE_DATA_DIR,
640                          LOCALE_DIR);
641    if (pfx)
642      {
643         _elm_data_dir = eina_stringshare_add(eina_prefix_data_get(pfx));
644         _elm_lib_dir = eina_stringshare_add(eina_prefix_lib_get(pfx));
645      }
646    if (!_elm_data_dir) _elm_data_dir = eina_stringshare_add("/");
647    if (!_elm_lib_dir) _elm_lib_dir = eina_stringshare_add("/");
648
649    _elm_config_init();
650    return _elm_ql_init_count;
651 }
652
653 EAPI int
654 elm_quicklaunch_sub_init(int    argc,
655                          char **argv)
656 {
657    _elm_sub_init_count++;
658    if (_elm_sub_init_count > 1) return _elm_sub_init_count;
659    if (quicklaunch_on)
660      {
661 #ifdef SEMI_BROKEN_QUICKLAUNCH
662         return _elm_sub_init_count;
663 #endif
664      }
665    if (!quicklaunch_on)
666      {
667         ecore_app_args_set(argc, (const char **)argv);
668         evas_init();
669         edje_init();
670         _elm_module_init();
671         _elm_config_sub_init();
672 #define ENGINE_COMPARE(name) (!strcmp(_elm_config->engine, name))
673         if (ENGINE_COMPARE(ELM_SOFTWARE_X11) ||
674             ENGINE_COMPARE(ELM_SOFTWARE_16_X11) ||
675             ENGINE_COMPARE(ELM_XRENDER_X11) ||
676             ENGINE_COMPARE(ELM_OPENGL_X11))
677 #undef ENGINE_COMPARE
678           {
679 #ifdef HAVE_ELEMENTARY_X
680              ecore_x_init(NULL);
681 #endif
682           }
683         ecore_evas_init(); // FIXME: check errors
684         ecore_imf_init();
685      }
686    return _elm_sub_init_count;
687 }
688
689 EAPI int
690 elm_quicklaunch_sub_shutdown(void)
691 {
692    _elm_sub_init_count--;
693    if (_elm_sub_init_count > 0) return _elm_sub_init_count;
694    if (quicklaunch_on)
695      {
696 #ifdef SEMI_BROKEN_QUICKLAUNCH
697         return _elm_sub_init_count;
698 #endif
699      }
700    if (!quicklaunch_on)
701      {
702         _elm_win_shutdown();
703         _elm_module_shutdown();
704         ecore_imf_shutdown();
705         ecore_evas_shutdown();
706 #define ENGINE_COMPARE(name) (!strcmp(_elm_config->engine, name))
707         if (ENGINE_COMPARE(ELM_SOFTWARE_X11) ||
708             ENGINE_COMPARE(ELM_SOFTWARE_16_X11) ||
709             ENGINE_COMPARE(ELM_XRENDER_X11) ||
710             ENGINE_COMPARE(ELM_OPENGL_X11))
711 #undef ENGINE_COMPARE
712           {
713 #ifdef HAVE_ELEMENTARY_X
714              ecore_x_disconnect();
715 #endif
716           }
717 #define ENGINE_COMPARE(name) (!strcmp(_elm_config->engine, name))
718         if (ENGINE_COMPARE(ELM_SOFTWARE_X11) ||
719             ENGINE_COMPARE(ELM_SOFTWARE_16_X11) ||
720             ENGINE_COMPARE(ELM_XRENDER_X11) ||
721             ENGINE_COMPARE(ELM_OPENGL_X11) ||
722             ENGINE_COMPARE(ELM_SOFTWARE_SDL) ||
723             ENGINE_COMPARE(ELM_SOFTWARE_16_SDL) ||
724             ENGINE_COMPARE(ELM_OPENGL_SDL) ||
725             ENGINE_COMPARE(ELM_SOFTWARE_WIN32) ||
726             ENGINE_COMPARE(ELM_SOFTWARE_16_WINCE))
727 #undef ENGINE_COMPARE
728           evas_cserve_disconnect();
729         edje_shutdown();
730         evas_shutdown();
731      }
732    return _elm_sub_init_count;
733 }
734
735 EAPI int
736 elm_quicklaunch_shutdown(void)
737 {
738    _elm_ql_init_count--;
739    if (_elm_ql_init_count > 0) return _elm_ql_init_count;
740    if (pfx) eina_prefix_free(pfx);
741    pfx = NULL;
742    eina_stringshare_del(_elm_data_dir);
743    _elm_data_dir = NULL;
744    eina_stringshare_del(_elm_lib_dir);
745    _elm_lib_dir = NULL;
746
747    free(_elm_appname);
748    _elm_appname = NULL;
749
750    _elm_config_shutdown();
751
752    ecore_event_handler_del(_elm_exit_handler);
753    _elm_exit_handler = NULL;
754
755    _elm_theme_shutdown();
756    _elm_unneed_efreet();
757    _elm_unneed_e_dbus();
758    _elm_unneed_ethumb();
759    ecore_file_shutdown();
760
761 #ifdef HAVE_ELEMENTARY_EMAP
762    emap_shutdown();
763 #endif
764
765    ecore_shutdown();
766    eet_shutdown();
767
768    if ((_elm_log_dom > -1) && (_elm_log_dom != EINA_LOG_DOMAIN_GLOBAL))
769      {
770         eina_log_domain_unregister(_elm_log_dom);
771         _elm_log_dom = -1;
772      }
773
774    _elm_widget_type_clear();
775
776    eina_shutdown();
777    return _elm_ql_init_count;
778 }
779
780 EAPI void
781 elm_quicklaunch_seed(void)
782 {
783 #ifndef SEMI_BROKEN_QUICKLAUNCH
784    if (quicklaunch_on)
785      {
786         Evas_Object *win, *bg, *bt;
787
788         win = elm_win_add(NULL, "seed", ELM_WIN_BASIC);
789         bg = elm_bg_add(win);
790         elm_win_resize_object_add(win, bg);
791         evas_object_show(bg);
792         bt = elm_button_add(win);
793         elm_button_label_set(bt, " abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~-_=+\\|]}[{;:'\",<.>/?");
794         elm_win_resize_object_add(win, bt);
795         ecore_main_loop_iterate();
796         evas_object_del(win);
797         ecore_main_loop_iterate();
798 #define ENGINE_COMPARE(name) (!strcmp(_elm_config->engine, name))
799         if (ENGINE_COMPARE(ELM_SOFTWARE_X11) ||
800             ENGINE_COMPARE(ELM_SOFTWARE_16_X11) ||
801             ENGINE_COMPARE(ELM_XRENDER_X11) ||
802             ENGINE_COMPARE(ELM_OPENGL_X11))
803 #undef ENGINE_COMPARE
804           {
805 # ifdef HAVE_ELEMENTARY_X
806              ecore_x_sync();
807 # endif
808           }
809         ecore_main_loop_iterate();
810      }
811 #endif
812 }
813
814 static void *qr_handle = NULL;
815 static int (*qr_main)(int    argc,
816                       char **argv) = NULL;
817
818 EAPI Eina_Bool
819 elm_quicklaunch_prepare(int argc __UNUSED__,
820                         char   **argv)
821 {
822 #ifdef HAVE_FORK
823    char *exe = elm_quicklaunch_exe_path_get(argv[0]);
824    if (!exe)
825      {
826         ERR("requested quicklaunch binary '%s' does not exist\n", argv[0]);
827         return EINA_FALSE;
828      }
829    else
830      {
831         char *exe2, *p;
832         char *exename;
833
834         exe2 = malloc(strlen(exe) + 1 + 10);
835         strcpy(exe2, exe);
836         p = strrchr(exe2, '/');
837         if (p) p++;
838         else p = exe2;
839         exename = alloca(strlen(p) + 1);
840         strcpy(exename, p);
841         *p = 0;
842         strcat(p, "../lib/");
843         strcat(p, exename);
844         strcat(p, ".so");
845         if (!access(exe2, R_OK | X_OK))
846           {
847              free(exe);
848              exe = exe2;
849           }
850         else
851           free(exe2);
852      }
853    qr_handle = dlopen(exe, RTLD_NOW | RTLD_GLOBAL);
854    if (!qr_handle)
855      {
856         fprintf(stderr, "dlerr: %s\n", dlerror());
857         WRN("dlopen('%s') failed: %s", exe, dlerror());
858         free(exe);
859         return EINA_FALSE;
860      }
861    INF("dlopen('%s') = %p", exe, qr_handle);
862    qr_main = dlsym(qr_handle, "elm_main");
863    INF("dlsym(%p, 'elm_main') = %p", qr_handle, qr_main);
864    if (!qr_main)
865      {
866         WRN("not quicklauncher capable: no elm_main in '%s'", exe);
867         dlclose(qr_handle);
868         qr_handle = NULL;
869         free(exe);
870         return EINA_FALSE;
871      }
872    free(exe);
873    return EINA_TRUE;
874 #else
875    return EINA_FALSE;
876    (void)argv;
877 #endif
878 }
879
880 #ifdef HAVE_FORK
881 static void
882 save_env(void)
883 {
884    int i, size;
885    extern char **environ;
886    char **oldenv, **p;
887
888    oldenv = environ;
889
890    for (i = 0, size = 0; environ[i]; i++)
891      size += strlen(environ[i]) + 1;
892
893    p = malloc((i + 1) * sizeof(char *));
894    if (!p) return;
895
896    environ = p;
897
898    for (i = 0; oldenv[i]; i++)
899      environ[i] = strdup(oldenv[i]);
900    environ[i] = NULL;
901 }
902
903 #endif
904
905 EAPI Eina_Bool
906 elm_quicklaunch_fork(int    argc,
907                      char **argv,
908                      char  *cwd,
909                      void (postfork_func) (void *data),
910                      void  *postfork_data)
911 {
912 #ifdef HAVE_FORK
913    pid_t child;
914    int ret;
915    int real_argc;
916    char **real_argv;
917
918    // FIXME:
919    // need to accept current environment from elementary_run
920    if (!qr_main)
921      {
922         int i;
923         char **args;
924
925         child = fork();
926         if (child > 0) return EINA_TRUE;
927         else if (child < 0)
928           {
929              perror("could not fork");
930              return EINA_FALSE;
931           }
932         setsid();
933         if (chdir(cwd) != 0)
934           perror("could not chdir");
935         args = alloca((argc + 1) * sizeof(char *));
936         for (i = 0; i < argc; i++) args[i] = argv[i];
937         args[argc] = NULL;
938         WRN("%s not quicklaunch capable, fallback...", argv[0]);
939         execvp(argv[0], args);
940         ERR("failed to execute '%s': %s", argv[0], strerror(errno));
941         exit(-1);
942      }
943    child = fork();
944    if (child > 0) return EINA_TRUE;
945    else if (child < 0)
946      {
947         perror("could not fork");
948         return EINA_FALSE;
949      }
950    if (postfork_func) postfork_func(postfork_data);
951
952    if (quicklaunch_on)
953      {
954 #ifdef SEMI_BROKEN_QUICKLAUNCH
955         ecore_app_args_set(argc, (const char **)argv);
956         evas_init();
957         edje_init();
958         _elm_config_sub_init();
959 #define ENGINE_COMPARE(name) (!strcmp(_elm_config->engine, name))
960         if (ENGINE_COMPARE(ELM_SOFTWARE_X11) ||
961             ENGINE_COMPARE(ELM_SOFTWARE_16_X11) ||
962             ENGINE_COMPARE(ELM_XRENDER_X11) ||
963             ENGINE_COMPARE(ELM_OPENGL_X11))
964 #undef ENGINE_COMPARE
965           {
966 # ifdef HAVE_ELEMENTARY_X
967              ecore_x_init(NULL);
968 # endif
969           }
970         ecore_evas_init(); // FIXME: check errors
971         ecore_imf_init();
972         _elm_module_init();
973 #endif
974      }
975
976    setsid();
977    if (chdir(cwd) != 0)
978      perror("could not chdir");
979    // FIXME: this is very linux specific. it changes argv[0] of the process
980    // so ps etc. report what you'd expect. for other unixes and os's this
981    // may just not work
982    save_env();
983    if (argv)
984      {
985         char *lastarg, *p;
986
987         ecore_app_args_get(&real_argc, &real_argv);
988         lastarg = real_argv[real_argc - 1] + strlen(real_argv[real_argc - 1]);
989         for (p = real_argv[0]; p < lastarg; p++) *p = 0;
990         strcpy(real_argv[0], argv[0]);
991      }
992    ecore_app_args_set(argc, (const char **)argv);
993    ret = qr_main(argc, argv);
994    exit(ret);
995    return EINA_TRUE;
996 #else
997    return EINA_FALSE;
998    (void)argc;
999    (void)argv;
1000    (void)cwd;
1001    (void)postfork_func;
1002    (void)postfork_data;
1003 #endif
1004 }
1005
1006 EAPI void
1007 elm_quicklaunch_cleanup(void)
1008 {
1009 #ifdef HAVE_FORK
1010    if (qr_handle)
1011      {
1012         dlclose(qr_handle);
1013         qr_handle = NULL;
1014         qr_main = NULL;
1015      }
1016 #endif
1017 }
1018
1019 EAPI int
1020 elm_quicklaunch_fallback(int    argc,
1021                          char **argv)
1022 {
1023    int ret;
1024    elm_quicklaunch_init(argc, argv);
1025    elm_quicklaunch_sub_init(argc, argv);
1026    elm_quicklaunch_prepare(argc, argv);
1027    ret = qr_main(argc, argv);
1028    exit(ret);
1029    return ret;
1030 }
1031
1032 EAPI char *
1033 elm_quicklaunch_exe_path_get(const char *exe)
1034 {
1035    static char *path = NULL;
1036    static Eina_List *pathlist = NULL;
1037    const char *pathitr;
1038    const Eina_List *l;
1039    char buf[PATH_MAX];
1040    if (exe[0] == '/') return strdup(exe);
1041    if ((exe[0] == '.') && (exe[1] == '/')) return strdup(exe);
1042    if ((exe[0] == '.') && (exe[1] == '.') && (exe[2] == '/')) return strdup(exe);
1043    if (!path)
1044      {
1045         const char *p, *pp;
1046         char *buf2;
1047         path = getenv("PATH");
1048         buf2 = alloca(strlen(path) + 1);
1049         p = path;
1050         pp = p;
1051         for (;; )
1052           {
1053              if ((*p == ':') || (!*p))
1054                {
1055                   int len;
1056
1057                   len = p - pp;
1058                   strncpy(buf2, pp, len);
1059                   buf2[len] = 0;
1060                   pathlist = eina_list_append(pathlist, eina_stringshare_add(buf2));
1061                   if (!*p) break;
1062                   p++;
1063                   pp = p;
1064                }
1065              else
1066                {
1067                   if (!*p) break;
1068                   p++;
1069                }
1070           }
1071      }
1072    EINA_LIST_FOREACH(pathlist, l, pathitr)
1073      {
1074         snprintf(buf, sizeof(buf), "%s/%s", pathitr, exe);
1075         if (!access(buf, R_OK | X_OK)) return strdup(buf);
1076      }
1077    return NULL;
1078 }
1079
1080 EAPI void
1081 elm_run(void)
1082 {
1083    ecore_main_loop_begin();
1084 }
1085
1086 EAPI void
1087 elm_exit(void)
1088 {
1089    ecore_main_loop_quit();
1090 }
1091
1092 EAPI Eina_Bool
1093 elm_policy_set(unsigned int policy,
1094                int          value)
1095 {
1096    Elm_Event_Policy_Changed *ev;
1097
1098    if (policy >= ELM_POLICY_LAST)
1099      return EINA_FALSE;
1100
1101    if (value == _elm_policies[policy])
1102      return EINA_TRUE;
1103
1104    /* TODO: validade policy? */
1105
1106    ev = malloc(sizeof(*ev));
1107    ev->policy = policy;
1108    ev->new_value = value;
1109    ev->old_value = _elm_policies[policy];
1110
1111    _elm_policies[policy] = value;
1112
1113    ecore_event_add(ELM_EVENT_POLICY_CHANGED, ev, NULL, NULL);
1114
1115    return EINA_TRUE;
1116 }
1117
1118 EAPI int
1119 elm_policy_get(unsigned int policy)
1120 {
1121    if (policy >= ELM_POLICY_LAST)
1122      return 0;
1123    return _elm_policies[policy];
1124 }
1125
1126 /**
1127  * @defgroup UI-Mirroring Selective Widget mirroring
1128  *
1129  * These functions allow you to set ui-mirroring on specific widgets or the
1130  * whole interface. Widgets can be in one of two modes, automatic and manual.
1131  * Automatic means they'll be changed according to the system mirroring mode
1132  * and manual means only explicit changes will matter. You are not supposed to
1133  * change mirroring state of a widget set to automatic, will mostly work, but
1134  * the behavior is not really defined.
1135  */
1136
1137 /**
1138  * Returns the widget's mirrored mode.
1139  *
1140  * @param obj The widget.
1141  * @return mirrored mode of the object.
1142  *
1143  **/
1144 EAPI Eina_Bool
1145 elm_object_mirrored_get(const Evas_Object *obj)
1146 {
1147    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
1148    return elm_widget_mirrored_get(obj);
1149 }
1150
1151 /**
1152  * Sets the widget's mirrored mode.
1153  *
1154  * @param obj The widget.
1155  * @param mirrored EINA_TRUE to set mirrored mode. EINA_FALSE to unset.
1156  */
1157 EAPI void
1158 elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored)
1159 {
1160    EINA_SAFETY_ON_NULL_RETURN(obj);
1161    elm_widget_mirrored_set(obj, mirrored);
1162 }
1163
1164 /**
1165  * Returns the widget's mirrored mode setting.
1166  *
1167  * @param obj The widget.
1168  * @return mirrored mode setting of the object.
1169  *
1170  **/
1171 EAPI Eina_Bool
1172 elm_object_mirrored_automatic_get(const Evas_Object *obj)
1173 {
1174    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
1175    return elm_widget_mirrored_automatic_get(obj);
1176 }
1177
1178 /**
1179  * Sets the widget's mirrored mode setting.
1180  * When widget in automatic mode, it follows the system mirrored mode set by
1181  * elm_mirrored_set().
1182  * @param obj The widget.
1183  * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1184  */
1185 EAPI void
1186 elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic)
1187 {
1188    EINA_SAFETY_ON_NULL_RETURN(obj);
1189    elm_widget_mirrored_automatic_set(obj, automatic);
1190 }
1191
1192 EAPI void
1193 elm_object_scale_set(Evas_Object *obj,
1194                      double       scale)
1195 {
1196    EINA_SAFETY_ON_NULL_RETURN(obj);
1197    elm_widget_scale_set(obj, scale);
1198 }
1199
1200 EAPI double
1201 elm_object_scale_get(const Evas_Object *obj)
1202 {
1203    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, 0.0);
1204    return elm_widget_scale_get(obj);
1205 }
1206
1207 EAPI void
1208 elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label)
1209 {
1210    EINA_SAFETY_ON_NULL_RETURN(obj);
1211    elm_widget_text_part_set(obj, item, label);
1212 }
1213
1214 EAPI const char *
1215 elm_object_text_part_get(const Evas_Object *obj, const char *item)
1216 {
1217    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
1218    return elm_widget_text_part_get(obj, item);
1219 }
1220
1221 /**
1222  * Get the global scaling factor
1223  *
1224  * This gets the globally configured scaling factor that is applied to all
1225  * objects.
1226  *
1227  * @return The scaling factor
1228  * @ingroup Scaling
1229  */
1230 EAPI double
1231 elm_scale_get(void)
1232 {
1233    return _elm_config->scale;
1234 }
1235
1236 /**
1237  * Set the global scaling factor
1238  *
1239  * This sets the globally configured scaling factor that is applied to all
1240  * objects.
1241  *
1242  * @param scale The scaling factor to set
1243  * @ingroup Scaling
1244  */
1245 EAPI void
1246 elm_scale_set(double scale)
1247 {
1248    if (_elm_config->scale == scale) return;
1249    _elm_config->scale = scale;
1250    _elm_rescale();
1251 }
1252
1253 /**
1254  * Set the global scaling factor for all applications on the display
1255  *
1256  * This sets the globally configured scaling factor that is applied to all
1257  * objects for all applications.
1258  * @param scale The scaling factor to set
1259  * @ingroup Scaling
1260  */
1261 EAPI void
1262 elm_scale_all_set(double scale)
1263 {
1264 #ifdef HAVE_ELEMENTARY_X
1265    static Ecore_X_Atom atom = 0;
1266    unsigned int scale_i = (unsigned int)(scale * 1000.0);
1267
1268    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_SCALE");
1269    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1270                                   atom, &scale_i, 1);
1271 #endif
1272 }
1273
1274 EAPI void
1275 elm_object_style_set(Evas_Object *obj,
1276                      const char  *style)
1277 {
1278    EINA_SAFETY_ON_NULL_RETURN(obj);
1279    elm_widget_style_set(obj, style);
1280 }
1281
1282 EAPI const char *
1283 elm_object_style_get(const Evas_Object *obj)
1284 {
1285    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
1286    return elm_widget_style_get(obj);
1287 }
1288
1289 EAPI void
1290 elm_object_disabled_set(Evas_Object *obj,
1291                         Eina_Bool    disabled)
1292 {
1293    EINA_SAFETY_ON_NULL_RETURN(obj);
1294    elm_widget_disabled_set(obj, disabled);
1295 }
1296
1297 EAPI Eina_Bool
1298 elm_object_disabled_get(const Evas_Object *obj)
1299 {
1300    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
1301    return elm_widget_disabled_get(obj);
1302 }
1303
1304 /**
1305  * @defgroup Config Elementary Config
1306  * @ingroup Main
1307  *
1308  * Elementary configuration is formed by a set options bounded to a
1309  * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1310  * "finger size", etc. These are functions with which one syncronizes
1311  * changes made to those values to the configuration storing files, de
1312  * facto. You most probably don't want to use the functions in this
1313  * group unlees you're writing an elementary configuration manager.
1314  */
1315
1316 /**
1317  * Save back Elementary's configuration, so that it will persist on
1318  * future sessions.
1319  *
1320  * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1321  * @ingroup Config
1322  *
1323  * This function will take effect -- thus, do I/O -- immediately. Use
1324  * it when you want to apply all configuration changes at once. The
1325  * current configuration set will get saved onto the current profile
1326  * configuration file.
1327  *
1328  */
1329 EAPI Eina_Bool
1330 elm_config_save(void)
1331 {
1332    return _elm_config_save();
1333 }
1334
1335 /**
1336  * Reload Elementary's configuration, bounded to current selected
1337  * profile.
1338  *
1339  * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1340  * @ingroup Config
1341  *
1342  * Useful when you want to force reloading of configuration values for
1343  * a profile. If one removes user custom configuration directories,
1344  * for example, it will force a reload with system values insted.
1345  *
1346  */
1347 EAPI void
1348 elm_config_reload(void)
1349 {
1350    _elm_config_reload();
1351 }
1352
1353 /**
1354  * @defgroup Profile Elementary Profile
1355  * @ingroup Main
1356  *
1357  * Profiles are pre-set options that affect the whole look-and-feel of
1358  * Elementary-based applications. There are, for example, profiles
1359  * aimed at desktop computer applications and others aimed at mobile,
1360  * touchscreen-based ones. You most probably don't want to use the
1361  * functions in this group unlees you're writing an elementary
1362  * configuration manager.
1363  */
1364
1365 /**
1366  * Get Elementary's profile in use.
1367  *
1368  * This gets the global profile that is applied to all Elementary
1369  * applications.
1370  *
1371  * @return The profile's name
1372  * @ingroup Profile
1373  */
1374 EAPI const char *
1375 elm_profile_current_get(void)
1376 {
1377    return _elm_config_current_profile_get();
1378 }
1379
1380 /**
1381  * Get an Elementary's profile directory path in the filesystem. One
1382  * may want to fetch a system profile's dir or an user one (fetched
1383  * inside $HOME).
1384  *
1385  * @param profile The profile's name
1386  * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1387  *                or a system one (@c EINA_FALSE)
1388  * @return The profile's directory path.
1389  * @ingroup Profile
1390  *
1391  * @note You must free it with elm_profile_dir_free().
1392  */
1393 EAPI const char *
1394 elm_profile_dir_get(const char *profile,
1395                     Eina_Bool   is_user)
1396 {
1397    return _elm_config_profile_dir_get(profile, is_user);
1398 }
1399
1400 /**
1401  * Free an Elementary's profile directory path, as returned by
1402  * elm_profile_dir_get().
1403  *
1404  * @param p_dir The profile's path
1405  * @ingroup Profile
1406  *
1407  */
1408 EAPI void
1409 elm_profile_dir_free(const char *p_dir)
1410 {
1411    free((void *)p_dir);
1412 }
1413
1414 /**
1415  * Get Elementary's list of available profiles.
1416  *
1417  * @return The profiles list. List node data are the profile name
1418  *         strings.
1419  * @ingroup Profile
1420  *
1421  * @note One must free this list, after usage, with the function
1422  *       elm_profile_list_free().
1423  */
1424 EAPI Eina_List *
1425 elm_profile_list_get(void)
1426 {
1427    return _elm_config_profiles_list();
1428 }
1429
1430 /**
1431  * Free Elementary's list of available profiles.
1432  *
1433  * @param The profiles list, as returned by elm_profile_list_get().
1434  * @ingroup Profile
1435  *
1436  */
1437 EAPI void
1438 elm_profile_list_free(Eina_List *l)
1439 {
1440    const char *dir;
1441
1442    EINA_LIST_FREE(l, dir)
1443      eina_stringshare_del(dir);
1444 }
1445
1446 /**
1447  * Set Elementary's profile.
1448  *
1449  * This sets the global profile that is applied to Elementary
1450  * applications. Just the process the call comes from will be
1451  * affected.
1452  *
1453  * @param profile The profile's name
1454  * @ingroup Profile
1455  *
1456  */
1457 EAPI void
1458 elm_profile_set(const char *profile)
1459 {
1460    EINA_SAFETY_ON_NULL_RETURN(profile);
1461    _elm_config_profile_set(profile);
1462 }
1463
1464 /**
1465  * Set Elementary's profile.
1466  *
1467  * This sets the global profile that is applied to all Elementary
1468  * applications. All running Elementary windows will be affected.
1469  *
1470  * @param profile The profile's name
1471  * @ingroup Profile
1472  *
1473  */
1474 EAPI void
1475 elm_profile_all_set(const char *profile)
1476 {
1477 #ifdef HAVE_ELEMENTARY_X
1478    static Ecore_X_Atom atom = 0;
1479
1480    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_PROFILE");
1481    ecore_x_window_prop_string_set(ecore_x_window_root_first_get(),
1482                                   atom, profile);
1483 #endif
1484 }
1485
1486 /**
1487  * @defgroup Engine Elementary Engine
1488  * @ingroup Main
1489  *
1490  * These are functions setting and querying which rendering engine
1491  * Elementary will use for drawing its windows' pixels.
1492  */
1493
1494 /**
1495  * Get Elementary's rendering engine in use.
1496  *
1497  * This gets the global rendering engine that is applied to all
1498  * Elementary applications.
1499  *
1500  * @return The rendering engine's name
1501  * @ingroup Engine
1502  *
1503  * @note there's no need to free the returned string, here.
1504  */
1505 EAPI const char *
1506 elm_engine_current_get(void)
1507 {
1508    return _elm_config->engine;
1509 }
1510
1511 /**
1512  * Set Elementary's rendering engine for use.
1513  *
1514  * This gets sets global rendering engine that is applied to all
1515  * Elementary applications. Note that it will take effect only to
1516  * subsequent Elementary window creations.
1517  *
1518  * @param The rendering engine's name
1519  * @ingroup Engine
1520  *
1521  * @note there's no need to free the returned string, here.
1522  */
1523 EAPI void
1524 elm_engine_set(const char *engine)
1525 {
1526    EINA_SAFETY_ON_NULL_RETURN(engine);
1527
1528    _elm_config_engine_set(engine);
1529 }
1530
1531 /**
1532  * @defgroup Fonts Elementary Fonts
1533  * @ingroup Main
1534  *
1535  * These are functions dealing with font rendering, selection and the
1536  * like for Elementary applications. One might fetch which system
1537  * fonts are there to use and set custom fonts for individual classes
1538  * of UI items containing text (text classes).
1539  */
1540
1541 /**
1542  * Get Elementary's list of supported text classes.
1543  *
1544  * @return The text classes list, with @c Elm_Text_Class blobs as data.
1545  * @ingroup Fonts
1546  *
1547  * Release the list with elm_text_classes_list_free().
1548  */
1549 EAPI const Eina_List *
1550 elm_text_classes_list_get(void)
1551 {
1552    return _elm_config_text_classes_get();
1553 }
1554
1555 /**
1556  * Free Elementary's list of supported text classes.
1557  *
1558  * @ingroup Fonts
1559  *
1560  * @see elm_text_classes_list_get().
1561  */
1562 EAPI void
1563 elm_text_classes_list_free(const Eina_List *list)
1564 {
1565    _elm_config_text_classes_free((Eina_List *)list);
1566 }
1567
1568 /**
1569  * Get Elementary's list of font overlays, set with
1570  * elm_font_overlay_set().
1571  *
1572  * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1573  * data.
1574  *
1575  * @ingroup Fonts
1576  *
1577  * For each text class, one can set a <b>font overlay</b> for it,
1578  * overriding the default font properties for that class coming from
1579  * the theme in use. There is no need to free this list.
1580  *
1581  * @see elm_font_overlay_set() and elm_font_overlay_unset().
1582  */
1583 EAPI const Eina_List *
1584 elm_font_overlay_list_get(void)
1585 {
1586    return _elm_config_font_overlays_list();
1587 }
1588
1589 /**
1590  * Set a font overlay for a given Elementary text class.
1591  *
1592  * @param text_class Text class name
1593  * @param font Font name and style string
1594  * @param size Font size
1595  *
1596  * @ingroup Fonts
1597  *
1598  * @p font has to be in the format returned by
1599  * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1600  * and @elm_font_overlay_unset().
1601  */
1602 EAPI void
1603 elm_font_overlay_set(const char    *text_class,
1604                      const char    *font,
1605                      Evas_Font_Size size)
1606 {
1607    _elm_config_font_overlay_set(text_class, font, size);
1608 }
1609
1610 /**
1611  * Unset a font overlay for a given Elementary text class.
1612  *
1613  * @param text_class Text class name
1614  *
1615  * @ingroup Fonts
1616  *
1617  * This will bring back text elements belonging to text class @p
1618  * text_class back to their default font settings.
1619  */
1620 EAPI void
1621 elm_font_overlay_unset(const char *text_class)
1622 {
1623    _elm_config_font_overlay_remove(text_class);
1624 }
1625
1626 /**
1627  * Apply the changes made with elm_font_overlay_set() and
1628  * elm_font_overlay_unset() on the current Elementary window.
1629  *
1630  * @ingroup Fonts
1631  *
1632  * This applies all font overlays set to all objects in the UI.
1633  */
1634 EAPI void
1635 elm_font_overlay_apply(void)
1636 {
1637    _elm_config_font_overlay_apply();
1638 }
1639
1640 /**
1641  * Apply the changes made with elm_font_overlay_set() and
1642  * elm_font_overlay_unset() on all Elementary application windows.
1643  *
1644  * @ingroup Fonts
1645  *
1646  * This applies all font overlays set to all objects in the UI.
1647  */
1648 EAPI void
1649 elm_font_overlay_all_apply(void)
1650 {
1651 #ifdef HAVE_ELEMENTARY_X
1652    static Ecore_X_Atom atom = 0;
1653    unsigned int dummy = (unsigned int)(1 * 1000.0);
1654
1655    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FONT_OVERLAY");
1656    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(), atom, &dummy,
1657                                   1);
1658 #endif
1659 }
1660
1661 /**
1662  * Translate a font (family) name string in fontconfig's font names
1663  * syntax into an @c Elm_Font_Properties struct.
1664  *
1665  * @param font The font name and styles string
1666  * @return the font properties struct
1667  *
1668  * @ingroup Fonts
1669  *
1670  * @note The reverse translation can be achived with
1671  * elm_font_fontconfig_name_get(), for one style only (single font
1672  * instance, not family).
1673  */
1674 EAPI Elm_Font_Properties *
1675 elm_font_properties_get(const char *font)
1676 {
1677    EINA_SAFETY_ON_NULL_RETURN_VAL(font, NULL);
1678    return _elm_font_properties_get(NULL, font);
1679 }
1680
1681 /**
1682  * Free font properties return by elm_font_properties_get().
1683  *
1684  * @param efp the font properties struct
1685  *
1686  * @ingroup Fonts
1687  */
1688 EAPI void
1689 elm_font_properties_free(Elm_Font_Properties *efp)
1690 {
1691    const char *str;
1692
1693    EINA_SAFETY_ON_NULL_RETURN(efp);
1694    EINA_LIST_FREE(efp->styles, str)
1695      if (str) eina_stringshare_del(str);
1696    if (efp->name) eina_stringshare_del(efp->name);
1697    free(efp);
1698 }
1699
1700 /**
1701  * Translate a font name, bound to a style, into fontconfig's font names
1702  * syntax.
1703  *
1704  * @param name The font (family) name
1705  * @param style The given style (may be @c NULL)
1706  *
1707  * @return the font name and style string
1708  *
1709  * @ingroup Fonts
1710  *
1711  * @note The reverse translation can be achived with
1712  * elm_font_properties_get(), for one style only (single font
1713  * instance, not family).
1714  */
1715 EAPI const char *
1716 elm_font_fontconfig_name_get(const char *name,
1717                              const char *style)
1718 {
1719    char buf[256];
1720
1721    EINA_SAFETY_ON_NULL_RETURN_VAL(name, NULL);
1722    if (!style || style[0] == 0) return eina_stringshare_add(name);
1723    snprintf(buf, 256, "%s" ELM_FONT_TOKEN_STYLE "%s", name, style);
1724    return eina_stringshare_add(buf);
1725 }
1726
1727 /**
1728  * Free the font string return by elm_font_fontconfig_name_get().
1729  *
1730  * @param efp the font properties struct
1731  *
1732  * @ingroup Fonts
1733  */
1734 EAPI void
1735 elm_font_fontconfig_name_free(const char *name)
1736 {
1737    eina_stringshare_del(name);
1738 }
1739
1740 /**
1741  * Create a font hash table of available system fonts.
1742  *
1743  * One must call it with @p list being the return value of
1744  * evas_font_available_list(). The hash will be indexed by font
1745  * (family) names, being its values @c Elm_Font_Properties blobs.
1746  *
1747  * @param list The list of available system fonts, as returned by
1748  * evas_font_available_list().
1749  * @return the font hash.
1750  *
1751  * @ingroup Fonts
1752  *
1753  * @note The user is supposed to get it populated at least with 3
1754  * default font families (Sans, Serif, Monospace), which should be
1755  * present on most systems.
1756  */
1757 EAPI Eina_Hash *
1758 elm_font_available_hash_add(Eina_List *list)
1759 {
1760    Eina_Hash *font_hash;
1761    Eina_List *l;
1762    void *key;
1763
1764    font_hash = NULL;
1765
1766    /* populate with default font families */
1767    font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Regular");
1768    font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Bold");
1769    font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Oblique");
1770    font_hash = _elm_font_available_hash_add(font_hash,
1771                                             "Sans:style=Bold Oblique");
1772
1773    font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Regular");
1774    font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Bold");
1775    font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Oblique");
1776    font_hash = _elm_font_available_hash_add(font_hash,
1777                                             "Serif:style=Bold Oblique");
1778
1779    font_hash = _elm_font_available_hash_add(font_hash,
1780                                             "Monospace:style=Regular");
1781    font_hash = _elm_font_available_hash_add(font_hash,
1782                                             "Monospace:style=Bold");
1783    font_hash = _elm_font_available_hash_add(font_hash,
1784                                             "Monospace:style=Oblique");
1785    font_hash = _elm_font_available_hash_add(font_hash,
1786                                             "Monospace:style=Bold Oblique");
1787
1788    EINA_LIST_FOREACH(list, l, key)
1789      font_hash = _elm_font_available_hash_add(font_hash, key);
1790
1791    return font_hash;
1792 }
1793
1794 /**
1795  * Free the hash return by elm_font_available_hash_add().
1796  *
1797  * @param hash the hash to be freed.
1798  *
1799  * @ingroup Fonts
1800  */
1801 EAPI void
1802 elm_font_available_hash_del(Eina_Hash *hash)
1803 {
1804    _elm_font_available_hash_del(hash);
1805 }
1806
1807 EAPI Evas_Coord
1808 elm_finger_size_get(void)
1809 {
1810    return _elm_config->finger_size;
1811 }
1812
1813 /**
1814  * Set the configured finger size
1815  *
1816  * This sets the globally configured finger size in pixels
1817  *
1818  * @param size The finger size
1819  * @ingroup Fingers
1820  */
1821 EAPI void
1822 elm_finger_size_set(Evas_Coord size)
1823 {
1824    if (_elm_config->finger_size == size) return;
1825    _elm_config->finger_size = size;
1826    _elm_rescale();
1827 }
1828
1829 /**
1830  * Set the configured finger size for all applications on the display
1831  *
1832  * This sets the globally configured finger size in pixels for all applications
1833  * on the display
1834  *
1835  * @param size The finger size
1836  * @ingroup Fingers
1837  */
1838 EAPI void
1839 elm_finger_size_all_set(Evas_Coord size)
1840 {
1841 #ifdef HAVE_ELEMENTARY_X
1842    static Ecore_X_Atom atom = 0;
1843    unsigned int size_i = (unsigned int)size;
1844
1845    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FINGER_SIZE");
1846    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1847                                   atom, &size_i, 1);
1848 #endif
1849 }
1850
1851 EAPI void
1852 elm_autocapitalization_allow_all_set(Eina_Bool on)
1853 {
1854 #ifdef HAVE_ELEMENTARY_X
1855    static Ecore_X_Atom atom = 0;
1856    unsigned int on_i = (unsigned int)on;
1857
1858    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_AUTOCAPITAL_ALLOW");
1859    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1860                                   atom, &on_i, 1);
1861
1862 EAPI void
1863 elm_autoperiod_allow_all_set(Eina_Bool on)
1864 {
1865 #ifdef HAVE_ELEMENTARY_X
1866    static Ecore_X_Atom atom = 0;
1867    unsigned int on_i = (unsigned int)on;
1868
1869    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_AUTOPERIOD_ALLOW");
1870    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1871                                   atom, &on_i, 1);
1872 #endif
1873 }
1874 /**
1875  * Adjust size of an element for finger usage
1876  *
1877  * This takes width and height sizes (in pixels) as input and a size multiple
1878  * (which is how many fingers you want to place within the area), and adjusts
1879  * the size tobe large enough to accommodate finger. On return the w and h
1880  * sizes poiner do by these parameters will be modified.
1881  *
1882  * @param times_w How many fingers should fit horizontally
1883  * @param w Pointer to the width size to adjust
1884  * @param times_h How many fingers should fit vertically
1885  * @param h Pointer to the height size to adjust
1886  * @ingroup Fingers
1887  */
1888 EAPI void
1889 elm_coords_finger_size_adjust(int         times_w,
1890                               Evas_Coord *w,
1891                               int         times_h,
1892                               Evas_Coord *h)
1893 {
1894    if ((w) && (*w < (_elm_config->finger_size * times_w)))
1895      *w = _elm_config->finger_size * times_w;
1896    if ((h) && (*h < (_elm_config->finger_size * times_h)))
1897      *h = _elm_config->finger_size * times_h;
1898 }
1899
1900 /**
1901  * @defgroup Caches Caches
1902  * @ingroup Main
1903  *
1904  * These are functions which let one fine-tune some cache values for
1905  * Elementary applications, thus allowing for performance adjustments.
1906  */
1907
1908 /**
1909  * Flush all caches & dump all data that can be to lean down to use
1910  * less memory
1911  *
1912  * @ingroup Caches
1913  */
1914 EAPI void
1915 elm_all_flush(void)
1916 {
1917    const Eina_List *l;
1918    Evas_Object *obj;
1919
1920    edje_file_cache_flush();
1921    edje_collection_cache_flush();
1922    eet_clearcache();
1923    EINA_LIST_FOREACH(_elm_win_list, l, obj)
1924      {
1925         Evas *e = evas_object_evas_get(obj);
1926         evas_image_cache_flush(e);
1927         evas_font_cache_flush(e);
1928         evas_render_dump(e);
1929      }
1930 }
1931
1932 /**
1933  * Get the configured cache flush interval time
1934  *
1935  * This gets the globally configured cache flush interval time, in
1936  * ticks
1937  *
1938  * @return The cache flush interval time
1939  * @ingroup Caches
1940  *
1941  * @see elm_all_flush()
1942  */
1943 EAPI int
1944 elm_cache_flush_interval_get(void)
1945 {
1946    return _elm_config->cache_flush_poll_interval;
1947 }
1948
1949 /**
1950  * Set the configured cache flush interval time
1951  *
1952  * This sets the globally configured cache flush interval time, in ticks
1953  *
1954  * @param size The cache flush interval time
1955  * @ingroup Caches
1956  *
1957  * @see elm_all_flush()
1958  */
1959 EAPI void
1960 elm_cache_flush_interval_set(int size)
1961 {
1962    if (_elm_config->cache_flush_poll_interval == size) return;
1963    _elm_config->cache_flush_poll_interval = size;
1964
1965    _elm_recache();
1966 }
1967
1968 /**
1969  * Set the configured cache flush interval time for all applications on the
1970  * display
1971  *
1972  * This sets the globally configured cache flush interval time -- in ticks
1973  * -- for all applications on the display.
1974  *
1975  * @param size The cache flush interval time
1976  * @ingroup Caches
1977  */
1978 EAPI void
1979 elm_cache_flush_interval_all_set(int size)
1980 {
1981 #ifdef HAVE_ELEMENTARY_X
1982    static Ecore_X_Atom atom = 0;
1983    unsigned int size_i = (unsigned int)size;
1984
1985    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_CACHE_FLUSH_INTERVAL");
1986    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1987                                   atom, &size_i, 1);
1988 #endif
1989 }
1990
1991 /**
1992  * Get the configured cache flush enabled state
1993  *
1994  * This gets the globally configured cache flush state - if it is enabled
1995  * or not. When cache flushing is enabled, elementary will regularly
1996  * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1997  * memory and allow usage to re-seed caches and data in memory where it
1998  * can do so. An idle application will thus minimise its memory usage as
1999  * data will be freed from memory and not be re-loaded as it is idle and
2000  * not rendering or doing anything graphically right now.
2001  *
2002  * @return The cache flush state
2003  * @ingroup Caches
2004  *
2005  * @see elm_all_flush()
2006  */
2007 EAPI Eina_Bool
2008 elm_cache_flush_enabled_get(void)
2009 {
2010    return _elm_config->cache_flush_enable;
2011 }
2012
2013 /**
2014  * Set the configured cache flush enabled state
2015  *
2016  * This sets the globally configured cache flush enabled state
2017  *
2018  * @param size The cache flush enabled state
2019  * @ingroup Caches
2020  *
2021  * @see elm_all_flush()
2022  */
2023 EAPI void
2024 elm_cache_flush_enabled_set(Eina_Bool enabled)
2025 {
2026    enabled = !!enabled;
2027    if (_elm_config->cache_flush_enable == enabled) return;
2028    _elm_config->cache_flush_enable = enabled;
2029
2030    _elm_recache();
2031 }
2032
2033 /**
2034  * Set the configured cache flush enabled state for all applications on the
2035  * display
2036  *
2037  * This sets the globally configured cache flush enabled state for all
2038  * applications on the display.
2039  *
2040  * @param size The cache flush enabled state
2041  * @ingroup Caches
2042  */
2043 EAPI void
2044 elm_cache_flush_enabled_all_set(Eina_Bool enabled)
2045 {
2046 #ifdef HAVE_ELEMENTARY_X
2047    static Ecore_X_Atom atom = 0;
2048    unsigned int enabled_i = (unsigned int)enabled;
2049
2050    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_CACHE_FLUSH_ENABLE");
2051    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2052                                   atom, &enabled_i, 1);
2053 #endif
2054 }
2055
2056 /**
2057  * Get the configured font cache size
2058  *
2059  * This gets the globally configured font cache size, in bytes
2060  *
2061  * @return The font cache size
2062  * @ingroup Caches
2063  */
2064 EAPI int
2065 elm_font_cache_get(void)
2066 {
2067    return _elm_config->font_cache;
2068 }
2069
2070 /**
2071  * Set the configured font cache size
2072  *
2073  * This sets the globally configured font cache size, in bytes
2074  *
2075  * @param size The font cache size
2076  * @ingroup Caches
2077  */
2078 EAPI void
2079 elm_font_cache_set(int size)
2080 {
2081    if (_elm_config->font_cache == size) return;
2082    _elm_config->font_cache = size;
2083
2084    _elm_recache();
2085 }
2086
2087 /**
2088  * Set the configured font cache size for all applications on the
2089  * display
2090  *
2091  * This sets the globally configured font cache size -- in bytes
2092  * -- for all applications on the display.
2093  *
2094  * @param size The font cache size
2095  * @ingroup Caches
2096  */
2097 EAPI void
2098 elm_font_cache_all_set(int size)
2099 {
2100 #ifdef HAVE_ELEMENTARY_X
2101    static Ecore_X_Atom atom = 0;
2102    unsigned int size_i = (unsigned int)size;
2103
2104    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FONT_CACHE");
2105    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2106                                   atom, &size_i, 1);
2107 #endif
2108 }
2109
2110 /**
2111  * Get the configured image cache size
2112  *
2113  * This gets the globally configured image cache size, in bytes
2114  *
2115  * @return The image cache size
2116  * @ingroup Caches
2117  */
2118 EAPI int
2119 elm_image_cache_get(void)
2120 {
2121    return _elm_config->image_cache;
2122 }
2123
2124 /**
2125  * Set the configured image cache size
2126  *
2127  * This sets the globally configured image cache size, in bytes
2128  *
2129  * @param size The image cache size
2130  * @ingroup Caches
2131  */
2132 EAPI void
2133 elm_image_cache_set(int size)
2134 {
2135    if (_elm_config->image_cache == size) return;
2136    _elm_config->image_cache = size;
2137
2138    _elm_recache();
2139 }
2140
2141 /**
2142  * Set the configured image cache size for all applications on the
2143  * display
2144  *
2145  * This sets the globally configured image cache size -- in bytes
2146  * -- for all applications on the display.
2147  *
2148  * @param size The image cache size
2149  * @ingroup Caches
2150  */
2151 EAPI void
2152 elm_image_cache_all_set(int size)
2153 {
2154 #ifdef HAVE_ELEMENTARY_X
2155    static Ecore_X_Atom atom = 0;
2156    unsigned int size_i = (unsigned int)size;
2157
2158    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_IMAGE_CACHE");
2159    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2160                                   atom, &size_i, 1);
2161 #endif
2162 }
2163
2164 /**
2165  * Get the configured edje file cache size.
2166  *
2167  * This gets the globally configured edje file cache size, in number
2168  * of files.
2169  *
2170  * @return The edje file cache size
2171  * @ingroup Caches
2172  */
2173 EAPI int
2174 elm_edje_file_cache_get(void)
2175 {
2176    return _elm_config->edje_cache;
2177 }
2178
2179 /**
2180  * Set the configured edje file cache size
2181  *
2182  * This sets the globally configured edje file cache size, in number
2183  * of files.
2184  *
2185  * @param size The edje file cache size
2186  * @ingroup Caches
2187  */
2188 EAPI void
2189 elm_edje_file_cache_set(int size)
2190 {
2191    if (_elm_config->edje_cache == size) return;
2192    _elm_config->edje_cache = size;
2193
2194    _elm_recache();
2195 }
2196
2197 /**
2198  * Set the configured edje file cache size for all applications on the
2199  * display
2200  *
2201  * This sets the globally configured edje file cache size -- in number
2202  * of files -- for all applications on the display.
2203  *
2204  * @param size The edje file cache size
2205  * @ingroup Caches
2206  */
2207 EAPI void
2208 elm_edje_file_cache_all_set(int size)
2209 {
2210 #ifdef HAVE_ELEMENTARY_X
2211    static Ecore_X_Atom atom = 0;
2212    unsigned int size_i = (unsigned int)size;
2213
2214    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_EDJE_FILE_CACHE");
2215    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2216                                   atom, &size_i, 1);
2217 #endif
2218 }
2219
2220 /**
2221  * Get the configured edje collections (groups) cache size.
2222  *
2223  * This gets the globally configured edje collections cache size, in
2224  * number of collections.
2225  *
2226  * @return The edje collections cache size
2227  * @ingroup Caches
2228  */
2229 EAPI int
2230 elm_edje_collection_cache_get(void)
2231 {
2232    return _elm_config->edje_collection_cache;
2233 }
2234
2235 /**
2236  * Set the configured edje collections (groups) cache size
2237  *
2238  * This sets the globally configured edje collections cache size, in
2239  * number of collections.
2240  *
2241  * @param size The edje collections cache size
2242  * @ingroup Caches
2243  */
2244 EAPI void
2245 elm_edje_collection_cache_set(int size)
2246 {
2247    if (_elm_config->edje_collection_cache == size) return;
2248    _elm_config->edje_collection_cache = size;
2249
2250    _elm_recache();
2251 }
2252
2253 /**
2254  * Set the configured edje collections (groups) cache size for all
2255  * applications on the display
2256  *
2257  * This sets the globally configured edje collections cache size -- in
2258  * number of collections -- for all applications on the display.
2259  *
2260  * @param size The edje collections cache size
2261  * @ingroup Caches
2262  */
2263 EAPI void
2264 elm_edje_collection_cache_all_set(int size)
2265 {
2266 #ifdef HAVE_ELEMENTARY_X
2267    static Ecore_X_Atom atom = 0;
2268    unsigned int size_i = (unsigned int)size;
2269
2270    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_EDJE_COLLECTION_CACHE");
2271    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2272                                   atom, &size_i, 1);
2273 #endif
2274 }
2275
2276 EAPI Eina_Bool
2277 elm_object_focus_get(const Evas_Object *obj)
2278 {
2279    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
2280    return elm_widget_focus_get(obj);
2281 }
2282
2283 EAPI void
2284 elm_object_focus(Evas_Object *obj)
2285 {
2286    EINA_SAFETY_ON_NULL_RETURN(obj);
2287    if (elm_widget_focus_get(obj))
2288      return;
2289
2290    elm_widget_focus_cycle(obj, ELM_FOCUS_NEXT);
2291 }
2292
2293 EAPI void
2294 elm_object_unfocus(Evas_Object *obj)
2295 {
2296    EINA_SAFETY_ON_NULL_RETURN(obj);
2297    if (!elm_widget_can_focus_get(obj)) return;
2298    elm_widget_focused_object_clear(obj);
2299 }
2300
2301 EAPI void
2302 elm_object_focus_allow_set(Evas_Object *obj,
2303                            Eina_Bool    enable)
2304 {
2305    EINA_SAFETY_ON_NULL_RETURN(obj);
2306    elm_widget_can_focus_set(obj, enable);
2307 }
2308
2309 EAPI Eina_Bool
2310 elm_object_focus_allow_get(const Evas_Object *obj)
2311 {
2312    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
2313    return (elm_widget_can_focus_get(obj)) || (elm_widget_child_can_focus_get(obj));
2314 }
2315
2316 /**
2317  * Set custom focus chain.
2318  *
2319  * This function i set one new and overwrite any previous custom focus chain
2320  * with the list of objects. The previous list will be deleted and this list
2321  * will be managed. After setted, don't modity it.
2322  *
2323  * @note On focus cycle, only will be evaluated children of this container.
2324  *
2325  * @param obj The container object
2326  * @param objs Chain of objects to pass focus
2327  * @ingroup Focus
2328  */
2329 EAPI void
2330 elm_object_focus_custom_chain_set(Evas_Object *obj,
2331                                   Eina_List   *objs)
2332 {
2333    EINA_SAFETY_ON_NULL_RETURN(obj);
2334    elm_widget_focus_custom_chain_set(obj, objs);
2335 }
2336
2337 /**
2338  * Unset custom focus chain
2339  *
2340  * @param obj The container object
2341  * @ingroup Focus
2342  */
2343 EAPI void
2344 elm_object_focus_custom_chain_unset(Evas_Object *obj)
2345 {
2346    EINA_SAFETY_ON_NULL_RETURN(obj);
2347    elm_widget_focus_custom_chain_unset(obj);
2348 }
2349
2350 /**
2351  * Get custom focus chain
2352  *
2353  * @param obj The container object
2354  * @ingroup Focus
2355  */
2356 EAPI const Eina_List *
2357 elm_object_focus_custom_chain_get(const Evas_Object *obj)
2358 {
2359    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
2360    return elm_widget_focus_custom_chain_get(obj);
2361 }
2362
2363 /**
2364  * Append object to custom focus chain.
2365  *
2366  * @note If relative_child equal to NULL or not in custom chain, the object
2367  * will be added in end.
2368  *
2369  * @note On focus cycle, only will be evaluated children of this container.
2370  *
2371  * @param obj The container object
2372  * @param child The child to be added in custom chain
2373  * @param relative_child The relative object to position the child
2374  * @ingroup Focus
2375  */
2376 EAPI void
2377 elm_object_focus_custom_chain_append(Evas_Object *obj,
2378                                      Evas_Object *child,
2379                                      Evas_Object *relative_child)
2380 {
2381    EINA_SAFETY_ON_NULL_RETURN(obj);
2382    EINA_SAFETY_ON_NULL_RETURN(child);
2383    elm_widget_focus_custom_chain_append(obj, child, relative_child);
2384 }
2385
2386 /**
2387  * Prepend object to custom focus chain.
2388  *
2389  * @note If relative_child equal to NULL or not in custom chain, the object
2390  * will be added in begin.
2391  *
2392  * @note On focus cycle, only will be evaluated children of this container.
2393  *
2394  * @param obj The container object
2395  * @param child The child to be added in custom chain
2396  * @param relative_child The relative object to position the child
2397  * @ingroup Focus
2398  */
2399 EAPI void
2400 elm_object_focus_custom_chain_prepend(Evas_Object *obj,
2401                                       Evas_Object *child,
2402                                       Evas_Object *relative_child)
2403 {
2404    EINA_SAFETY_ON_NULL_RETURN(obj);
2405    EINA_SAFETY_ON_NULL_RETURN(child);
2406    elm_widget_focus_custom_chain_prepend(obj, child, relative_child);
2407 }
2408
2409 /**
2410  * Give focus to next object in object tree.
2411  *
2412  * Give focus to next object in focus chain of one object sub-tree.
2413  * If the last object of chain already have focus, the focus will go to the
2414  * first object of chain.
2415  *
2416  * @param obj The object root of sub-tree
2417  * @param dir Direction to cycle the focus
2418  *
2419  * @ingroup Focus
2420  */
2421 EAPI void
2422 elm_object_focus_cycle(Evas_Object        *obj,
2423                        Elm_Focus_Direction dir)
2424 {
2425    EINA_SAFETY_ON_NULL_RETURN(obj);
2426    elm_widget_focus_cycle(obj, dir);
2427 }
2428
2429 /**
2430  * Give focus to near object in one direction.
2431  *
2432  * Give focus to near object in direction of one object.
2433  * If none focusable object in given direction, the focus will not change.
2434  *
2435  * @param obj The reference object
2436  * @param x Horizontal component of direction to focus
2437  * @param y Vertical component of direction to focus
2438  *
2439  * @ingroup Focus
2440  */
2441 EAPI void
2442 elm_object_focus_direction_go(Evas_Object *obj,
2443                               int          x,
2444                               int          y)
2445 {
2446    EINA_SAFETY_ON_NULL_RETURN(obj);
2447    elm_widget_focus_direction_go(obj, x, y);
2448 }
2449
2450 /**
2451  * Get the enable status of the focus highlight
2452  *
2453  * This gets whether the highlight on focused objects is enabled or not
2454  * @ingroup Focus
2455  */
2456 EAPI Eina_Bool
2457 elm_focus_highlight_enabled_get(void)
2458 {
2459    return _elm_config->focus_highlight_enable;
2460 }
2461
2462 /**
2463  * Set the enable status of the focus highlight
2464  *
2465  * Set whether to show or not the highlight on focused objects
2466  * @param enable Enable highlight if EINA_TRUE, disable otherwise
2467  * @ingroup Focus
2468  */
2469 EAPI void
2470 elm_focus_highlight_enabled_set(Eina_Bool enable)
2471 {
2472    _elm_config->focus_highlight_enable = !!enable;
2473 }
2474
2475 /**
2476  * Get the enable status of the highlight animation
2477  *
2478  * Get whether the focus highlight, if enabled, will animate its switch from
2479  * one object to the next
2480  * @ingroup Focus
2481  */
2482 EAPI Eina_Bool
2483 elm_focus_highlight_animate_get(void)
2484 {
2485    return _elm_config->focus_highlight_animate;
2486 }
2487
2488 /**
2489  * Set the enable status of the highlight animation
2490  *
2491  * Set whether the focus highlight, if enabled, will animate its switch from
2492  * one object to the next
2493  * @param animate Enable animation if EINA_TRUE, disable otherwise
2494  * @ingroup Focus
2495  */
2496 EAPI void
2497 elm_focus_highlight_animate_set(Eina_Bool animate)
2498 {
2499    _elm_config->focus_highlight_animate = !!animate;
2500 }
2501
2502 /**
2503  * @defgroup Scrolling Scrolling
2504  * @ingroup Main
2505  *
2506  * These are functions setting how scrollable views in Elementary
2507  * widgets should behave on user interaction.
2508  */
2509
2510 /**
2511  * Get whether scrollers should bounce when they reach their
2512  * viewport's edge during a scroll.
2513  *
2514  * @return the thumb scroll bouncing state
2515  *
2516  * This is the default behavior for touch screens, in general.
2517  * @ingroup Scrolling
2518  */
2519 EAPI Eina_Bool
2520 elm_scroll_bounce_enabled_get(void)
2521 {
2522    return _elm_config->thumbscroll_bounce_enable;
2523 }
2524
2525 /**
2526  * Set whether scrollers should bounce when they reach their
2527  * viewport's edge during a scroll.
2528  *
2529  * @param enabled the thumb scroll bouncing state
2530  *
2531  * @see elm_thumbscroll_bounce_enabled_get()
2532  * @ingroup Scrolling
2533  */
2534 EAPI void
2535 elm_scroll_bounce_enabled_set(Eina_Bool enabled)
2536 {
2537    _elm_config->thumbscroll_bounce_enable = enabled;
2538 }
2539
2540 /**
2541  * Set whether scrollers should bounce when they reach their
2542  * viewport's edge during a scroll, for all Elementary application
2543  * windows.
2544  *
2545  * @param enabled the thumb scroll bouncing state
2546  *
2547  * @see elm_thumbscroll_bounce_enabled_get()
2548  * @ingroup Scrolling
2549  */
2550 EAPI void
2551 elm_scroll_bounce_enabled_all_set(Eina_Bool enabled)
2552 {
2553 #ifdef HAVE_ELEMENTARY_X
2554    static Ecore_X_Atom atom = 0;
2555    unsigned int bounce_enable_i = (unsigned int)enabled;
2556
2557    if (!atom)
2558      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BOUNCE_ENABLE");
2559    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2560                                   atom, &bounce_enable_i, 1);
2561 #endif
2562 }
2563
2564 /**
2565  * Get the amount of inertia a scroller will impose at bounce
2566  * animations.
2567  *
2568  * @return the thumb scroll bounce friction
2569  *
2570  * @ingroup Scrolling
2571  */
2572 EAPI double
2573 elm_scroll_bounce_friction_get(void)
2574 {
2575    return _elm_config->thumbscroll_bounce_friction;
2576 }
2577
2578 /**
2579  * Set the amount of inertia a scroller will impose at bounce
2580  * animations.
2581  *
2582  * @param friction the thumb scroll bounce friction
2583  *
2584  * @see elm_thumbscroll_bounce_friction_get()
2585  * @ingroup Scrolling
2586  */
2587 EAPI void
2588 elm_scroll_bounce_friction_set(double friction)
2589 {
2590    _elm_config->thumbscroll_bounce_friction = friction;
2591 }
2592
2593 /**
2594  * Set the amount of inertia a scroller will impose at bounce
2595  * animations, for all Elementary application windows.
2596  *
2597  * @param friction the thumb scroll bounce friction
2598  *
2599  * @see elm_thumbscroll_bounce_friction_get()
2600  * @ingroup Scrolling
2601  */
2602 EAPI void
2603 elm_scroll_bounce_friction_all_set(double friction)
2604 {
2605 #ifdef HAVE_ELEMENTARY_X
2606    static Ecore_X_Atom atom = 0;
2607    unsigned int bounce_friction_i = (unsigned int)(friction * 1000.0);
2608
2609    if (!atom)
2610      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BOUNCE_FRICTION");
2611    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2612                                   atom, &bounce_friction_i, 1);
2613 #endif
2614 }
2615
2616 /**
2617  * Get the amount of inertia a <b>paged</b> scroller will impose at
2618  * page fitting animations.
2619  *
2620  * @return the page scroll friction
2621  *
2622  * @ingroup Scrolling
2623  */
2624 EAPI double
2625 elm_scroll_page_scroll_friction_get(void)
2626 {
2627    return _elm_config->page_scroll_friction;
2628 }
2629
2630 /**
2631  * Set the amount of inertia a <b>paged</b> scroller will impose at
2632  * page fitting animations.
2633  *
2634  * @param friction the page scroll friction
2635  *
2636  * @see elm_thumbscroll_page_scroll_friction_get()
2637  * @ingroup Scrolling
2638  */
2639 EAPI void
2640 elm_scroll_page_scroll_friction_set(double friction)
2641 {
2642    _elm_config->page_scroll_friction = friction;
2643 }
2644
2645 /**
2646  * Set the amount of inertia a <b>paged</b> scroller will impose at
2647  * page fitting animations, for all Elementary application windows.
2648  *
2649  * @param friction the page scroll friction
2650  *
2651  * @see elm_thumbscroll_page_scroll_friction_get()
2652  * @ingroup Scrolling
2653  */
2654 EAPI void
2655 elm_scroll_page_scroll_friction_all_set(double friction)
2656 {
2657 #ifdef HAVE_ELEMENTARY_X
2658    static Ecore_X_Atom atom = 0;
2659    unsigned int page_scroll_friction_i = (unsigned int)(friction * 1000.0);
2660
2661    if (!atom)
2662      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_PAGE_SCROLL_FRICTION");
2663    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2664                                   atom, &page_scroll_friction_i, 1);
2665 #endif
2666 }
2667
2668 /**
2669  * Get the amount of inertia a scroller will impose at region bring
2670  * animations.
2671  *
2672  * @return the bring in scroll friction
2673  *
2674  * @ingroup Scrolling
2675  */
2676 EAPI double
2677 elm_scroll_bring_in_scroll_friction_get(void)
2678 {
2679    return _elm_config->bring_in_scroll_friction;
2680 }
2681
2682 /**
2683  * Set the amount of inertia a scroller will impose at region bring
2684  * animations.
2685  *
2686  * @param friction the bring in scroll friction
2687  *
2688  * @see elm_thumbscroll_bring_in_scroll_friction_get()
2689  * @ingroup Scrolling
2690  */
2691 EAPI void
2692 elm_scroll_bring_in_scroll_friction_set(double friction)
2693 {
2694    _elm_config->bring_in_scroll_friction = friction;
2695 }
2696
2697 /**
2698  * Set the amount of inertia a scroller will impose at region bring
2699  * animations, for all Elementary application windows.
2700  *
2701  * @param friction the bring in scroll friction
2702  *
2703  * @see elm_thumbscroll_bring_in_scroll_friction_get()
2704  * @ingroup Scrolling
2705  */
2706 EAPI void
2707 elm_scroll_bring_in_scroll_friction_all_set(double friction)
2708 {
2709 #ifdef HAVE_ELEMENTARY_X
2710    static Ecore_X_Atom atom = 0;
2711    unsigned int bring_in_scroll_friction_i = (unsigned int)(friction * 1000.0);
2712
2713    if (!atom)
2714      atom =
2715        ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BRING_IN_SCROLL_FRICTION");
2716    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2717                                   atom, &bring_in_scroll_friction_i, 1);
2718 #endif
2719 }
2720
2721 /**
2722  * Get the amount of inertia scrollers will impose at animations
2723  * triggered by Elementary widgets' zooming API.
2724  *
2725  * @return the zoom friction
2726  *
2727  * @ingroup Scrolling
2728  */
2729 EAPI double
2730 elm_scroll_zoom_friction_get(void)
2731 {
2732    return _elm_config->zoom_friction;
2733 }
2734
2735 /**
2736  * Set the amount of inertia scrollers will impose at animations
2737  * triggered by Elementary widgets' zooming API.
2738  *
2739  * @param friction the zoom friction
2740  *
2741  * @see elm_thumbscroll_zoom_friction_get()
2742  * @ingroup Scrolling
2743  */
2744 EAPI void
2745 elm_scroll_zoom_friction_set(double friction)
2746 {
2747    _elm_config->zoom_friction = friction;
2748 }
2749
2750 /**
2751  * Set the amount of inertia scrollers will impose at animations
2752  * triggered by Elementary widgets' zooming API, for all Elementary
2753  * application windows.
2754  *
2755  * @param friction the zoom friction
2756  *
2757  * @see elm_thumbscroll_zoom_friction_get()
2758  * @ingroup Scrolling
2759  */
2760 EAPI void
2761 elm_scroll_zoom_friction_all_set(double friction)
2762 {
2763 #ifdef HAVE_ELEMENTARY_X
2764    static Ecore_X_Atom atom = 0;
2765    unsigned int zoom_friction_i = (unsigned int)(friction * 1000.0);
2766
2767    if (!atom)
2768      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_ZOOM_FRICTION");
2769    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2770                                   atom, &zoom_friction_i, 1);
2771 #endif
2772 }
2773
2774 /**
2775  * Get whether scrollers should be draggable from any point in their
2776  * views.
2777  *
2778  * @return the thumb scroll state
2779  *
2780  * @note This is the default behavior for touch screens, in general.
2781  * @note All other functions namespaced with "thumbscroll" will only
2782  *       have effect if this mode is enabled.
2783  *
2784  * @ingroup Scrolling
2785  */
2786 EAPI Eina_Bool
2787 elm_scroll_thumbscroll_enabled_get(void)
2788 {
2789    return _elm_config->thumbscroll_enable;
2790 }
2791
2792 /**
2793  * Set whether scrollers should be draggable from any point in their
2794  * views.
2795  *
2796  * @param enabled the thumb scroll state
2797  *
2798  * @see elm_thumbscroll_enabled_get()
2799  * @ingroup Scrolling
2800  */
2801 EAPI void
2802 elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled)
2803 {
2804    _elm_config->thumbscroll_enable = enabled;
2805 }
2806
2807 /**
2808  * Set whether scrollers should be draggable from any point in their
2809  * views, for all Elementary application windows.
2810  *
2811  * @param enabled the thumb scroll state
2812  *
2813  * @see elm_thumbscroll_enabled_get()
2814  * @ingroup Scrolling
2815  */
2816 EAPI void
2817 elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled)
2818 {
2819 #ifdef HAVE_ELEMENTARY_X
2820    static Ecore_X_Atom atom = 0;
2821    unsigned int ts_enable_i = (unsigned int)enabled;
2822
2823    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_ENABLE");
2824    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2825                                   atom, &ts_enable_i, 1);
2826 #endif
2827 }
2828
2829 /**
2830  * Get the number of pixels one should travel while dragging a
2831  * scroller's view to actually trigger scrolling.
2832  *
2833  * @return the thumb scroll threshould
2834  *
2835  * One would use higher values for touch screens, in general, because
2836  * of their inherent imprecision.
2837  * @ingroup Scrolling
2838  */
2839 EAPI unsigned int
2840 elm_scroll_thumbscroll_threshold_get(void)
2841 {
2842    return _elm_config->thumbscroll_threshold;
2843 }
2844
2845 /**
2846  * Set the number of pixels one should travel while dragging a
2847  * scroller's view to actually trigger scrolling.
2848  *
2849  * @param threshold the thumb scroll threshould
2850  *
2851  * @see elm_thumbscroll_threshould_get()
2852  * @ingroup Scrolling
2853  */
2854 EAPI void
2855 elm_scroll_thumbscroll_threshold_set(unsigned int threshold)
2856 {
2857    _elm_config->thumbscroll_threshold = threshold;
2858 }
2859
2860 /**
2861  * Set the number of pixels one should travel while dragging a
2862  * scroller's view to actually trigger scrolling, for all Elementary
2863  * application windows.
2864  *
2865  * @param threshold the thumb scroll threshould
2866  *
2867  * @see elm_thumbscroll_threshould_get()
2868  * @ingroup Scrolling
2869  */
2870 EAPI void
2871 elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold)
2872 {
2873 #ifdef HAVE_ELEMENTARY_X
2874    static Ecore_X_Atom atom = 0;
2875    unsigned int ts_threshold_i = (unsigned int)threshold;
2876
2877    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_THRESHOLD");
2878    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2879                                   atom, &ts_threshold_i, 1);
2880 #endif
2881 }
2882
2883 /**
2884  * Get the minimum speed of mouse cursor movement which will trigger
2885  * list self scrolling animation after a mouse up event
2886  * (pixels/second).
2887  *
2888  * @return the thumb scroll momentum threshould
2889  *
2890  * @ingroup Scrolling
2891  */
2892 EAPI double
2893 elm_scroll_thumbscroll_momentum_threshold_get(void)
2894 {
2895    return _elm_config->thumbscroll_momentum_threshold;
2896 }
2897
2898 /**
2899  * Set the minimum speed of mouse cursor movement which will trigger
2900  * list self scrolling animation after a mouse up event
2901  * (pixels/second).
2902  *
2903  * @param threshold the thumb scroll momentum threshould
2904  *
2905  * @see elm_thumbscroll_momentum_threshould_get()
2906  * @ingroup Scrolling
2907  */
2908 EAPI void
2909 elm_scroll_thumbscroll_momentum_threshold_set(double threshold)
2910 {
2911    _elm_config->thumbscroll_momentum_threshold = threshold;
2912 }
2913
2914 /**
2915  * Set the minimum speed of mouse cursor movement which will trigger
2916  * list self scrolling animation after a mouse up event
2917  * (pixels/second), for all Elementary application windows.
2918  *
2919  * @param threshold the thumb scroll momentum threshould
2920  *
2921  * @see elm_thumbscroll_momentum_threshould_get()
2922  * @ingroup Scrolling
2923  */
2924 EAPI void
2925 elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold)
2926 {
2927 #ifdef HAVE_ELEMENTARY_X
2928    static Ecore_X_Atom atom = 0;
2929    unsigned int ts_momentum_threshold_i = (unsigned int)(threshold * 1000.0);
2930
2931    if (!atom)
2932      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_MOMENTUM_THRESHOLD");
2933    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2934                                   atom, &ts_momentum_threshold_i, 1);
2935 #endif
2936 }
2937
2938 /**
2939  * Get the amount of inertia a scroller will impose at self scrolling
2940  * animations.
2941  *
2942  * @return the thumb scroll friction
2943  *
2944  * @ingroup Scrolling
2945  */
2946 EAPI double
2947 elm_scroll_thumbscroll_friction_get(void)
2948 {
2949    return _elm_config->thumbscroll_friction;
2950 }
2951
2952 /**
2953  * Set the amount of inertia a scroller will impose at self scrolling
2954  * animations.
2955  *
2956  * @param friction the thumb scroll friction
2957  *
2958  * @see elm_thumbscroll_friction_get()
2959  * @ingroup Scrolling
2960  */
2961 EAPI void
2962 elm_scroll_thumbscroll_friction_set(double friction)
2963 {
2964    _elm_config->thumbscroll_friction = friction;
2965 }
2966
2967 /**
2968  * Set the amount of inertia a scroller will impose at self scrolling
2969  * animations, for all Elementary application windows.
2970  *
2971  * @param friction the thumb scroll friction
2972  *
2973  * @see elm_thumbscroll_friction_get()
2974  * @ingroup Scrolling
2975  */
2976 EAPI void
2977 elm_scroll_thumbscroll_friction_all_set(double friction)
2978 {
2979 #ifdef HAVE_ELEMENTARY_X
2980    static Ecore_X_Atom atom = 0;
2981    unsigned int ts_friction_i = (unsigned int)(friction * 1000.0);
2982
2983    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_FRICTION");
2984    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2985                                   atom, &ts_friction_i, 1);
2986 #endif
2987 }
2988
2989 /**
2990  * Get the amount of lag between your actual mouse cursor dragging
2991  * movement and a scroller's view movement itself, while pushing it
2992  * into bounce state manually.
2993  *
2994  * @return the thumb scroll border friction
2995  *
2996  * @ingroup Scrolling
2997  */
2998 EAPI double
2999 elm_scroll_thumbscroll_border_friction_get(void)
3000 {
3001    return _elm_config->thumbscroll_border_friction;
3002 }
3003
3004 /**
3005  * Set the amount of lag between your actual mouse cursor dragging
3006  * movement and a scroller's view movement itself, while pushing it
3007  * into bounce state manually.
3008  *
3009  * @param friction the thumb scroll border friction. @c 0.0 for
3010  *        perfect synchrony between two movements, @c 1.0 for maximum
3011  *        lag.
3012  *
3013  * @see elm_thumbscroll_border_friction_get()
3014  * @note parameter value will get bound to 0.0 - 1.0 interval, always
3015  *
3016  * @ingroup Scrolling
3017  */
3018 EAPI void
3019 elm_scroll_thumbscroll_border_friction_set(double friction)
3020 {
3021    if (friction < 0.0)
3022      friction = 0.0;
3023
3024    if (friction > 1.0)
3025      friction = 1.0;
3026
3027    _elm_config->thumbscroll_friction = friction;
3028 }
3029
3030 /**
3031  * Set the amount of lag between your actual mouse cursor dragging
3032  * movement and a scroller's view movement itself, while pushing it
3033  * into bounce state manually, for all Elementary application windows.
3034  *
3035  * @param friction the thumb scroll border friction. @c 0.0 for
3036  *        perfect synchrony between two movements, @c 1.0 for maximum
3037  *        lag.
3038  *
3039  * @see elm_thumbscroll_border_friction_get()
3040  * @note parameter value will get bound to 0.0 - 1.0 interval, always
3041  *
3042  * @ingroup Scrolling
3043  */
3044 EAPI void
3045 elm_scroll_thumbscroll_border_friction_all_set(double friction)
3046 {
3047    if (friction < 0.0)
3048      friction = 0.0;
3049
3050    if (friction > 1.0)
3051      friction = 1.0;
3052
3053 #ifdef HAVE_ELEMENTARY_X
3054    static Ecore_X_Atom atom = 0;
3055    unsigned int border_friction_i = (unsigned int)(friction * 1000.0);
3056
3057    if (!atom)
3058      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BORDER_FRICTION");
3059    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
3060                                   atom, &border_friction_i, 1);
3061 #endif
3062 }
3063
3064 /**
3065  * @defgroup Scrollhints Scrollhints
3066  * @ingroup Main
3067  *
3068  * Objects when inside a scroller can scroll, but this may not always be
3069  * desirable in certain situations. This allows an object to hint to itself
3070  * and parents to "not scroll" in one of 2 ways.
3071  *
3072  * 1. To hold on scrolling. This means just flicking and dragging may no
3073  * longer scroll, but pressing/dragging near an edge of the scroller will
3074  * still scroll. This is automastically used by the entry object when
3075  * selecting text.
3076  * 2. To totally freeze scrolling. This means it stops. until popped/released.
3077  */
3078
3079 /**
3080  * Push the scroll hold by 1
3081  *
3082  * This increments the scroll hold count by one. If it is more than 0 it will
3083  * take effect on the parents of the indicated object.
3084  *
3085  * @param obj The object
3086  * @ingroup Scrollhints
3087  */
3088 EAPI void
3089 elm_object_scroll_hold_push(Evas_Object *obj)
3090 {
3091    EINA_SAFETY_ON_NULL_RETURN(obj);
3092    elm_widget_scroll_hold_push(obj);
3093 }
3094
3095 /**
3096  * Pop the scroll hold by 1
3097  *
3098  * This decrements the scroll hold count by one. If it is more than 0 it will
3099  * take effect on the parents of the indicated object.
3100  *
3101  * @param obj The object
3102  * @ingroup Scrollhints
3103  */
3104 EAPI void
3105 elm_object_scroll_hold_pop(Evas_Object *obj)
3106 {
3107    EINA_SAFETY_ON_NULL_RETURN(obj);
3108    elm_widget_scroll_hold_pop(obj);
3109 }
3110
3111 /**
3112  * Push the scroll freeze by 1
3113  *
3114  * This increments the scroll freeze count by one. If it is more than 0 it will
3115  * take effect on the parents of the indicated object.
3116  *
3117  * @param obj The object
3118  * @ingroup Scrollhints
3119  */
3120 EAPI void
3121 elm_object_scroll_freeze_push(Evas_Object *obj)
3122 {
3123    EINA_SAFETY_ON_NULL_RETURN(obj);
3124    elm_widget_scroll_freeze_push(obj);
3125 }
3126
3127 /**
3128  * Lock the scrolling of the given widget (and thus all parents)
3129  *
3130  * This locks the given object from scrolling in the X axis (and implicitly
3131  * also locks all parent scrollers too from doing the same).
3132  *
3133  * @param obj The object
3134  * @param lock The lock state (1 == locked, 0 == unlocked)
3135  * @ingroup Scrollhints
3136  */
3137 EAPI void
3138 elm_object_scroll_lock_x_set(Evas_Object *obj,
3139                              Eina_Bool    lock)
3140 {
3141    EINA_SAFETY_ON_NULL_RETURN(obj);
3142    elm_widget_drag_lock_x_set(obj, lock);
3143 }
3144
3145 /**
3146  * Lock the scrolling of the given widget (and thus all parents)
3147  *
3148  * This locks the given object from scrolling in the Y axis (and implicitly
3149  * also locks all parent scrollers too from doing the same).
3150  *
3151  * @param obj The object
3152  * @param lock The lock state (1 == locked, 0 == unlocked)
3153  * @ingroup Scrollhints
3154  */
3155 EAPI void
3156 elm_object_scroll_lock_y_set(Evas_Object *obj,
3157                              Eina_Bool    lock)
3158 {
3159    EINA_SAFETY_ON_NULL_RETURN(obj);
3160    elm_widget_drag_lock_y_set(obj, lock);
3161 }
3162
3163 /**
3164  * Get the scrolling lock of the given widget
3165  *
3166  * This gets the lock for X axis scrolling.
3167  *
3168  * @param obj The object
3169  * @ingroup Scrollhints
3170  */
3171 EAPI Eina_Bool
3172 elm_object_scroll_lock_x_get(const Evas_Object *obj)
3173 {
3174    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3175    return elm_widget_drag_lock_x_get(obj);
3176 }
3177
3178 /**
3179  * Get the scrolling lock of the given widget
3180  *
3181  * This gets the lock for X axis scrolling.
3182  *
3183  * @param obj The object
3184  * @ingroup Scrollhints
3185  */
3186 EAPI Eina_Bool
3187 elm_object_scroll_lock_y_get(const Evas_Object *obj)
3188 {
3189    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3190    return elm_widget_drag_lock_y_get(obj);
3191 }
3192
3193 /**
3194  * Pop the scroll freeze by 1
3195  *
3196  * This decrements the scroll freeze count by one. If it is more than 0 it will
3197  * take effect on the parents of the indicated object.
3198  *
3199  * @param obj The object
3200  * @ingroup Scrollhints
3201  */
3202 EAPI void
3203 elm_object_scroll_freeze_pop(Evas_Object *obj)
3204 {
3205    EINA_SAFETY_ON_NULL_RETURN(obj);
3206    elm_widget_scroll_freeze_pop(obj);
3207 }
3208
3209 /**
3210  * Check if the given Evas Object is an Elementary widget.
3211  *
3212  * @param obj the object to query.
3213  * @return @c EINA_TRUE if it is an elementary widget variant,
3214  *         @c EINA_FALSE otherwise
3215  * @ingroup WidgetNavigation
3216  */
3217 EAPI Eina_Bool
3218 elm_object_widget_check(const Evas_Object *obj)
3219 {
3220    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3221    return elm_widget_is(obj);
3222 }
3223
3224 EAPI Evas_Object *
3225 elm_object_parent_widget_get(const Evas_Object *obj)
3226 {
3227    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3228    return elm_widget_parent_widget_get(obj);
3229 }
3230
3231 /**
3232  * Get the top level parent of an Elementary widget.
3233  *
3234  * @param obj The object to query.
3235  * @return The top level Elementary widget, or @c NULL if parent cannot be
3236  * found.
3237  * @ingroup WidgetNavigation
3238  */
3239 EAPI Evas_Object *
3240 elm_object_top_widget_get(const Evas_Object *obj)
3241 {
3242    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3243    return elm_widget_top_get(obj);
3244 }
3245
3246 /**
3247  * Get the string that represents this Elementary widget.
3248  *
3249  * @note Elementary is weird and exposes itself as a single
3250  *       Evas_Object_Smart_Class of type "elm_widget", so
3251  *       evas_object_type_get() always return that, making debug and
3252  *       language bindings hard. This function tries to mitigate this
3253  *       problem, but the solution is to change Elementary to use
3254  *       proper inheritance.
3255  *
3256  * @param obj the object to query.
3257  * @return Elementary widget name, or @c NULL if not a valid widget.
3258  * @ingroup WidgetNavigation
3259  */
3260 EAPI const char *
3261 elm_object_widget_type_get(const Evas_Object *obj)
3262 {
3263    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3264    return elm_widget_type_get(obj);
3265 }
3266
3267 /**
3268  * Send a signal to the widget edje object.
3269  *
3270  * This function sends a signal to the edje object of the obj. An edje program
3271  * can respond to a signal by specifying matching 'signal' and
3272  * 'source' fields.
3273  *
3274  * @param obj The object
3275  * @param emission The signal's name.
3276  * @param source The signal's source.
3277  * @ingroup General
3278  */
3279 EAPI void
3280 elm_object_signal_emit(Evas_Object *obj,
3281                        const char  *emission,
3282                        const char  *source)
3283 {
3284    EINA_SAFETY_ON_NULL_RETURN(obj);
3285    elm_widget_signal_emit(obj, emission, source);
3286 }
3287
3288 /**
3289  * Add a callback for a signal emitted by widget edje object.
3290  *
3291  * This function connects a callback function to a signal emitted by the
3292  * edje object of the obj.
3293  * Globs can occur in either the emission or source name.
3294  *
3295  * @param obj The object
3296  * @param emission The signal's name.
3297  * @param source The signal's source.
3298  * @param func The callback function to be executed when the signal is
3299  * emitted.
3300  * @param data A pointer to data to pass in to the callback function.
3301  * @ingroup General
3302  */
3303 EAPI void
3304 elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data)
3305 {
3306     EINA_SAFETY_ON_NULL_RETURN(obj);
3307     EINA_SAFETY_ON_NULL_RETURN(func);
3308     elm_widget_signal_callback_add(obj, emission, source, func, data);
3309 }
3310
3311 /**
3312  * Remove a signal-triggered callback from an widget edje object.
3313  *
3314  * This function removes a callback, previoulsy attached to a signal emitted
3315  * by the edje object of the obj.
3316  * The parameters emission, source and func must match exactly those passed to
3317  * a previous call to elm_object_signal_callback_add(). The data pointer that
3318  * was passed to this call will be returned.
3319  *
3320  * @param obj The object
3321  * @param emission The signal's name.
3322  * @param source The signal's source.
3323  * @param func The callback function to be executed when the signal is
3324  * emitted.
3325  * @return The data pointer
3326  * @ingroup General
3327  */
3328 EAPI void *
3329 elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source))
3330 {
3331     EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3332     EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
3333     return elm_widget_signal_callback_del(obj, emission, source, func);
3334 }
3335
3336 /**
3337  * Add a callback for a event emitted by widget or their children.
3338  *
3339  * This function connects a callback function to any key_down key_up event
3340  * emitted by the @p obj or their children.
3341  * This only will be called if no other callback has consumed the event.
3342  * If you want consume the event, and no other get it, func should return
3343  * EINA_TRUE and put EVAS_EVENT_FLAG_ON_HOLD in event_flags.
3344  *
3345  * @warning Accept duplicated callback addition.
3346  *
3347  * @param obj The object
3348  * @param func The callback function to be executed when the event is
3349  * emitted.
3350  * @param data Data to pass in to the callback function.
3351  * @ingroup General
3352  */
3353 EAPI void
3354 elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data)
3355 {
3356    EINA_SAFETY_ON_NULL_RETURN(obj);
3357    EINA_SAFETY_ON_NULL_RETURN(func);
3358    elm_widget_event_callback_add(obj, func, data);
3359 }
3360
3361 /**
3362  * Remove a event callback from an widget.
3363  *
3364  * This function removes a callback, previoulsy attached to event emission
3365  * by the @p obj.
3366  * The parameters func and data must match exactly those passed to
3367  * a previous call to elm_object_event_callback_add(). The data pointer that
3368  * was passed to this call will be returned.
3369  *
3370  * @param obj The object
3371  * @param func The callback function to be executed when the event is
3372  * emitted.
3373  * @param data Data to pass in to the callback function.
3374  * @return The data pointer
3375  * @ingroup General
3376  */
3377 EAPI void *
3378 elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data)
3379 {
3380    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3381    EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
3382    return elm_widget_event_callback_del(obj, func, data);
3383 }
3384
3385
3386 /**
3387  * @defgroup Debug Debug
3388  * @ingroup Main
3389  */
3390
3391 /**
3392  * Print Tree object hierarchy in stdout
3393  *
3394  * @param obj The root object
3395  * @ingroup Debug
3396  */
3397 EAPI void
3398 elm_object_tree_dump(const Evas_Object *top)
3399 {
3400 #ifdef ELM_DEBUG
3401    elm_widget_tree_dump(top);
3402 #else
3403    return;
3404    (void)top;
3405 #endif
3406 }
3407
3408 /**
3409  * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3410  *
3411  * @param obj The root object
3412  * @param file The path of output file
3413  * @ingroup Debug
3414  */
3415 EAPI void
3416 elm_object_tree_dot_dump(const Evas_Object *top,
3417                          const char        *file)
3418 {
3419 #ifdef ELM_DEBUG
3420    FILE *f = fopen(file, "wb");
3421    elm_widget_tree_dot_dump(top, f);
3422    fclose(f);
3423 #else
3424    return;
3425    (void)top;
3426    (void)file;
3427 #endif
3428 }
3429
3430 /**
3431  * Set the duration for occuring long press event.
3432  *
3433  * @param lonpress_timeout Timeout for long press event
3434  * @ingroup Longpress
3435  */
3436 EAPI void
3437 elm_longpress_timeout_set(double longpress_timeout)
3438 {
3439    _elm_config->longpress_timeout = longpress_timeout;
3440 }
3441
3442 /**
3443  * Get the duration for occuring long press event.
3444  *
3445  * @return Timeout for long press event
3446  * @ingroup Longpress
3447  */
3448 EAPI double
3449 elm_longpress_timeout_get(void)
3450 {
3451    return _elm_config->longpress_timeout;
3452 }