c404a7e34be90503a52c19829ed0d91c3ccd973d
[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 Eina_Bool
1275 elm_password_show_last_get(void)
1276 {
1277    return _elm_config->password_show_last;
1278 }
1279
1280 EAPI void
1281 elm_password_show_last_set(Eina_Bool password_show_last)
1282 {
1283    if (_elm_config->password_show_last == password_show_last) return;
1284    _elm_config->password_show_last = password_show_last;
1285    edje_password_show_last_set(_elm_config->password_show_last);
1286 }
1287
1288 EAPI double
1289 elm_password_show_last_timeout_get(void)
1290 {
1291    return _elm_config->password_show_last_timeout;
1292 }
1293
1294 EAPI void
1295 elm_password_show_last_timeout_set(double password_show_last_timeout)
1296 {
1297    if (_elm_config->password_show_last_timeout == password_show_last_timeout) return;
1298    _elm_config->password_show_last_timeout = password_show_last_timeout;
1299    edje_password_show_last_timeout_set(_elm_config->password_show_last_timeout);
1300 }
1301
1302 EAPI void
1303 elm_object_style_set(Evas_Object *obj,
1304                      const char  *style)
1305 {
1306    EINA_SAFETY_ON_NULL_RETURN(obj);
1307    elm_widget_style_set(obj, style);
1308 }
1309
1310 EAPI const char *
1311 elm_object_style_get(const Evas_Object *obj)
1312 {
1313    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
1314    return elm_widget_style_get(obj);
1315 }
1316
1317 EAPI void
1318 elm_object_disabled_set(Evas_Object *obj,
1319                         Eina_Bool    disabled)
1320 {
1321    EINA_SAFETY_ON_NULL_RETURN(obj);
1322    elm_widget_disabled_set(obj, disabled);
1323 }
1324
1325 EAPI Eina_Bool
1326 elm_object_disabled_get(const Evas_Object *obj)
1327 {
1328    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
1329    return elm_widget_disabled_get(obj);
1330 }
1331
1332 /**
1333  * @defgroup Config Elementary Config
1334  * @ingroup Main
1335  *
1336  * Elementary configuration is formed by a set options bounded to a
1337  * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1338  * "finger size", etc. These are functions with which one syncronizes
1339  * changes made to those values to the configuration storing files, de
1340  * facto. You most probably don't want to use the functions in this
1341  * group unlees you're writing an elementary configuration manager.
1342  */
1343
1344 /**
1345  * Save back Elementary's configuration, so that it will persist on
1346  * future sessions.
1347  *
1348  * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1349  * @ingroup Config
1350  *
1351  * This function will take effect -- thus, do I/O -- immediately. Use
1352  * it when you want to apply all configuration changes at once. The
1353  * current configuration set will get saved onto the current profile
1354  * configuration file.
1355  *
1356  */
1357 EAPI Eina_Bool
1358 elm_config_save(void)
1359 {
1360    return _elm_config_save();
1361 }
1362
1363 /**
1364  * Reload Elementary's configuration, bounded to current selected
1365  * profile.
1366  *
1367  * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1368  * @ingroup Config
1369  *
1370  * Useful when you want to force reloading of configuration values for
1371  * a profile. If one removes user custom configuration directories,
1372  * for example, it will force a reload with system values insted.
1373  *
1374  */
1375 EAPI void
1376 elm_config_reload(void)
1377 {
1378    _elm_config_reload();
1379 }
1380
1381 /**
1382  * @defgroup Profile Elementary Profile
1383  * @ingroup Main
1384  *
1385  * Profiles are pre-set options that affect the whole look-and-feel of
1386  * Elementary-based applications. There are, for example, profiles
1387  * aimed at desktop computer applications and others aimed at mobile,
1388  * touchscreen-based ones. You most probably don't want to use the
1389  * functions in this group unlees you're writing an elementary
1390  * configuration manager.
1391  */
1392
1393 /**
1394  * Get Elementary's profile in use.
1395  *
1396  * This gets the global profile that is applied to all Elementary
1397  * applications.
1398  *
1399  * @return The profile's name
1400  * @ingroup Profile
1401  */
1402 EAPI const char *
1403 elm_profile_current_get(void)
1404 {
1405    return _elm_config_current_profile_get();
1406 }
1407
1408 /**
1409  * Get an Elementary's profile directory path in the filesystem. One
1410  * may want to fetch a system profile's dir or an user one (fetched
1411  * inside $HOME).
1412  *
1413  * @param profile The profile's name
1414  * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1415  *                or a system one (@c EINA_FALSE)
1416  * @return The profile's directory path.
1417  * @ingroup Profile
1418  *
1419  * @note You must free it with elm_profile_dir_free().
1420  */
1421 EAPI const char *
1422 elm_profile_dir_get(const char *profile,
1423                     Eina_Bool   is_user)
1424 {
1425    return _elm_config_profile_dir_get(profile, is_user);
1426 }
1427
1428 /**
1429  * Free an Elementary's profile directory path, as returned by
1430  * elm_profile_dir_get().
1431  *
1432  * @param p_dir The profile's path
1433  * @ingroup Profile
1434  *
1435  */
1436 EAPI void
1437 elm_profile_dir_free(const char *p_dir)
1438 {
1439    free((void *)p_dir);
1440 }
1441
1442 /**
1443  * Get Elementary's list of available profiles.
1444  *
1445  * @return The profiles list. List node data are the profile name
1446  *         strings.
1447  * @ingroup Profile
1448  *
1449  * @note One must free this list, after usage, with the function
1450  *       elm_profile_list_free().
1451  */
1452 EAPI Eina_List *
1453 elm_profile_list_get(void)
1454 {
1455    return _elm_config_profiles_list();
1456 }
1457
1458 /**
1459  * Free Elementary's list of available profiles.
1460  *
1461  * @param The profiles list, as returned by elm_profile_list_get().
1462  * @ingroup Profile
1463  *
1464  */
1465 EAPI void
1466 elm_profile_list_free(Eina_List *l)
1467 {
1468    const char *dir;
1469
1470    EINA_LIST_FREE(l, dir)
1471      eina_stringshare_del(dir);
1472 }
1473
1474 /**
1475  * Set Elementary's profile.
1476  *
1477  * This sets the global profile that is applied to Elementary
1478  * applications. Just the process the call comes from will be
1479  * affected.
1480  *
1481  * @param profile The profile's name
1482  * @ingroup Profile
1483  *
1484  */
1485 EAPI void
1486 elm_profile_set(const char *profile)
1487 {
1488    EINA_SAFETY_ON_NULL_RETURN(profile);
1489    _elm_config_profile_set(profile);
1490 }
1491
1492 /**
1493  * Set Elementary's profile.
1494  *
1495  * This sets the global profile that is applied to all Elementary
1496  * applications. All running Elementary windows will be affected.
1497  *
1498  * @param profile The profile's name
1499  * @ingroup Profile
1500  *
1501  */
1502 EAPI void
1503 elm_profile_all_set(const char *profile)
1504 {
1505 #ifdef HAVE_ELEMENTARY_X
1506    static Ecore_X_Atom atom = 0;
1507
1508    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_PROFILE");
1509    ecore_x_window_prop_string_set(ecore_x_window_root_first_get(),
1510                                   atom, profile);
1511 #endif
1512 }
1513
1514 /**
1515  * @defgroup Engine Elementary Engine
1516  * @ingroup Main
1517  *
1518  * These are functions setting and querying which rendering engine
1519  * Elementary will use for drawing its windows' pixels.
1520  */
1521
1522 /**
1523  * Get Elementary's rendering engine in use.
1524  *
1525  * This gets the global rendering engine that is applied to all
1526  * Elementary applications.
1527  *
1528  * @return The rendering engine's name
1529  * @ingroup Engine
1530  *
1531  * @note there's no need to free the returned string, here.
1532  */
1533 EAPI const char *
1534 elm_engine_current_get(void)
1535 {
1536    return _elm_config->engine;
1537 }
1538
1539 /**
1540  * Set Elementary's rendering engine for use.
1541  *
1542  * This gets sets global rendering engine that is applied to all
1543  * Elementary applications. Note that it will take effect only to
1544  * subsequent Elementary window creations.
1545  *
1546  * @param The rendering engine's name
1547  * @ingroup Engine
1548  *
1549  * @note there's no need to free the returned string, here.
1550  */
1551 EAPI void
1552 elm_engine_set(const char *engine)
1553 {
1554    EINA_SAFETY_ON_NULL_RETURN(engine);
1555
1556    _elm_config_engine_set(engine);
1557 }
1558
1559 /**
1560  * @defgroup Fonts Elementary Fonts
1561  * @ingroup Main
1562  *
1563  * These are functions dealing with font rendering, selection and the
1564  * like for Elementary applications. One might fetch which system
1565  * fonts are there to use and set custom fonts for individual classes
1566  * of UI items containing text (text classes).
1567  */
1568
1569 /**
1570  * Get Elementary's list of supported text classes.
1571  *
1572  * @return The text classes list, with @c Elm_Text_Class blobs as data.
1573  * @ingroup Fonts
1574  *
1575  * Release the list with elm_text_classes_list_free().
1576  */
1577 EAPI const Eina_List *
1578 elm_text_classes_list_get(void)
1579 {
1580    return _elm_config_text_classes_get();
1581 }
1582
1583 /**
1584  * Free Elementary's list of supported text classes.
1585  *
1586  * @ingroup Fonts
1587  *
1588  * @see elm_text_classes_list_get().
1589  */
1590 EAPI void
1591 elm_text_classes_list_free(const Eina_List *list)
1592 {
1593    _elm_config_text_classes_free((Eina_List *)list);
1594 }
1595
1596 /**
1597  * Get Elementary's list of font overlays, set with
1598  * elm_font_overlay_set().
1599  *
1600  * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1601  * data.
1602  *
1603  * @ingroup Fonts
1604  *
1605  * For each text class, one can set a <b>font overlay</b> for it,
1606  * overriding the default font properties for that class coming from
1607  * the theme in use. There is no need to free this list.
1608  *
1609  * @see elm_font_overlay_set() and elm_font_overlay_unset().
1610  */
1611 EAPI const Eina_List *
1612 elm_font_overlay_list_get(void)
1613 {
1614    return _elm_config_font_overlays_list();
1615 }
1616
1617 /**
1618  * Set a font overlay for a given Elementary text class.
1619  *
1620  * @param text_class Text class name
1621  * @param font Font name and style string
1622  * @param size Font size
1623  *
1624  * @ingroup Fonts
1625  *
1626  * @p font has to be in the format returned by
1627  * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1628  * and @elm_font_overlay_unset().
1629  */
1630 EAPI void
1631 elm_font_overlay_set(const char    *text_class,
1632                      const char    *font,
1633                      Evas_Font_Size size)
1634 {
1635    _elm_config_font_overlay_set(text_class, font, size);
1636 }
1637
1638 /**
1639  * Unset a font overlay for a given Elementary text class.
1640  *
1641  * @param text_class Text class name
1642  *
1643  * @ingroup Fonts
1644  *
1645  * This will bring back text elements belonging to text class @p
1646  * text_class back to their default font settings.
1647  */
1648 EAPI void
1649 elm_font_overlay_unset(const char *text_class)
1650 {
1651    _elm_config_font_overlay_remove(text_class);
1652 }
1653
1654 /**
1655  * Apply the changes made with elm_font_overlay_set() and
1656  * elm_font_overlay_unset() on the current Elementary window.
1657  *
1658  * @ingroup Fonts
1659  *
1660  * This applies all font overlays set to all objects in the UI.
1661  */
1662 EAPI void
1663 elm_font_overlay_apply(void)
1664 {
1665    _elm_config_font_overlay_apply();
1666 }
1667
1668 /**
1669  * Apply the changes made with elm_font_overlay_set() and
1670  * elm_font_overlay_unset() on all Elementary application windows.
1671  *
1672  * @ingroup Fonts
1673  *
1674  * This applies all font overlays set to all objects in the UI.
1675  */
1676 EAPI void
1677 elm_font_overlay_all_apply(void)
1678 {
1679 #ifdef HAVE_ELEMENTARY_X
1680    static Ecore_X_Atom atom = 0;
1681    unsigned int dummy = (unsigned int)(1 * 1000.0);
1682
1683    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FONT_OVERLAY");
1684    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(), atom, &dummy,
1685                                   1);
1686 #endif
1687 }
1688
1689 /**
1690  * Translate a font (family) name string in fontconfig's font names
1691  * syntax into an @c Elm_Font_Properties struct.
1692  *
1693  * @param font The font name and styles string
1694  * @return the font properties struct
1695  *
1696  * @ingroup Fonts
1697  *
1698  * @note The reverse translation can be achived with
1699  * elm_font_fontconfig_name_get(), for one style only (single font
1700  * instance, not family).
1701  */
1702 EAPI Elm_Font_Properties *
1703 elm_font_properties_get(const char *font)
1704 {
1705    EINA_SAFETY_ON_NULL_RETURN_VAL(font, NULL);
1706    return _elm_font_properties_get(NULL, font);
1707 }
1708
1709 /**
1710  * Free font properties return by elm_font_properties_get().
1711  *
1712  * @param efp the font properties struct
1713  *
1714  * @ingroup Fonts
1715  */
1716 EAPI void
1717 elm_font_properties_free(Elm_Font_Properties *efp)
1718 {
1719    const char *str;
1720
1721    EINA_SAFETY_ON_NULL_RETURN(efp);
1722    EINA_LIST_FREE(efp->styles, str)
1723      if (str) eina_stringshare_del(str);
1724    if (efp->name) eina_stringshare_del(efp->name);
1725    free(efp);
1726 }
1727
1728 /**
1729  * Translate a font name, bound to a style, into fontconfig's font names
1730  * syntax.
1731  *
1732  * @param name The font (family) name
1733  * @param style The given style (may be @c NULL)
1734  *
1735  * @return the font name and style string
1736  *
1737  * @ingroup Fonts
1738  *
1739  * @note The reverse translation can be achived with
1740  * elm_font_properties_get(), for one style only (single font
1741  * instance, not family).
1742  */
1743 EAPI const char *
1744 elm_font_fontconfig_name_get(const char *name,
1745                              const char *style)
1746 {
1747    char buf[256];
1748
1749    EINA_SAFETY_ON_NULL_RETURN_VAL(name, NULL);
1750    if (!style || style[0] == 0) return eina_stringshare_add(name);
1751    snprintf(buf, 256, "%s" ELM_FONT_TOKEN_STYLE "%s", name, style);
1752    return eina_stringshare_add(buf);
1753 }
1754
1755 /**
1756  * Free the font string return by elm_font_fontconfig_name_get().
1757  *
1758  * @param efp the font properties struct
1759  *
1760  * @ingroup Fonts
1761  */
1762 EAPI void
1763 elm_font_fontconfig_name_free(const char *name)
1764 {
1765    eina_stringshare_del(name);
1766 }
1767
1768 /**
1769  * Create a font hash table of available system fonts.
1770  *
1771  * One must call it with @p list being the return value of
1772  * evas_font_available_list(). The hash will be indexed by font
1773  * (family) names, being its values @c Elm_Font_Properties blobs.
1774  *
1775  * @param list The list of available system fonts, as returned by
1776  * evas_font_available_list().
1777  * @return the font hash.
1778  *
1779  * @ingroup Fonts
1780  *
1781  * @note The user is supposed to get it populated at least with 3
1782  * default font families (Sans, Serif, Monospace), which should be
1783  * present on most systems.
1784  */
1785 EAPI Eina_Hash *
1786 elm_font_available_hash_add(Eina_List *list)
1787 {
1788    Eina_Hash *font_hash;
1789    Eina_List *l;
1790    void *key;
1791
1792    font_hash = NULL;
1793
1794    /* populate with default font families */
1795    font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Regular");
1796    font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Bold");
1797    font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Oblique");
1798    font_hash = _elm_font_available_hash_add(font_hash,
1799                                             "Sans:style=Bold Oblique");
1800
1801    font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Regular");
1802    font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Bold");
1803    font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Oblique");
1804    font_hash = _elm_font_available_hash_add(font_hash,
1805                                             "Serif:style=Bold Oblique");
1806
1807    font_hash = _elm_font_available_hash_add(font_hash,
1808                                             "Monospace:style=Regular");
1809    font_hash = _elm_font_available_hash_add(font_hash,
1810                                             "Monospace:style=Bold");
1811    font_hash = _elm_font_available_hash_add(font_hash,
1812                                             "Monospace:style=Oblique");
1813    font_hash = _elm_font_available_hash_add(font_hash,
1814                                             "Monospace:style=Bold Oblique");
1815
1816    EINA_LIST_FOREACH(list, l, key)
1817      font_hash = _elm_font_available_hash_add(font_hash, key);
1818
1819    return font_hash;
1820 }
1821
1822 /**
1823  * Free the hash return by elm_font_available_hash_add().
1824  *
1825  * @param hash the hash to be freed.
1826  *
1827  * @ingroup Fonts
1828  */
1829 EAPI void
1830 elm_font_available_hash_del(Eina_Hash *hash)
1831 {
1832    _elm_font_available_hash_del(hash);
1833 }
1834
1835 EAPI Evas_Coord
1836 elm_finger_size_get(void)
1837 {
1838    return _elm_config->finger_size;
1839 }
1840
1841 /**
1842  * Set the configured finger size
1843  *
1844  * This sets the globally configured finger size in pixels
1845  *
1846  * @param size The finger size
1847  * @ingroup Fingers
1848  */
1849 EAPI void
1850 elm_finger_size_set(Evas_Coord size)
1851 {
1852    if (_elm_config->finger_size == size) return;
1853    _elm_config->finger_size = size;
1854    _elm_rescale();
1855 }
1856
1857 /**
1858  * Set the configured finger size for all applications on the display
1859  *
1860  * This sets the globally configured finger size in pixels for all applications
1861  * on the display
1862  *
1863  * @param size The finger size
1864  * @ingroup Fingers
1865  */
1866 EAPI void
1867 elm_finger_size_all_set(Evas_Coord size)
1868 {
1869 #ifdef HAVE_ELEMENTARY_X
1870    static Ecore_X_Atom atom = 0;
1871    unsigned int size_i = (unsigned int)size;
1872
1873    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FINGER_SIZE");
1874    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1875                                   atom, &size_i, 1);
1876 #endif
1877 }
1878
1879 EAPI void
1880 elm_autocapitalization_allow_all_set(Eina_Bool on)
1881 {
1882 #ifdef HAVE_ELEMENTARY_X
1883    static Ecore_X_Atom atom = 0;
1884    unsigned int on_i = (unsigned int)on;
1885
1886    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_AUTOCAPITAL_ALLOW");
1887    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1888                                   atom, &on_i, 1);
1889 #endif
1890 }
1891
1892 EAPI void
1893 elm_autoperiod_allow_all_set(Eina_Bool on)
1894 {
1895 #ifdef HAVE_ELEMENTARY_X
1896    static Ecore_X_Atom atom = 0;
1897    unsigned int on_i = (unsigned int)on;
1898
1899    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_AUTOPERIOD_ALLOW");
1900    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1901                                   atom, &on_i, 1);
1902 #endif
1903 }
1904 /**
1905  * Adjust size of an element for finger usage
1906  *
1907  * This takes width and height sizes (in pixels) as input and a size multiple
1908  * (which is how many fingers you want to place within the area), and adjusts
1909  * the size tobe large enough to accommodate finger. On return the w and h
1910  * sizes poiner do by these parameters will be modified.
1911  *
1912  * @param times_w How many fingers should fit horizontally
1913  * @param w Pointer to the width size to adjust
1914  * @param times_h How many fingers should fit vertically
1915  * @param h Pointer to the height size to adjust
1916  * @ingroup Fingers
1917  */
1918 EAPI void
1919 elm_coords_finger_size_adjust(int         times_w,
1920                               Evas_Coord *w,
1921                               int         times_h,
1922                               Evas_Coord *h)
1923 {
1924    if ((w) && (*w < (_elm_config->finger_size * times_w)))
1925      *w = _elm_config->finger_size * times_w;
1926    if ((h) && (*h < (_elm_config->finger_size * times_h)))
1927      *h = _elm_config->finger_size * times_h;
1928 }
1929
1930 /**
1931  * @defgroup Caches Caches
1932  * @ingroup Main
1933  *
1934  * These are functions which let one fine-tune some cache values for
1935  * Elementary applications, thus allowing for performance adjustments.
1936  */
1937
1938 /**
1939  * Flush all caches & dump all data that can be to lean down to use
1940  * less memory
1941  *
1942  * @ingroup Caches
1943  */
1944 EAPI void
1945 elm_all_flush(void)
1946 {
1947    const Eina_List *l;
1948    Evas_Object *obj;
1949
1950    edje_file_cache_flush();
1951    edje_collection_cache_flush();
1952    eet_clearcache();
1953    EINA_LIST_FOREACH(_elm_win_list, l, obj)
1954      {
1955         Evas *e = evas_object_evas_get(obj);
1956         evas_image_cache_flush(e);
1957         evas_font_cache_flush(e);
1958         evas_render_dump(e);
1959      }
1960 }
1961
1962 /**
1963  * Get the configured cache flush interval time
1964  *
1965  * This gets the globally configured cache flush interval time, in
1966  * ticks
1967  *
1968  * @return The cache flush interval time
1969  * @ingroup Caches
1970  *
1971  * @see elm_all_flush()
1972  */
1973 EAPI int
1974 elm_cache_flush_interval_get(void)
1975 {
1976    return _elm_config->cache_flush_poll_interval;
1977 }
1978
1979 /**
1980  * Set the configured cache flush interval time
1981  *
1982  * This sets the globally configured cache flush interval time, in ticks
1983  *
1984  * @param size The cache flush interval time
1985  * @ingroup Caches
1986  *
1987  * @see elm_all_flush()
1988  */
1989 EAPI void
1990 elm_cache_flush_interval_set(int size)
1991 {
1992    if (_elm_config->cache_flush_poll_interval == size) return;
1993    _elm_config->cache_flush_poll_interval = size;
1994
1995    _elm_recache();
1996 }
1997
1998 /**
1999  * Set the configured cache flush interval time for all applications on the
2000  * display
2001  *
2002  * This sets the globally configured cache flush interval time -- in ticks
2003  * -- for all applications on the display.
2004  *
2005  * @param size The cache flush interval time
2006  * @ingroup Caches
2007  */
2008 EAPI void
2009 elm_cache_flush_interval_all_set(int size)
2010 {
2011 #ifdef HAVE_ELEMENTARY_X
2012    static Ecore_X_Atom atom = 0;
2013    unsigned int size_i = (unsigned int)size;
2014
2015    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_CACHE_FLUSH_INTERVAL");
2016    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2017                                   atom, &size_i, 1);
2018 #endif
2019 }
2020
2021 /**
2022  * Get the configured cache flush enabled state
2023  *
2024  * This gets the globally configured cache flush state - if it is enabled
2025  * or not. When cache flushing is enabled, elementary will regularly
2026  * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
2027  * memory and allow usage to re-seed caches and data in memory where it
2028  * can do so. An idle application will thus minimise its memory usage as
2029  * data will be freed from memory and not be re-loaded as it is idle and
2030  * not rendering or doing anything graphically right now.
2031  *
2032  * @return The cache flush state
2033  * @ingroup Caches
2034  *
2035  * @see elm_all_flush()
2036  */
2037 EAPI Eina_Bool
2038 elm_cache_flush_enabled_get(void)
2039 {
2040    return _elm_config->cache_flush_enable;
2041 }
2042
2043 /**
2044  * Set the configured cache flush enabled state
2045  *
2046  * This sets the globally configured cache flush enabled state
2047  *
2048  * @param size The cache flush enabled state
2049  * @ingroup Caches
2050  *
2051  * @see elm_all_flush()
2052  */
2053 EAPI void
2054 elm_cache_flush_enabled_set(Eina_Bool enabled)
2055 {
2056    enabled = !!enabled;
2057    if (_elm_config->cache_flush_enable == enabled) return;
2058    _elm_config->cache_flush_enable = enabled;
2059
2060    _elm_recache();
2061 }
2062
2063 /**
2064  * Set the configured cache flush enabled state for all applications on the
2065  * display
2066  *
2067  * This sets the globally configured cache flush enabled state for all
2068  * applications on the display.
2069  *
2070  * @param size The cache flush enabled state
2071  * @ingroup Caches
2072  */
2073 EAPI void
2074 elm_cache_flush_enabled_all_set(Eina_Bool enabled)
2075 {
2076 #ifdef HAVE_ELEMENTARY_X
2077    static Ecore_X_Atom atom = 0;
2078    unsigned int enabled_i = (unsigned int)enabled;
2079
2080    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_CACHE_FLUSH_ENABLE");
2081    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2082                                   atom, &enabled_i, 1);
2083 #endif
2084 }
2085
2086 /**
2087  * Get the configured font cache size
2088  *
2089  * This gets the globally configured font cache size, in bytes
2090  *
2091  * @return The font cache size
2092  * @ingroup Caches
2093  */
2094 EAPI int
2095 elm_font_cache_get(void)
2096 {
2097    return _elm_config->font_cache;
2098 }
2099
2100 /**
2101  * Set the configured font cache size
2102  *
2103  * This sets the globally configured font cache size, in bytes
2104  *
2105  * @param size The font cache size
2106  * @ingroup Caches
2107  */
2108 EAPI void
2109 elm_font_cache_set(int size)
2110 {
2111    if (_elm_config->font_cache == size) return;
2112    _elm_config->font_cache = size;
2113
2114    _elm_recache();
2115 }
2116
2117 /**
2118  * Set the configured font cache size for all applications on the
2119  * display
2120  *
2121  * This sets the globally configured font cache size -- in bytes
2122  * -- for all applications on the display.
2123  *
2124  * @param size The font cache size
2125  * @ingroup Caches
2126  */
2127 EAPI void
2128 elm_font_cache_all_set(int size)
2129 {
2130 #ifdef HAVE_ELEMENTARY_X
2131    static Ecore_X_Atom atom = 0;
2132    unsigned int size_i = (unsigned int)size;
2133
2134    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FONT_CACHE");
2135    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2136                                   atom, &size_i, 1);
2137 #endif
2138 }
2139
2140 /**
2141  * Get the configured image cache size
2142  *
2143  * This gets the globally configured image cache size, in bytes
2144  *
2145  * @return The image cache size
2146  * @ingroup Caches
2147  */
2148 EAPI int
2149 elm_image_cache_get(void)
2150 {
2151    return _elm_config->image_cache;
2152 }
2153
2154 /**
2155  * Set the configured image cache size
2156  *
2157  * This sets the globally configured image cache size, in bytes
2158  *
2159  * @param size The image cache size
2160  * @ingroup Caches
2161  */
2162 EAPI void
2163 elm_image_cache_set(int size)
2164 {
2165    if (_elm_config->image_cache == size) return;
2166    _elm_config->image_cache = size;
2167
2168    _elm_recache();
2169 }
2170
2171 /**
2172  * Set the configured image cache size for all applications on the
2173  * display
2174  *
2175  * This sets the globally configured image cache size -- in bytes
2176  * -- for all applications on the display.
2177  *
2178  * @param size The image cache size
2179  * @ingroup Caches
2180  */
2181 EAPI void
2182 elm_image_cache_all_set(int size)
2183 {
2184 #ifdef HAVE_ELEMENTARY_X
2185    static Ecore_X_Atom atom = 0;
2186    unsigned int size_i = (unsigned int)size;
2187
2188    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_IMAGE_CACHE");
2189    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2190                                   atom, &size_i, 1);
2191 #endif
2192 }
2193
2194 /**
2195  * Get the configured edje file cache size.
2196  *
2197  * This gets the globally configured edje file cache size, in number
2198  * of files.
2199  *
2200  * @return The edje file cache size
2201  * @ingroup Caches
2202  */
2203 EAPI int
2204 elm_edje_file_cache_get(void)
2205 {
2206    return _elm_config->edje_cache;
2207 }
2208
2209 /**
2210  * Set the configured edje file cache size
2211  *
2212  * This sets the globally configured edje file cache size, in number
2213  * of files.
2214  *
2215  * @param size The edje file cache size
2216  * @ingroup Caches
2217  */
2218 EAPI void
2219 elm_edje_file_cache_set(int size)
2220 {
2221    if (_elm_config->edje_cache == size) return;
2222    _elm_config->edje_cache = size;
2223
2224    _elm_recache();
2225 }
2226
2227 /**
2228  * Set the configured edje file cache size for all applications on the
2229  * display
2230  *
2231  * This sets the globally configured edje file cache size -- in number
2232  * of files -- for all applications on the display.
2233  *
2234  * @param size The edje file cache size
2235  * @ingroup Caches
2236  */
2237 EAPI void
2238 elm_edje_file_cache_all_set(int size)
2239 {
2240 #ifdef HAVE_ELEMENTARY_X
2241    static Ecore_X_Atom atom = 0;
2242    unsigned int size_i = (unsigned int)size;
2243
2244    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_EDJE_FILE_CACHE");
2245    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2246                                   atom, &size_i, 1);
2247 #endif
2248 }
2249
2250 /**
2251  * Get the configured edje collections (groups) cache size.
2252  *
2253  * This gets the globally configured edje collections cache size, in
2254  * number of collections.
2255  *
2256  * @return The edje collections cache size
2257  * @ingroup Caches
2258  */
2259 EAPI int
2260 elm_edje_collection_cache_get(void)
2261 {
2262    return _elm_config->edje_collection_cache;
2263 }
2264
2265 /**
2266  * Set the configured edje collections (groups) cache size
2267  *
2268  * This sets the globally configured edje collections cache size, in
2269  * number of collections.
2270  *
2271  * @param size The edje collections cache size
2272  * @ingroup Caches
2273  */
2274 EAPI void
2275 elm_edje_collection_cache_set(int size)
2276 {
2277    if (_elm_config->edje_collection_cache == size) return;
2278    _elm_config->edje_collection_cache = size;
2279
2280    _elm_recache();
2281 }
2282
2283 /**
2284  * Set the configured edje collections (groups) cache size for all
2285  * applications on the display
2286  *
2287  * This sets the globally configured edje collections cache size -- in
2288  * number of collections -- for all applications on the display.
2289  *
2290  * @param size The edje collections cache size
2291  * @ingroup Caches
2292  */
2293 EAPI void
2294 elm_edje_collection_cache_all_set(int size)
2295 {
2296 #ifdef HAVE_ELEMENTARY_X
2297    static Ecore_X_Atom atom = 0;
2298    unsigned int size_i = (unsigned int)size;
2299
2300    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_EDJE_COLLECTION_CACHE");
2301    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2302                                   atom, &size_i, 1);
2303 #endif
2304 }
2305
2306 EAPI Eina_Bool
2307 elm_object_focus_get(const Evas_Object *obj)
2308 {
2309    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
2310    return elm_widget_focus_get(obj);
2311 }
2312
2313 EAPI void
2314 elm_object_focus(Evas_Object *obj)
2315 {
2316    EINA_SAFETY_ON_NULL_RETURN(obj);
2317    if (elm_widget_focus_get(obj))
2318      return;
2319
2320    elm_widget_focus_cycle(obj, ELM_FOCUS_NEXT);
2321 }
2322
2323 EAPI void
2324 elm_object_unfocus(Evas_Object *obj)
2325 {
2326    EINA_SAFETY_ON_NULL_RETURN(obj);
2327    if (!elm_widget_can_focus_get(obj)) return;
2328    elm_widget_focused_object_clear(obj);
2329 }
2330
2331 EAPI void
2332 elm_object_focus_allow_set(Evas_Object *obj,
2333                            Eina_Bool    enable)
2334 {
2335    EINA_SAFETY_ON_NULL_RETURN(obj);
2336    elm_widget_can_focus_set(obj, enable);
2337 }
2338
2339 EAPI Eina_Bool
2340 elm_object_focus_allow_get(const Evas_Object *obj)
2341 {
2342    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
2343    return (elm_widget_can_focus_get(obj)) || (elm_widget_child_can_focus_get(obj));
2344 }
2345
2346 /**
2347  * Set custom focus chain.
2348  *
2349  * This function i set one new and overwrite any previous custom focus chain
2350  * with the list of objects. The previous list will be deleted and this list
2351  * will be managed. After setted, don't modity it.
2352  *
2353  * @note On focus cycle, only will be evaluated children of this container.
2354  *
2355  * @param obj The container object
2356  * @param objs Chain of objects to pass focus
2357  * @ingroup Focus
2358  */
2359 EAPI void
2360 elm_object_focus_custom_chain_set(Evas_Object *obj,
2361                                   Eina_List   *objs)
2362 {
2363    EINA_SAFETY_ON_NULL_RETURN(obj);
2364    elm_widget_focus_custom_chain_set(obj, objs);
2365 }
2366
2367 /**
2368  * Unset custom focus chain
2369  *
2370  * @param obj The container object
2371  * @ingroup Focus
2372  */
2373 EAPI void
2374 elm_object_focus_custom_chain_unset(Evas_Object *obj)
2375 {
2376    EINA_SAFETY_ON_NULL_RETURN(obj);
2377    elm_widget_focus_custom_chain_unset(obj);
2378 }
2379
2380 /**
2381  * Get custom focus chain
2382  *
2383  * @param obj The container object
2384  * @ingroup Focus
2385  */
2386 EAPI const Eina_List *
2387 elm_object_focus_custom_chain_get(const Evas_Object *obj)
2388 {
2389    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
2390    return elm_widget_focus_custom_chain_get(obj);
2391 }
2392
2393 /**
2394  * Append object to custom focus chain.
2395  *
2396  * @note If relative_child equal to NULL or not in custom chain, the object
2397  * will be added in end.
2398  *
2399  * @note On focus cycle, only will be evaluated children of this container.
2400  *
2401  * @param obj The container object
2402  * @param child The child to be added in custom chain
2403  * @param relative_child The relative object to position the child
2404  * @ingroup Focus
2405  */
2406 EAPI void
2407 elm_object_focus_custom_chain_append(Evas_Object *obj,
2408                                      Evas_Object *child,
2409                                      Evas_Object *relative_child)
2410 {
2411    EINA_SAFETY_ON_NULL_RETURN(obj);
2412    EINA_SAFETY_ON_NULL_RETURN(child);
2413    elm_widget_focus_custom_chain_append(obj, child, relative_child);
2414 }
2415
2416 /**
2417  * Prepend object to custom focus chain.
2418  *
2419  * @note If relative_child equal to NULL or not in custom chain, the object
2420  * will be added in begin.
2421  *
2422  * @note On focus cycle, only will be evaluated children of this container.
2423  *
2424  * @param obj The container object
2425  * @param child The child to be added in custom chain
2426  * @param relative_child The relative object to position the child
2427  * @ingroup Focus
2428  */
2429 EAPI void
2430 elm_object_focus_custom_chain_prepend(Evas_Object *obj,
2431                                       Evas_Object *child,
2432                                       Evas_Object *relative_child)
2433 {
2434    EINA_SAFETY_ON_NULL_RETURN(obj);
2435    EINA_SAFETY_ON_NULL_RETURN(child);
2436    elm_widget_focus_custom_chain_prepend(obj, child, relative_child);
2437 }
2438
2439 /**
2440  * Give focus to next object in object tree.
2441  *
2442  * Give focus to next object in focus chain of one object sub-tree.
2443  * If the last object of chain already have focus, the focus will go to the
2444  * first object of chain.
2445  *
2446  * @param obj The object root of sub-tree
2447  * @param dir Direction to cycle the focus
2448  *
2449  * @ingroup Focus
2450  */
2451 EAPI void
2452 elm_object_focus_cycle(Evas_Object        *obj,
2453                        Elm_Focus_Direction dir)
2454 {
2455    EINA_SAFETY_ON_NULL_RETURN(obj);
2456    elm_widget_focus_cycle(obj, dir);
2457 }
2458
2459 /**
2460  * Give focus to near object in one direction.
2461  *
2462  * Give focus to near object in direction of one object.
2463  * If none focusable object in given direction, the focus will not change.
2464  *
2465  * @param obj The reference object
2466  * @param x Horizontal component of direction to focus
2467  * @param y Vertical component of direction to focus
2468  *
2469  * @ingroup Focus
2470  */
2471 EAPI void
2472 elm_object_focus_direction_go(Evas_Object *obj,
2473                               int          x,
2474                               int          y)
2475 {
2476    EINA_SAFETY_ON_NULL_RETURN(obj);
2477    elm_widget_focus_direction_go(obj, x, y);
2478 }
2479
2480 EAPI void
2481 elm_object_tree_unfocusable_set(Evas_Object *obj,
2482                                 Eina_Bool    tree_unfocusable)
2483 {
2484    EINA_SAFETY_ON_NULL_RETURN(obj);
2485    elm_widget_tree_unfocusable_set(obj, tree_unfocusable);
2486 }
2487
2488 EAPI Eina_Bool
2489 elm_object_tree_unfocusable_get(const Evas_Object *obj)
2490 {
2491    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
2492    return elm_widget_tree_unfocusable_get(obj);
2493 }
2494
2495 /**
2496  * Get the enable status of the focus highlight
2497  *
2498  * This gets whether the highlight on focused objects is enabled or not
2499  * @ingroup Focus
2500  */
2501 EAPI Eina_Bool
2502 elm_focus_highlight_enabled_get(void)
2503 {
2504    return _elm_config->focus_highlight_enable;
2505 }
2506
2507 /**
2508  * Set the enable status of the focus highlight
2509  *
2510  * Set whether to show or not the highlight on focused objects
2511  * @param enable Enable highlight if EINA_TRUE, disable otherwise
2512  * @ingroup Focus
2513  */
2514 EAPI void
2515 elm_focus_highlight_enabled_set(Eina_Bool enable)
2516 {
2517    _elm_config->focus_highlight_enable = !!enable;
2518 }
2519
2520 /**
2521  * Get the enable status of the highlight animation
2522  *
2523  * Get whether the focus highlight, if enabled, will animate its switch from
2524  * one object to the next
2525  * @ingroup Focus
2526  */
2527 EAPI Eina_Bool
2528 elm_focus_highlight_animate_get(void)
2529 {
2530    return _elm_config->focus_highlight_animate;
2531 }
2532
2533 /**
2534  * Set the enable status of the highlight animation
2535  *
2536  * Set whether the focus highlight, if enabled, will animate its switch from
2537  * one object to the next
2538  * @param animate Enable animation if EINA_TRUE, disable otherwise
2539  * @ingroup Focus
2540  */
2541 EAPI void
2542 elm_focus_highlight_animate_set(Eina_Bool animate)
2543 {
2544    _elm_config->focus_highlight_animate = !!animate;
2545 }
2546
2547 /**
2548  * @defgroup Scrolling Scrolling
2549  * @ingroup Main
2550  *
2551  * These are functions setting how scrollable views in Elementary
2552  * widgets should behave on user interaction.
2553  */
2554
2555 /**
2556  * Get whether scrollers should bounce when they reach their
2557  * viewport's edge during a scroll.
2558  *
2559  * @return the thumb scroll bouncing state
2560  *
2561  * This is the default behavior for touch screens, in general.
2562  * @ingroup Scrolling
2563  */
2564 EAPI Eina_Bool
2565 elm_scroll_bounce_enabled_get(void)
2566 {
2567    return _elm_config->thumbscroll_bounce_enable;
2568 }
2569
2570 /**
2571  * Set whether scrollers should bounce when they reach their
2572  * viewport's edge during a scroll.
2573  *
2574  * @param enabled the thumb scroll bouncing state
2575  *
2576  * @see elm_thumbscroll_bounce_enabled_get()
2577  * @ingroup Scrolling
2578  */
2579 EAPI void
2580 elm_scroll_bounce_enabled_set(Eina_Bool enabled)
2581 {
2582    _elm_config->thumbscroll_bounce_enable = enabled;
2583 }
2584
2585 /**
2586  * Set whether scrollers should bounce when they reach their
2587  * viewport's edge during a scroll, for all Elementary application
2588  * windows.
2589  *
2590  * @param enabled the thumb scroll bouncing state
2591  *
2592  * @see elm_thumbscroll_bounce_enabled_get()
2593  * @ingroup Scrolling
2594  */
2595 EAPI void
2596 elm_scroll_bounce_enabled_all_set(Eina_Bool enabled)
2597 {
2598 #ifdef HAVE_ELEMENTARY_X
2599    static Ecore_X_Atom atom = 0;
2600    unsigned int bounce_enable_i = (unsigned int)enabled;
2601
2602    if (!atom)
2603      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BOUNCE_ENABLE");
2604    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2605                                   atom, &bounce_enable_i, 1);
2606 #endif
2607 }
2608
2609 /**
2610  * Get the amount of inertia a scroller will impose at bounce
2611  * animations.
2612  *
2613  * @return the thumb scroll bounce friction
2614  *
2615  * @ingroup Scrolling
2616  */
2617 EAPI double
2618 elm_scroll_bounce_friction_get(void)
2619 {
2620    return _elm_config->thumbscroll_bounce_friction;
2621 }
2622
2623 /**
2624  * Set the amount of inertia a scroller will impose at bounce
2625  * animations.
2626  *
2627  * @param friction the thumb scroll bounce friction
2628  *
2629  * @see elm_thumbscroll_bounce_friction_get()
2630  * @ingroup Scrolling
2631  */
2632 EAPI void
2633 elm_scroll_bounce_friction_set(double friction)
2634 {
2635    _elm_config->thumbscroll_bounce_friction = friction;
2636 }
2637
2638 /**
2639  * Set the amount of inertia a scroller will impose at bounce
2640  * animations, for all Elementary application windows.
2641  *
2642  * @param friction the thumb scroll bounce friction
2643  *
2644  * @see elm_thumbscroll_bounce_friction_get()
2645  * @ingroup Scrolling
2646  */
2647 EAPI void
2648 elm_scroll_bounce_friction_all_set(double friction)
2649 {
2650 #ifdef HAVE_ELEMENTARY_X
2651    static Ecore_X_Atom atom = 0;
2652    unsigned int bounce_friction_i = (unsigned int)(friction * 1000.0);
2653
2654    if (!atom)
2655      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BOUNCE_FRICTION");
2656    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2657                                   atom, &bounce_friction_i, 1);
2658 #endif
2659 }
2660
2661 /**
2662  * Get the amount of inertia a <b>paged</b> scroller will impose at
2663  * page fitting animations.
2664  *
2665  * @return the page scroll friction
2666  *
2667  * @ingroup Scrolling
2668  */
2669 EAPI double
2670 elm_scroll_page_scroll_friction_get(void)
2671 {
2672    return _elm_config->page_scroll_friction;
2673 }
2674
2675 /**
2676  * Set the amount of inertia a <b>paged</b> scroller will impose at
2677  * page fitting animations.
2678  *
2679  * @param friction the page scroll friction
2680  *
2681  * @see elm_thumbscroll_page_scroll_friction_get()
2682  * @ingroup Scrolling
2683  */
2684 EAPI void
2685 elm_scroll_page_scroll_friction_set(double friction)
2686 {
2687    _elm_config->page_scroll_friction = friction;
2688 }
2689
2690 /**
2691  * Set the amount of inertia a <b>paged</b> scroller will impose at
2692  * page fitting animations, for all Elementary application windows.
2693  *
2694  * @param friction the page scroll friction
2695  *
2696  * @see elm_thumbscroll_page_scroll_friction_get()
2697  * @ingroup Scrolling
2698  */
2699 EAPI void
2700 elm_scroll_page_scroll_friction_all_set(double friction)
2701 {
2702 #ifdef HAVE_ELEMENTARY_X
2703    static Ecore_X_Atom atom = 0;
2704    unsigned int page_scroll_friction_i = (unsigned int)(friction * 1000.0);
2705
2706    if (!atom)
2707      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_PAGE_SCROLL_FRICTION");
2708    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2709                                   atom, &page_scroll_friction_i, 1);
2710 #endif
2711 }
2712
2713 /**
2714  * Get the amount of inertia a scroller will impose at region bring
2715  * animations.
2716  *
2717  * @return the bring in scroll friction
2718  *
2719  * @ingroup Scrolling
2720  */
2721 EAPI double
2722 elm_scroll_bring_in_scroll_friction_get(void)
2723 {
2724    return _elm_config->bring_in_scroll_friction;
2725 }
2726
2727 /**
2728  * Set the amount of inertia a scroller will impose at region bring
2729  * animations.
2730  *
2731  * @param friction the bring in scroll friction
2732  *
2733  * @see elm_thumbscroll_bring_in_scroll_friction_get()
2734  * @ingroup Scrolling
2735  */
2736 EAPI void
2737 elm_scroll_bring_in_scroll_friction_set(double friction)
2738 {
2739    _elm_config->bring_in_scroll_friction = friction;
2740 }
2741
2742 /**
2743  * Set the amount of inertia a scroller will impose at region bring
2744  * animations, for all Elementary application windows.
2745  *
2746  * @param friction the bring in scroll friction
2747  *
2748  * @see elm_thumbscroll_bring_in_scroll_friction_get()
2749  * @ingroup Scrolling
2750  */
2751 EAPI void
2752 elm_scroll_bring_in_scroll_friction_all_set(double friction)
2753 {
2754 #ifdef HAVE_ELEMENTARY_X
2755    static Ecore_X_Atom atom = 0;
2756    unsigned int bring_in_scroll_friction_i = (unsigned int)(friction * 1000.0);
2757
2758    if (!atom)
2759      atom =
2760        ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BRING_IN_SCROLL_FRICTION");
2761    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2762                                   atom, &bring_in_scroll_friction_i, 1);
2763 #endif
2764 }
2765
2766 /**
2767  * Get the amount of inertia scrollers will impose at animations
2768  * triggered by Elementary widgets' zooming API.
2769  *
2770  * @return the zoom friction
2771  *
2772  * @ingroup Scrolling
2773  */
2774 EAPI double
2775 elm_scroll_zoom_friction_get(void)
2776 {
2777    return _elm_config->zoom_friction;
2778 }
2779
2780 /**
2781  * Set the amount of inertia scrollers will impose at animations
2782  * triggered by Elementary widgets' zooming API.
2783  *
2784  * @param friction the zoom friction
2785  *
2786  * @see elm_thumbscroll_zoom_friction_get()
2787  * @ingroup Scrolling
2788  */
2789 EAPI void
2790 elm_scroll_zoom_friction_set(double friction)
2791 {
2792    _elm_config->zoom_friction = friction;
2793 }
2794
2795 /**
2796  * Set the amount of inertia scrollers will impose at animations
2797  * triggered by Elementary widgets' zooming API, for all Elementary
2798  * application windows.
2799  *
2800  * @param friction the zoom friction
2801  *
2802  * @see elm_thumbscroll_zoom_friction_get()
2803  * @ingroup Scrolling
2804  */
2805 EAPI void
2806 elm_scroll_zoom_friction_all_set(double friction)
2807 {
2808 #ifdef HAVE_ELEMENTARY_X
2809    static Ecore_X_Atom atom = 0;
2810    unsigned int zoom_friction_i = (unsigned int)(friction * 1000.0);
2811
2812    if (!atom)
2813      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_ZOOM_FRICTION");
2814    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2815                                   atom, &zoom_friction_i, 1);
2816 #endif
2817 }
2818
2819 /**
2820  * Get whether scrollers should be draggable from any point in their
2821  * views.
2822  *
2823  * @return the thumb scroll state
2824  *
2825  * @note This is the default behavior for touch screens, in general.
2826  * @note All other functions namespaced with "thumbscroll" will only
2827  *       have effect if this mode is enabled.
2828  *
2829  * @ingroup Scrolling
2830  */
2831 EAPI Eina_Bool
2832 elm_scroll_thumbscroll_enabled_get(void)
2833 {
2834    return _elm_config->thumbscroll_enable;
2835 }
2836
2837 /**
2838  * Set whether scrollers should be draggable from any point in their
2839  * views.
2840  *
2841  * @param enabled the thumb scroll state
2842  *
2843  * @see elm_thumbscroll_enabled_get()
2844  * @ingroup Scrolling
2845  */
2846 EAPI void
2847 elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled)
2848 {
2849    _elm_config->thumbscroll_enable = enabled;
2850 }
2851
2852 /**
2853  * Set whether scrollers should be draggable from any point in their
2854  * views, for all Elementary application windows.
2855  *
2856  * @param enabled the thumb scroll state
2857  *
2858  * @see elm_thumbscroll_enabled_get()
2859  * @ingroup Scrolling
2860  */
2861 EAPI void
2862 elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled)
2863 {
2864 #ifdef HAVE_ELEMENTARY_X
2865    static Ecore_X_Atom atom = 0;
2866    unsigned int ts_enable_i = (unsigned int)enabled;
2867
2868    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_ENABLE");
2869    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2870                                   atom, &ts_enable_i, 1);
2871 #endif
2872 }
2873
2874 /**
2875  * Get the number of pixels one should travel while dragging a
2876  * scroller's view to actually trigger scrolling.
2877  *
2878  * @return the thumb scroll threshould
2879  *
2880  * One would use higher values for touch screens, in general, because
2881  * of their inherent imprecision.
2882  * @ingroup Scrolling
2883  */
2884 EAPI unsigned int
2885 elm_scroll_thumbscroll_threshold_get(void)
2886 {
2887    return _elm_config->thumbscroll_threshold;
2888 }
2889
2890 /**
2891  * Set the number of pixels one should travel while dragging a
2892  * scroller's view to actually trigger scrolling.
2893  *
2894  * @param threshold the thumb scroll threshould
2895  *
2896  * @see elm_thumbscroll_threshould_get()
2897  * @ingroup Scrolling
2898  */
2899 EAPI void
2900 elm_scroll_thumbscroll_threshold_set(unsigned int threshold)
2901 {
2902    _elm_config->thumbscroll_threshold = threshold;
2903 }
2904
2905 /**
2906  * Set the number of pixels one should travel while dragging a
2907  * scroller's view to actually trigger scrolling, for all Elementary
2908  * application windows.
2909  *
2910  * @param threshold the thumb scroll threshould
2911  *
2912  * @see elm_thumbscroll_threshould_get()
2913  * @ingroup Scrolling
2914  */
2915 EAPI void
2916 elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold)
2917 {
2918 #ifdef HAVE_ELEMENTARY_X
2919    static Ecore_X_Atom atom = 0;
2920    unsigned int ts_threshold_i = (unsigned int)threshold;
2921
2922    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_THRESHOLD");
2923    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2924                                   atom, &ts_threshold_i, 1);
2925 #endif
2926 }
2927
2928 /**
2929  * Get the minimum speed of mouse cursor movement which will trigger
2930  * list self scrolling animation after a mouse up event
2931  * (pixels/second).
2932  *
2933  * @return the thumb scroll momentum threshould
2934  *
2935  * @ingroup Scrolling
2936  */
2937 EAPI double
2938 elm_scroll_thumbscroll_momentum_threshold_get(void)
2939 {
2940    return _elm_config->thumbscroll_momentum_threshold;
2941 }
2942
2943 /**
2944  * Set the minimum speed of mouse cursor movement which will trigger
2945  * list self scrolling animation after a mouse up event
2946  * (pixels/second).
2947  *
2948  * @param threshold the thumb scroll momentum threshould
2949  *
2950  * @see elm_thumbscroll_momentum_threshould_get()
2951  * @ingroup Scrolling
2952  */
2953 EAPI void
2954 elm_scroll_thumbscroll_momentum_threshold_set(double threshold)
2955 {
2956    _elm_config->thumbscroll_momentum_threshold = threshold;
2957 }
2958
2959 /**
2960  * Set the minimum speed of mouse cursor movement which will trigger
2961  * list self scrolling animation after a mouse up event
2962  * (pixels/second), for all Elementary application windows.
2963  *
2964  * @param threshold the thumb scroll momentum threshould
2965  *
2966  * @see elm_thumbscroll_momentum_threshould_get()
2967  * @ingroup Scrolling
2968  */
2969 EAPI void
2970 elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold)
2971 {
2972 #ifdef HAVE_ELEMENTARY_X
2973    static Ecore_X_Atom atom = 0;
2974    unsigned int ts_momentum_threshold_i = (unsigned int)(threshold * 1000.0);
2975
2976    if (!atom)
2977      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_MOMENTUM_THRESHOLD");
2978    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2979                                   atom, &ts_momentum_threshold_i, 1);
2980 #endif
2981 }
2982
2983 /**
2984  * Get the amount of inertia a scroller will impose at self scrolling
2985  * animations.
2986  *
2987  * @return the thumb scroll friction
2988  *
2989  * @ingroup Scrolling
2990  */
2991 EAPI double
2992 elm_scroll_thumbscroll_friction_get(void)
2993 {
2994    return _elm_config->thumbscroll_friction;
2995 }
2996
2997 /**
2998  * Set the amount of inertia a scroller will impose at self scrolling
2999  * animations.
3000  *
3001  * @param friction the thumb scroll friction
3002  *
3003  * @see elm_thumbscroll_friction_get()
3004  * @ingroup Scrolling
3005  */
3006 EAPI void
3007 elm_scroll_thumbscroll_friction_set(double friction)
3008 {
3009    _elm_config->thumbscroll_friction = friction;
3010 }
3011
3012 /**
3013  * Set the amount of inertia a scroller will impose at self scrolling
3014  * animations, for all Elementary application windows.
3015  *
3016  * @param friction the thumb scroll friction
3017  *
3018  * @see elm_thumbscroll_friction_get()
3019  * @ingroup Scrolling
3020  */
3021 EAPI void
3022 elm_scroll_thumbscroll_friction_all_set(double friction)
3023 {
3024 #ifdef HAVE_ELEMENTARY_X
3025    static Ecore_X_Atom atom = 0;
3026    unsigned int ts_friction_i = (unsigned int)(friction * 1000.0);
3027
3028    if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_FRICTION");
3029    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
3030                                   atom, &ts_friction_i, 1);
3031 #endif
3032 }
3033
3034 /**
3035  * Get the amount of lag between your actual mouse cursor dragging
3036  * movement and a scroller's view movement itself, while pushing it
3037  * into bounce state manually.
3038  *
3039  * @return the thumb scroll border friction
3040  *
3041  * @ingroup Scrolling
3042  */
3043 EAPI double
3044 elm_scroll_thumbscroll_border_friction_get(void)
3045 {
3046    return _elm_config->thumbscroll_border_friction;
3047 }
3048
3049 /**
3050  * Set the amount of lag between your actual mouse cursor dragging
3051  * movement and a scroller's view movement itself, while pushing it
3052  * into bounce state manually.
3053  *
3054  * @param friction the thumb scroll border friction. @c 0.0 for
3055  *        perfect synchrony between two movements, @c 1.0 for maximum
3056  *        lag.
3057  *
3058  * @see elm_thumbscroll_border_friction_get()
3059  * @note parameter value will get bound to 0.0 - 1.0 interval, always
3060  *
3061  * @ingroup Scrolling
3062  */
3063 EAPI void
3064 elm_scroll_thumbscroll_border_friction_set(double friction)
3065 {
3066    if (friction < 0.0)
3067      friction = 0.0;
3068
3069    if (friction > 1.0)
3070      friction = 1.0;
3071
3072    _elm_config->thumbscroll_friction = friction;
3073 }
3074
3075 /**
3076  * Set the amount of lag between your actual mouse cursor dragging
3077  * movement and a scroller's view movement itself, while pushing it
3078  * into bounce state manually, for all Elementary application windows.
3079  *
3080  * @param friction the thumb scroll border friction. @c 0.0 for
3081  *        perfect synchrony between two movements, @c 1.0 for maximum
3082  *        lag.
3083  *
3084  * @see elm_thumbscroll_border_friction_get()
3085  * @note parameter value will get bound to 0.0 - 1.0 interval, always
3086  *
3087  * @ingroup Scrolling
3088  */
3089 EAPI void
3090 elm_scroll_thumbscroll_border_friction_all_set(double friction)
3091 {
3092    if (friction < 0.0)
3093      friction = 0.0;
3094
3095    if (friction > 1.0)
3096      friction = 1.0;
3097
3098 #ifdef HAVE_ELEMENTARY_X
3099    static Ecore_X_Atom atom = 0;
3100    unsigned int border_friction_i = (unsigned int)(friction * 1000.0);
3101
3102    if (!atom)
3103      atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BORDER_FRICTION");
3104    ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
3105                                   atom, &border_friction_i, 1);
3106 #endif
3107 }
3108
3109 /**
3110  * @defgroup Scrollhints Scrollhints
3111  * @ingroup Main
3112  *
3113  * Objects when inside a scroller can scroll, but this may not always be
3114  * desirable in certain situations. This allows an object to hint to itself
3115  * and parents to "not scroll" in one of 2 ways.
3116  *
3117  * 1. To hold on scrolling. This means just flicking and dragging may no
3118  * longer scroll, but pressing/dragging near an edge of the scroller will
3119  * still scroll. This is automastically used by the entry object when
3120  * selecting text.
3121  * 2. To totally freeze scrolling. This means it stops. until popped/released.
3122  */
3123
3124 /**
3125  * Push the scroll hold by 1
3126  *
3127  * This increments the scroll hold count by one. If it is more than 0 it will
3128  * take effect on the parents of the indicated object.
3129  *
3130  * @param obj The object
3131  * @ingroup Scrollhints
3132  */
3133 EAPI void
3134 elm_object_scroll_hold_push(Evas_Object *obj)
3135 {
3136    EINA_SAFETY_ON_NULL_RETURN(obj);
3137    elm_widget_scroll_hold_push(obj);
3138 }
3139
3140 /**
3141  * Pop the scroll hold by 1
3142  *
3143  * This decrements the scroll hold count by one. If it is more than 0 it will
3144  * take effect on the parents of the indicated object.
3145  *
3146  * @param obj The object
3147  * @ingroup Scrollhints
3148  */
3149 EAPI void
3150 elm_object_scroll_hold_pop(Evas_Object *obj)
3151 {
3152    EINA_SAFETY_ON_NULL_RETURN(obj);
3153    elm_widget_scroll_hold_pop(obj);
3154 }
3155
3156 /**
3157  * Push the scroll freeze by 1
3158  *
3159  * This increments the scroll freeze count by one. If it is more than 0 it will
3160  * take effect on the parents of the indicated object.
3161  *
3162  * @param obj The object
3163  * @ingroup Scrollhints
3164  */
3165 EAPI void
3166 elm_object_scroll_freeze_push(Evas_Object *obj)
3167 {
3168    EINA_SAFETY_ON_NULL_RETURN(obj);
3169    elm_widget_scroll_freeze_push(obj);
3170 }
3171
3172 /**
3173  * Lock the scrolling of the given widget (and thus all parents)
3174  *
3175  * This locks the given object from scrolling in the X axis (and implicitly
3176  * also locks all parent scrollers too from doing the same).
3177  *
3178  * @param obj The object
3179  * @param lock The lock state (1 == locked, 0 == unlocked)
3180  * @ingroup Scrollhints
3181  */
3182 EAPI void
3183 elm_object_scroll_lock_x_set(Evas_Object *obj,
3184                              Eina_Bool    lock)
3185 {
3186    EINA_SAFETY_ON_NULL_RETURN(obj);
3187    elm_widget_drag_lock_x_set(obj, lock);
3188 }
3189
3190 /**
3191  * Lock the scrolling of the given widget (and thus all parents)
3192  *
3193  * This locks the given object from scrolling in the Y axis (and implicitly
3194  * also locks all parent scrollers too from doing the same).
3195  *
3196  * @param obj The object
3197  * @param lock The lock state (1 == locked, 0 == unlocked)
3198  * @ingroup Scrollhints
3199  */
3200 EAPI void
3201 elm_object_scroll_lock_y_set(Evas_Object *obj,
3202                              Eina_Bool    lock)
3203 {
3204    EINA_SAFETY_ON_NULL_RETURN(obj);
3205    elm_widget_drag_lock_y_set(obj, lock);
3206 }
3207
3208 /**
3209  * Get the scrolling lock of the given widget
3210  *
3211  * This gets the lock for X axis scrolling.
3212  *
3213  * @param obj The object
3214  * @ingroup Scrollhints
3215  */
3216 EAPI Eina_Bool
3217 elm_object_scroll_lock_x_get(const Evas_Object *obj)
3218 {
3219    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3220    return elm_widget_drag_lock_x_get(obj);
3221 }
3222
3223 /**
3224  * Get the scrolling lock of the given widget
3225  *
3226  * This gets the lock for X axis scrolling.
3227  *
3228  * @param obj The object
3229  * @ingroup Scrollhints
3230  */
3231 EAPI Eina_Bool
3232 elm_object_scroll_lock_y_get(const Evas_Object *obj)
3233 {
3234    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3235    return elm_widget_drag_lock_y_get(obj);
3236 }
3237
3238 /**
3239  * Pop the scroll freeze by 1
3240  *
3241  * This decrements the scroll freeze count by one. If it is more than 0 it will
3242  * take effect on the parents of the indicated object.
3243  *
3244  * @param obj The object
3245  * @ingroup Scrollhints
3246  */
3247 EAPI void
3248 elm_object_scroll_freeze_pop(Evas_Object *obj)
3249 {
3250    EINA_SAFETY_ON_NULL_RETURN(obj);
3251    elm_widget_scroll_freeze_pop(obj);
3252 }
3253
3254 /**
3255  * Check if the given Evas Object is an Elementary widget.
3256  *
3257  * @param obj the object to query.
3258  * @return @c EINA_TRUE if it is an elementary widget variant,
3259  *         @c EINA_FALSE otherwise
3260  * @ingroup WidgetNavigation
3261  */
3262 EAPI Eina_Bool
3263 elm_object_widget_check(const Evas_Object *obj)
3264 {
3265    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3266    return elm_widget_is(obj);
3267 }
3268
3269 EAPI Evas_Object *
3270 elm_object_parent_widget_get(const Evas_Object *obj)
3271 {
3272    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3273    return elm_widget_parent_widget_get(obj);
3274 }
3275
3276 /**
3277  * Get the top level parent of an Elementary widget.
3278  *
3279  * @param obj The object to query.
3280  * @return The top level Elementary widget, or @c NULL if parent cannot be
3281  * found.
3282  * @ingroup WidgetNavigation
3283  */
3284 EAPI Evas_Object *
3285 elm_object_top_widget_get(const Evas_Object *obj)
3286 {
3287    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3288    return elm_widget_top_get(obj);
3289 }
3290
3291 /**
3292  * Get the string that represents this Elementary widget.
3293  *
3294  * @note Elementary is weird and exposes itself as a single
3295  *       Evas_Object_Smart_Class of type "elm_widget", so
3296  *       evas_object_type_get() always return that, making debug and
3297  *       language bindings hard. This function tries to mitigate this
3298  *       problem, but the solution is to change Elementary to use
3299  *       proper inheritance.
3300  *
3301  * @param obj the object to query.
3302  * @return Elementary widget name, or @c NULL if not a valid widget.
3303  * @ingroup WidgetNavigation
3304  */
3305 EAPI const char *
3306 elm_object_widget_type_get(const Evas_Object *obj)
3307 {
3308    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3309    return elm_widget_type_get(obj);
3310 }
3311
3312 /**
3313  * Send a signal to the widget edje object.
3314  *
3315  * This function sends a signal to the edje object of the obj. An edje program
3316  * can respond to a signal by specifying matching 'signal' and
3317  * 'source' fields.
3318  *
3319  * @param obj The object
3320  * @param emission The signal's name.
3321  * @param source The signal's source.
3322  * @ingroup General
3323  */
3324 EAPI void
3325 elm_object_signal_emit(Evas_Object *obj,
3326                        const char  *emission,
3327                        const char  *source)
3328 {
3329    EINA_SAFETY_ON_NULL_RETURN(obj);
3330    elm_widget_signal_emit(obj, emission, source);
3331 }
3332
3333 /**
3334  * Add a callback for a signal emitted by widget edje object.
3335  *
3336  * This function connects a callback function to a signal emitted by the
3337  * edje object of the obj.
3338  * Globs can occur in either the emission or source name.
3339  *
3340  * @param obj The object
3341  * @param emission The signal's name.
3342  * @param source The signal's source.
3343  * @param func The callback function to be executed when the signal is
3344  * emitted.
3345  * @param data A pointer to data to pass in to the callback function.
3346  * @ingroup General
3347  */
3348 EAPI void
3349 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)
3350 {
3351     EINA_SAFETY_ON_NULL_RETURN(obj);
3352     EINA_SAFETY_ON_NULL_RETURN(func);
3353     elm_widget_signal_callback_add(obj, emission, source, func, data);
3354 }
3355
3356 /**
3357  * Remove a signal-triggered callback from an widget edje object.
3358  *
3359  * This function removes a callback, previoulsy attached to a signal emitted
3360  * by the edje object of the obj.
3361  * The parameters emission, source and func must match exactly those passed to
3362  * a previous call to elm_object_signal_callback_add(). The data pointer that
3363  * was passed to this call will be returned.
3364  *
3365  * @param obj The object
3366  * @param emission The signal's name.
3367  * @param source The signal's source.
3368  * @param func The callback function to be executed when the signal is
3369  * emitted.
3370  * @return The data pointer
3371  * @ingroup General
3372  */
3373 EAPI void *
3374 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))
3375 {
3376     EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3377     EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
3378     return elm_widget_signal_callback_del(obj, emission, source, func);
3379 }
3380
3381 /**
3382  * Add a callback for a event emitted by widget or their children.
3383  *
3384  * This function connects a callback function to any key_down key_up event
3385  * emitted by the @p obj or their children.
3386  * This only will be called if no other callback has consumed the event.
3387  * If you want consume the event, and no other get it, func should return
3388  * EINA_TRUE and put EVAS_EVENT_FLAG_ON_HOLD in event_flags.
3389  *
3390  * @warning Accept duplicated callback addition.
3391  *
3392  * @param obj The object
3393  * @param func The callback function to be executed when the event is
3394  * emitted.
3395  * @param data Data to pass in to the callback function.
3396  * @ingroup General
3397  */
3398 EAPI void
3399 elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data)
3400 {
3401    EINA_SAFETY_ON_NULL_RETURN(obj);
3402    EINA_SAFETY_ON_NULL_RETURN(func);
3403    elm_widget_event_callback_add(obj, func, data);
3404 }
3405
3406 /**
3407  * Remove a event callback from an widget.
3408  *
3409  * This function removes a callback, previoulsy attached to event emission
3410  * by the @p obj.
3411  * The parameters func and data must match exactly those passed to
3412  * a previous call to elm_object_event_callback_add(). The data pointer that
3413  * was passed to this call will be returned.
3414  *
3415  * @param obj The object
3416  * @param func The callback function to be executed when the event is
3417  * emitted.
3418  * @param data Data to pass in to the callback function.
3419  * @return The data pointer
3420  * @ingroup General
3421  */
3422 EAPI void *
3423 elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data)
3424 {
3425    EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3426    EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
3427    return elm_widget_event_callback_del(obj, func, data);
3428 }
3429
3430
3431 /**
3432  * @defgroup Debug Debug
3433  * @ingroup Main
3434  */
3435
3436 /**
3437  * Print Tree object hierarchy in stdout
3438  *
3439  * @param obj The root object
3440  * @ingroup Debug
3441  */
3442 EAPI void
3443 elm_object_tree_dump(const Evas_Object *top)
3444 {
3445 #ifdef ELM_DEBUG
3446    elm_widget_tree_dump(top);
3447 #else
3448    return;
3449    (void)top;
3450 #endif
3451 }
3452
3453 /**
3454  * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3455  *
3456  * @param obj The root object
3457  * @param file The path of output file
3458  * @ingroup Debug
3459  */
3460 EAPI void
3461 elm_object_tree_dot_dump(const Evas_Object *top,
3462                          const char        *file)
3463 {
3464 #ifdef ELM_DEBUG
3465    FILE *f = fopen(file, "wb");
3466    elm_widget_tree_dot_dump(top, f);
3467    fclose(f);
3468 #else
3469    return;
3470    (void)top;
3471    (void)file;
3472 #endif
3473 }
3474
3475 /**
3476  * Set the duration for occuring long press event.
3477  *
3478  * @param lonpress_timeout Timeout for long press event
3479  * @ingroup Longpress
3480  */
3481 EAPI void
3482 elm_longpress_timeout_set(double longpress_timeout)
3483 {
3484    _elm_config->longpress_timeout = longpress_timeout;
3485 }
3486
3487 /**
3488  * Get the duration for occuring long press event.
3489  *
3490  * @return Timeout for long press event
3491  * @ingroup Longpress
3492  */
3493 EAPI double
3494 elm_longpress_timeout_get(void)
3495 {
3496    return _elm_config->longpress_timeout;
3497 }