2 # include "elementary_config.h"
5 #include <dlfcn.h> /* dlopen,dlclose,etc */
7 #ifdef HAVE_CRT_EXTERNS_H
8 # include <crt_externs.h>
15 #include <Elementary.h>
18 #define SEMI_BROKEN_QUICKLAUNCH 1
20 static Elm_Version _version = { VMAJ, VMIN, VMIC, VREV };
21 EAPI Elm_Version *elm_version = &_version;
26 * This group includes functions of elm_main.c
31 _elm_dangerous_call_check(const char *call)
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)))
40 printf("ELEMENTARY FINGER WAGGLE!!!!!!!!!!\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"
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"
57 * @defgroup Start Getting Started
60 * To write an Elementary app, you can get started with the following:
63 * #include <Elementary.h>
64 * #ifndef ELM_LIB_QUICKLAUNCH
66 * elm_main(int argc, char **argv)
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
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.
84 * configure.in/configure.ac:
87 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
89 AC_CONFIG_SRCDIR(configure.in)
91 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
92 AM_CONFIG_HEADER(config.h)
102 define([AC_LIBTOOL_LANG_CXX_CONFIG], [:])dnl
103 define([AC_LIBTOOL_LANG_F77_CONFIG], [:])dnl
106 PKG_CHECK_MODULES([ELEMENTARY], elementary)
114 AUTOMAKE_OPTIONS = 1.4 foreign
115 MAINTAINERCLEANFILES = Makefile.in
117 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
120 myapp_LTLIBRARIES = myapp.la
124 myapp_la_SOURCES = main.c
125 myapp_la_LIBADD = @ELEMENTARY_LIBS@
127 myapp_la_LDFLAGS = -module -avoid-version -no-undefined
129 myapp_SOURCES = main.c
130 myapp_LDADD = @ELEMENTARY_LIBS@
131 myapp_CFLAGS = -DELM_LIB_QUICKLAUNCH=1
138 rm -rf autom4te.cache
139 rm -f aclocal.m4 ltmain.sh
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
150 if [ -z "$NOCONFIGURE" ]; then
155 * To gnerate all the things needed to bootstrap just run:
161 * This will generate Makefile.in's, the confgure script and everything else.
162 * After this it works like all normal autotools projects:
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:
174 ./confiugre --prefix=$HOME/mysoftware
177 * Also remember that autotools buys you some useful commands like:
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
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.
206 * This cleans up all build files (binaries, objects etc.) from the tree.
212 * This cleans out all files from the build and from configure's output too.
215 make maintainer-clean
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).
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:
230 * 1. delete the myapp binary. i.e. rm /usr/local/bin/myapp
232 * 2. symlink the myapp binary to elementary_run (supplied by elementary).
233 * i.e. ln -s elmentary_run /usr/local/bin/myapp
235 * 3. run elementary_quicklaunch as part of your graphical login session and
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.
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
249 * configure.in/configure.ac:
252 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
254 AC_CONFIG_SRCDIR(configure.in)
256 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
257 AM_CONFIG_HEADER(config.h)
266 PKG_CHECK_MODULES([ELEMENTARY], elementary)
274 AUTOMAKE_OPTIONS = 1.4 foreign
275 MAINTAINERCLEANFILES = Makefile.in
277 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
281 myapp_SOURCES = main.c
282 myapp_LDADD = @ELEMENTARY_LIBS@
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
297 static Eina_Bool _elm_signal_exit(void *data,
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;
307 EAPI int ELM_EVENT_POLICY_CHANGED = 0;
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;
317 _elm_signal_exit(void *data __UNUSED__,
318 int ev_type __UNUSED__,
322 return ECORE_CALLBACK_PASS_ON;
328 edje_scale_set(_elm_config->scale);
329 _elm_win_rescale(NULL, EINA_FALSE);
332 static void *app_mainfunc = NULL;
333 static const char *app_domain = NULL;
334 static const char *app_checkfile = NULL;
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;
346 static Eina_Prefix *app_pfx = NULL;
353 const char *dirs[4] = { NULL, NULL, NULL, NULL };
354 char *caps = NULL, *p1, *p2;
357 if (!app_domain) return;
359 ecore_app_args_get(&argc, &argv);
360 if (argc < 1) return;
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;
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];
374 caps = alloca(strlen(app_domain) + 1);
375 for (p1 = (char *)app_domain, p2 = caps; *p1; p1++, p2++)
379 app_pfx = eina_prefix_new(argv[0], app_mainfunc, caps, app_domain,
380 app_checkfile, dirs[0], dirs[1], dirs[2], dirs[3]);
384 _prefix_shutdown(void)
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);
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;
409 app_locale_dir = NULL;
418 if (_elm_init_count > 1) return _elm_init_count;
419 elm_quicklaunch_init(argc, argv);
420 elm_quicklaunch_sub_init(argc, argv);
422 return _elm_init_count;
429 if (_elm_init_count > 0) return _elm_init_count;
431 while (_elm_win_deferred_free) ecore_main_loop_iterate();
433 // _prefix_shutdown();
434 elm_quicklaunch_sub_shutdown();
435 elm_quicklaunch_shutdown();
436 return _elm_init_count;
440 elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile)
442 app_mainfunc = mainfunc;
443 eina_stringshare_replace(&app_domain, dom);
444 eina_stringshare_replace(&app_checkfile, checkfile);
448 elm_app_compile_bin_dir_set(const char *dir)
450 eina_stringshare_replace(&app_compile_bin_dir, dir);
454 elm_app_compile_lib_dir_set(const char *dir)
456 eina_stringshare_replace(&app_compile_lib_dir, dir);
460 elm_app_compile_data_dir_set(const char *dir)
462 eina_stringshare_replace(&app_compile_data_dir, dir);
466 elm_app_compile_locale_set(const char *dir)
468 eina_stringshare_replace(&app_compile_locale_dir, dir);
472 elm_app_prefix_dir_get(void)
474 if (app_prefix_dir) return app_prefix_dir;
476 if (!app_pfx) return "";
477 app_prefix_dir = eina_prefix_get(app_pfx);
478 return app_prefix_dir;
482 elm_app_bin_dir_get(void)
484 if (app_bin_dir) return app_bin_dir;
486 if (!app_pfx) return "";
487 app_bin_dir = eina_prefix_bin_get(app_pfx);
492 elm_app_lib_dir_get(void)
494 if (app_lib_dir) return app_lib_dir;
496 if (!app_pfx) return "";
497 app_lib_dir = eina_prefix_lib_get(app_pfx);
502 elm_app_data_dir_get(void)
504 if (app_data_dir) return app_data_dir;
506 if (!app_pfx) return "";
507 app_data_dir = eina_prefix_data_get(app_pfx);
512 elm_app_locale_dir_get(void)
514 if (app_locale_dir) return app_locale_dir;
516 if (!app_pfx) return "";
517 app_locale_dir = eina_prefix_locale_get(app_pfx);
518 return app_locale_dir;
522 static int _elm_need_e_dbus = 0;
525 elm_need_e_dbus(void)
528 if (_elm_need_e_dbus++) return EINA_TRUE;
537 _elm_unneed_e_dbus(void)
540 if (--_elm_need_e_dbus) return;
542 _elm_need_e_dbus = 0;
548 static int _elm_need_efreet = 0;
551 elm_need_efreet(void)
554 if (_elm_need_efreet++) return EINA_TRUE;
562 list = efreet_icon_extra_list_get();
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));
579 _elm_unneed_efreet(void)
582 if (--_elm_need_efreet) return;
584 _elm_need_efreet = 0;
585 efreet_trash_shutdown();
586 efreet_mime_shutdown();
592 elm_quicklaunch_mode_set(Eina_Bool ql_on)
594 quicklaunch_on = ql_on;
598 elm_quicklaunch_mode_get(void)
600 return quicklaunch_on;
604 elm_quicklaunch_init(int argc,
607 _elm_ql_init_count++;
608 if (_elm_ql_init_count > 1) return _elm_ql_init_count;
610 _elm_log_dom = eina_log_domain_register("elementary", EINA_COLOR_LIGHTBLUE);
613 EINA_LOG_ERR("could not register elementary log domain.");
614 _elm_log_dom = EINA_LOG_DOMAIN_GLOBAL;
620 #ifdef HAVE_ELEMENTARY_EMAP
623 ecore_app_args_set(argc, (const char **)argv);
625 memset(_elm_policies, 0, sizeof(_elm_policies));
626 if (!ELM_EVENT_POLICY_CHANGED)
627 ELM_EVENT_POLICY_CHANGED = ecore_event_type_new();
631 _elm_exit_handler = ecore_event_handler_add(ECORE_EVENT_SIGNAL_EXIT, _elm_signal_exit, NULL);
633 if (argv) _elm_appname = strdup(ecore_file_file_get(argv[0]));
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 */
643 _elm_data_dir = eina_stringshare_add(eina_prefix_data_get(pfx));
644 _elm_lib_dir = eina_stringshare_add(eina_prefix_lib_get(pfx));
646 if (!_elm_data_dir) _elm_data_dir = eina_stringshare_add("/");
647 if (!_elm_lib_dir) _elm_lib_dir = eina_stringshare_add("/");
650 return _elm_ql_init_count;
654 elm_quicklaunch_sub_init(int argc,
657 _elm_sub_init_count++;
658 if (_elm_sub_init_count > 1) return _elm_sub_init_count;
661 #ifdef SEMI_BROKEN_QUICKLAUNCH
662 return _elm_sub_init_count;
667 ecore_app_args_set(argc, (const char **)argv);
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
679 #ifdef HAVE_ELEMENTARY_X
683 ecore_evas_init(); // FIXME: check errors
686 return _elm_sub_init_count;
690 elm_quicklaunch_sub_shutdown(void)
692 _elm_sub_init_count--;
693 if (_elm_sub_init_count > 0) return _elm_sub_init_count;
696 #ifdef SEMI_BROKEN_QUICKLAUNCH
697 return _elm_sub_init_count;
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
713 #ifdef HAVE_ELEMENTARY_X
714 ecore_x_disconnect();
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();
732 return _elm_sub_init_count;
736 elm_quicklaunch_shutdown(void)
738 _elm_ql_init_count--;
739 if (_elm_ql_init_count > 0) return _elm_ql_init_count;
740 if (pfx) eina_prefix_free(pfx);
742 eina_stringshare_del(_elm_data_dir);
743 _elm_data_dir = NULL;
744 eina_stringshare_del(_elm_lib_dir);
750 _elm_config_shutdown();
752 ecore_event_handler_del(_elm_exit_handler);
753 _elm_exit_handler = NULL;
755 _elm_theme_shutdown();
756 _elm_unneed_efreet();
757 _elm_unneed_e_dbus();
758 _elm_unneed_ethumb();
759 ecore_file_shutdown();
761 #ifdef HAVE_ELEMENTARY_EMAP
768 if ((_elm_log_dom > -1) && (_elm_log_dom != EINA_LOG_DOMAIN_GLOBAL))
770 eina_log_domain_unregister(_elm_log_dom);
774 _elm_widget_type_clear();
777 return _elm_ql_init_count;
781 elm_quicklaunch_seed(void)
783 #ifndef SEMI_BROKEN_QUICKLAUNCH
786 Evas_Object *win, *bg, *bt;
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
805 # ifdef HAVE_ELEMENTARY_X
809 ecore_main_loop_iterate();
814 static void *qr_handle = NULL;
815 static int (*qr_main)(int argc,
819 elm_quicklaunch_prepare(int argc __UNUSED__,
823 char *exe = elm_quicklaunch_exe_path_get(argv[0]);
826 ERR("requested quicklaunch binary '%s' does not exist\n", argv[0]);
834 exe2 = malloc(strlen(exe) + 1 + 10);
836 p = strrchr(exe2, '/');
839 exename = alloca(strlen(p) + 1);
842 strcat(p, "../lib/");
845 if (!access(exe2, R_OK | X_OK))
853 qr_handle = dlopen(exe, RTLD_NOW | RTLD_GLOBAL);
856 fprintf(stderr, "dlerr: %s\n", dlerror());
857 WRN("dlopen('%s') failed: %s", exe, dlerror());
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);
866 WRN("not quicklauncher capable: no elm_main in '%s'", exe);
885 extern char **environ;
890 for (i = 0, size = 0; environ[i]; i++)
891 size += strlen(environ[i]) + 1;
893 p = malloc((i + 1) * sizeof(char *));
898 for (i = 0; oldenv[i]; i++)
899 environ[i] = strdup(oldenv[i]);
906 elm_quicklaunch_fork(int argc,
909 void (postfork_func) (void *data),
919 // need to accept current environment from elementary_run
926 if (child > 0) return EINA_TRUE;
929 perror("could not fork");
934 perror("could not chdir");
935 args = alloca((argc + 1) * sizeof(char *));
936 for (i = 0; i < argc; i++) args[i] = argv[i];
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));
944 if (child > 0) return EINA_TRUE;
947 perror("could not fork");
950 if (postfork_func) postfork_func(postfork_data);
954 #ifdef SEMI_BROKEN_QUICKLAUNCH
955 ecore_app_args_set(argc, (const char **)argv);
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
966 # ifdef HAVE_ELEMENTARY_X
970 ecore_evas_init(); // FIXME: check errors
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
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]);
992 ecore_app_args_set(argc, (const char **)argv);
993 ret = qr_main(argc, argv);
1001 (void)postfork_func;
1002 (void)postfork_data;
1007 elm_quicklaunch_cleanup(void)
1020 elm_quicklaunch_fallback(int argc,
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);
1033 elm_quicklaunch_exe_path_get(const char *exe)
1035 static char *path = NULL;
1036 static Eina_List *pathlist = NULL;
1037 const char *pathitr;
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);
1047 path = getenv("PATH");
1048 buf2 = alloca(strlen(path) + 1);
1053 if ((*p == ':') || (!*p))
1058 strncpy(buf2, pp, len);
1060 pathlist = eina_list_append(pathlist, eina_stringshare_add(buf2));
1072 EINA_LIST_FOREACH(pathlist, l, pathitr)
1074 snprintf(buf, sizeof(buf), "%s/%s", pathitr, exe);
1075 if (!access(buf, R_OK | X_OK)) return strdup(buf);
1083 ecore_main_loop_begin();
1089 ecore_main_loop_quit();
1093 elm_policy_set(unsigned int policy,
1096 Elm_Event_Policy_Changed *ev;
1098 if (policy >= ELM_POLICY_LAST)
1101 if (value == _elm_policies[policy])
1104 /* TODO: validade policy? */
1106 ev = malloc(sizeof(*ev));
1107 ev->policy = policy;
1108 ev->new_value = value;
1109 ev->old_value = _elm_policies[policy];
1111 _elm_policies[policy] = value;
1113 ecore_event_add(ELM_EVENT_POLICY_CHANGED, ev, NULL, NULL);
1119 elm_policy_get(unsigned int policy)
1121 if (policy >= ELM_POLICY_LAST)
1123 return _elm_policies[policy];
1127 * @defgroup UI-Mirroring Selective Widget mirroring
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.
1138 * Returns the widget's mirrored mode.
1140 * @param obj The widget.
1141 * @return mirrored mode of the object.
1145 elm_object_mirrored_get(const Evas_Object *obj)
1147 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
1148 return elm_widget_mirrored_get(obj);
1152 * Sets the widget's mirrored mode.
1154 * @param obj The widget.
1155 * @param mirrored EINA_TRUE to set mirrored mode. EINA_FALSE to unset.
1158 elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored)
1160 EINA_SAFETY_ON_NULL_RETURN(obj);
1161 elm_widget_mirrored_set(obj, mirrored);
1165 * Returns the widget's mirrored mode setting.
1167 * @param obj The widget.
1168 * @return mirrored mode setting of the object.
1172 elm_object_mirrored_automatic_get(const Evas_Object *obj)
1174 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
1175 return elm_widget_mirrored_automatic_get(obj);
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.
1186 elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic)
1188 EINA_SAFETY_ON_NULL_RETURN(obj);
1189 elm_widget_mirrored_automatic_set(obj, automatic);
1193 elm_object_scale_set(Evas_Object *obj,
1196 EINA_SAFETY_ON_NULL_RETURN(obj);
1197 elm_widget_scale_set(obj, scale);
1201 elm_object_scale_get(const Evas_Object *obj)
1203 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, 0.0);
1204 return elm_widget_scale_get(obj);
1208 elm_object_text_part_set(Evas_Object *obj, const char *item, const char *label)
1210 EINA_SAFETY_ON_NULL_RETURN(obj);
1211 elm_widget_text_part_set(obj, item, label);
1215 elm_object_text_part_get(const Evas_Object *obj, const char *item)
1217 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
1218 return elm_widget_text_part_get(obj, item);
1222 * Get the global scaling factor
1224 * This gets the globally configured scaling factor that is applied to all
1227 * @return The scaling factor
1233 return _elm_config->scale;
1237 * Set the global scaling factor
1239 * This sets the globally configured scaling factor that is applied to all
1242 * @param scale The scaling factor to set
1246 elm_scale_set(double scale)
1248 if (_elm_config->scale == scale) return;
1249 _elm_config->scale = scale;
1254 * Set the global scaling factor for all applications on the display
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
1262 elm_scale_all_set(double scale)
1264 #ifdef HAVE_ELEMENTARY_X
1265 static Ecore_X_Atom atom = 0;
1266 unsigned int scale_i = (unsigned int)(scale * 1000.0);
1268 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_SCALE");
1269 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1275 elm_object_style_set(Evas_Object *obj,
1278 EINA_SAFETY_ON_NULL_RETURN(obj);
1279 elm_widget_style_set(obj, style);
1283 elm_object_style_get(const Evas_Object *obj)
1285 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
1286 return elm_widget_style_get(obj);
1290 elm_object_disabled_set(Evas_Object *obj,
1293 EINA_SAFETY_ON_NULL_RETURN(obj);
1294 elm_widget_disabled_set(obj, disabled);
1298 elm_object_disabled_get(const Evas_Object *obj)
1300 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
1301 return elm_widget_disabled_get(obj);
1305 * @defgroup Config Elementary Config
1308 * Elementary configuration is formed by a set options bounded to a
1309 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1310 * "finger size", etc. These are functions with which one syncronizes
1311 * changes made to those values to the configuration storing files, de
1312 * facto. You most probably don't want to use the functions in this
1313 * group unlees you're writing an elementary configuration manager.
1317 * Save back Elementary's configuration, so that it will persist on
1320 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1323 * This function will take effect -- thus, do I/O -- immediately. Use
1324 * it when you want to apply all configuration changes at once. The
1325 * current configuration set will get saved onto the current profile
1326 * configuration file.
1330 elm_config_save(void)
1332 return _elm_config_save();
1336 * Reload Elementary's configuration, bounded to current selected
1339 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1342 * Useful when you want to force reloading of configuration values for
1343 * a profile. If one removes user custom configuration directories,
1344 * for example, it will force a reload with system values insted.
1348 elm_config_reload(void)
1350 _elm_config_reload();
1354 * @defgroup Profile Elementary Profile
1357 * Profiles are pre-set options that affect the whole look-and-feel of
1358 * Elementary-based applications. There are, for example, profiles
1359 * aimed at desktop computer applications and others aimed at mobile,
1360 * touchscreen-based ones. You most probably don't want to use the
1361 * functions in this group unlees you're writing an elementary
1362 * configuration manager.
1366 * Get Elementary's profile in use.
1368 * This gets the global profile that is applied to all Elementary
1371 * @return The profile's name
1375 elm_profile_current_get(void)
1377 return _elm_config_current_profile_get();
1381 * Get an Elementary's profile directory path in the filesystem. One
1382 * may want to fetch a system profile's dir or an user one (fetched
1385 * @param profile The profile's name
1386 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1387 * or a system one (@c EINA_FALSE)
1388 * @return The profile's directory path.
1391 * @note You must free it with elm_profile_dir_free().
1394 elm_profile_dir_get(const char *profile,
1397 return _elm_config_profile_dir_get(profile, is_user);
1401 * Free an Elementary's profile directory path, as returned by
1402 * elm_profile_dir_get().
1404 * @param p_dir The profile's path
1409 elm_profile_dir_free(const char *p_dir)
1411 free((void *)p_dir);
1415 * Get Elementary's list of available profiles.
1417 * @return The profiles list. List node data are the profile name
1421 * @note One must free this list, after usage, with the function
1422 * elm_profile_list_free().
1425 elm_profile_list_get(void)
1427 return _elm_config_profiles_list();
1431 * Free Elementary's list of available profiles.
1433 * @param The profiles list, as returned by elm_profile_list_get().
1438 elm_profile_list_free(Eina_List *l)
1442 EINA_LIST_FREE(l, dir)
1443 eina_stringshare_del(dir);
1447 * Set Elementary's profile.
1449 * This sets the global profile that is applied to Elementary
1450 * applications. Just the process the call comes from will be
1453 * @param profile The profile's name
1458 elm_profile_set(const char *profile)
1460 EINA_SAFETY_ON_NULL_RETURN(profile);
1461 _elm_config_profile_set(profile);
1465 * Set Elementary's profile.
1467 * This sets the global profile that is applied to all Elementary
1468 * applications. All running Elementary windows will be affected.
1470 * @param profile The profile's name
1475 elm_profile_all_set(const char *profile)
1477 #ifdef HAVE_ELEMENTARY_X
1478 static Ecore_X_Atom atom = 0;
1480 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_PROFILE");
1481 ecore_x_window_prop_string_set(ecore_x_window_root_first_get(),
1487 * @defgroup Engine Elementary Engine
1490 * These are functions setting and querying which rendering engine
1491 * Elementary will use for drawing its windows' pixels.
1495 * Get Elementary's rendering engine in use.
1497 * This gets the global rendering engine that is applied to all
1498 * Elementary applications.
1500 * @return The rendering engine's name
1503 * @note there's no need to free the returned string, here.
1506 elm_engine_current_get(void)
1508 return _elm_config->engine;
1512 * Set Elementary's rendering engine for use.
1514 * This gets sets global rendering engine that is applied to all
1515 * Elementary applications. Note that it will take effect only to
1516 * subsequent Elementary window creations.
1518 * @param The rendering engine's name
1521 * @note there's no need to free the returned string, here.
1524 elm_engine_set(const char *engine)
1526 EINA_SAFETY_ON_NULL_RETURN(engine);
1528 _elm_config_engine_set(engine);
1532 * @defgroup Fonts Elementary Fonts
1535 * These are functions dealing with font rendering, selection and the
1536 * like for Elementary applications. One might fetch which system
1537 * fonts are there to use and set custom fonts for individual classes
1538 * of UI items containing text (text classes).
1542 * Get Elementary's list of supported text classes.
1544 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1547 * Release the list with elm_text_classes_list_free().
1549 EAPI const Eina_List *
1550 elm_text_classes_list_get(void)
1552 return _elm_config_text_classes_get();
1556 * Free Elementary's list of supported text classes.
1560 * @see elm_text_classes_list_get().
1563 elm_text_classes_list_free(const Eina_List *list)
1565 _elm_config_text_classes_free((Eina_List *)list);
1569 * Get Elementary's list of font overlays, set with
1570 * elm_font_overlay_set().
1572 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1577 * For each text class, one can set a <b>font overlay</b> for it,
1578 * overriding the default font properties for that class coming from
1579 * the theme in use. There is no need to free this list.
1581 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1583 EAPI const Eina_List *
1584 elm_font_overlay_list_get(void)
1586 return _elm_config_font_overlays_list();
1590 * Set a font overlay for a given Elementary text class.
1592 * @param text_class Text class name
1593 * @param font Font name and style string
1594 * @param size Font size
1598 * @p font has to be in the format returned by
1599 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1600 * and @elm_font_overlay_unset().
1603 elm_font_overlay_set(const char *text_class,
1605 Evas_Font_Size size)
1607 _elm_config_font_overlay_set(text_class, font, size);
1611 * Unset a font overlay for a given Elementary text class.
1613 * @param text_class Text class name
1617 * This will bring back text elements belonging to text class @p
1618 * text_class back to their default font settings.
1621 elm_font_overlay_unset(const char *text_class)
1623 _elm_config_font_overlay_remove(text_class);
1627 * Apply the changes made with elm_font_overlay_set() and
1628 * elm_font_overlay_unset() on the current Elementary window.
1632 * This applies all font overlays set to all objects in the UI.
1635 elm_font_overlay_apply(void)
1637 _elm_config_font_overlay_apply();
1641 * Apply the changes made with elm_font_overlay_set() and
1642 * elm_font_overlay_unset() on all Elementary application windows.
1646 * This applies all font overlays set to all objects in the UI.
1649 elm_font_overlay_all_apply(void)
1651 #ifdef HAVE_ELEMENTARY_X
1652 static Ecore_X_Atom atom = 0;
1653 unsigned int dummy = (unsigned int)(1 * 1000.0);
1655 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FONT_OVERLAY");
1656 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(), atom, &dummy,
1662 * Translate a font (family) name string in fontconfig's font names
1663 * syntax into an @c Elm_Font_Properties struct.
1665 * @param font The font name and styles string
1666 * @return the font properties struct
1670 * @note The reverse translation can be achived with
1671 * elm_font_fontconfig_name_get(), for one style only (single font
1672 * instance, not family).
1674 EAPI Elm_Font_Properties *
1675 elm_font_properties_get(const char *font)
1677 EINA_SAFETY_ON_NULL_RETURN_VAL(font, NULL);
1678 return _elm_font_properties_get(NULL, font);
1682 * Free font properties return by elm_font_properties_get().
1684 * @param efp the font properties struct
1689 elm_font_properties_free(Elm_Font_Properties *efp)
1693 EINA_SAFETY_ON_NULL_RETURN(efp);
1694 EINA_LIST_FREE(efp->styles, str)
1695 if (str) eina_stringshare_del(str);
1696 if (efp->name) eina_stringshare_del(efp->name);
1701 * Translate a font name, bound to a style, into fontconfig's font names
1704 * @param name The font (family) name
1705 * @param style The given style (may be @c NULL)
1707 * @return the font name and style string
1711 * @note The reverse translation can be achived with
1712 * elm_font_properties_get(), for one style only (single font
1713 * instance, not family).
1716 elm_font_fontconfig_name_get(const char *name,
1721 EINA_SAFETY_ON_NULL_RETURN_VAL(name, NULL);
1722 if (!style || style[0] == 0) return eina_stringshare_add(name);
1723 snprintf(buf, 256, "%s" ELM_FONT_TOKEN_STYLE "%s", name, style);
1724 return eina_stringshare_add(buf);
1728 * Free the font string return by elm_font_fontconfig_name_get().
1730 * @param efp the font properties struct
1735 elm_font_fontconfig_name_free(const char *name)
1737 eina_stringshare_del(name);
1741 * Create a font hash table of available system fonts.
1743 * One must call it with @p list being the return value of
1744 * evas_font_available_list(). The hash will be indexed by font
1745 * (family) names, being its values @c Elm_Font_Properties blobs.
1747 * @param list The list of available system fonts, as returned by
1748 * evas_font_available_list().
1749 * @return the font hash.
1753 * @note The user is supposed to get it populated at least with 3
1754 * default font families (Sans, Serif, Monospace), which should be
1755 * present on most systems.
1758 elm_font_available_hash_add(Eina_List *list)
1760 Eina_Hash *font_hash;
1766 /* populate with default font families */
1767 font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Regular");
1768 font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Bold");
1769 font_hash = _elm_font_available_hash_add(font_hash, "Sans:style=Oblique");
1770 font_hash = _elm_font_available_hash_add(font_hash,
1771 "Sans:style=Bold Oblique");
1773 font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Regular");
1774 font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Bold");
1775 font_hash = _elm_font_available_hash_add(font_hash, "Serif:style=Oblique");
1776 font_hash = _elm_font_available_hash_add(font_hash,
1777 "Serif:style=Bold Oblique");
1779 font_hash = _elm_font_available_hash_add(font_hash,
1780 "Monospace:style=Regular");
1781 font_hash = _elm_font_available_hash_add(font_hash,
1782 "Monospace:style=Bold");
1783 font_hash = _elm_font_available_hash_add(font_hash,
1784 "Monospace:style=Oblique");
1785 font_hash = _elm_font_available_hash_add(font_hash,
1786 "Monospace:style=Bold Oblique");
1788 EINA_LIST_FOREACH(list, l, key)
1789 font_hash = _elm_font_available_hash_add(font_hash, key);
1795 * Free the hash return by elm_font_available_hash_add().
1797 * @param hash the hash to be freed.
1802 elm_font_available_hash_del(Eina_Hash *hash)
1804 _elm_font_available_hash_del(hash);
1808 elm_finger_size_get(void)
1810 return _elm_config->finger_size;
1814 * Set the configured finger size
1816 * This sets the globally configured finger size in pixels
1818 * @param size The finger size
1822 elm_finger_size_set(Evas_Coord size)
1824 if (_elm_config->finger_size == size) return;
1825 _elm_config->finger_size = size;
1830 * Set the configured finger size for all applications on the display
1832 * This sets the globally configured finger size in pixels for all applications
1835 * @param size The finger size
1839 elm_finger_size_all_set(Evas_Coord size)
1841 #ifdef HAVE_ELEMENTARY_X
1842 static Ecore_X_Atom atom = 0;
1843 unsigned int size_i = (unsigned int)size;
1845 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FINGER_SIZE");
1846 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1852 elm_autocapitalization_allow_all_set(Eina_Bool on)
1854 #ifdef HAVE_ELEMENTARY_X
1855 static Ecore_X_Atom atom = 0;
1856 unsigned int on_i = (unsigned int)on;
1858 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_AUTOCAPITAL_ALLOW");
1859 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1865 elm_autoperiod_allow_all_set(Eina_Bool on)
1867 #ifdef HAVE_ELEMENTARY_X
1868 static Ecore_X_Atom atom = 0;
1869 unsigned int on_i = (unsigned int)on;
1871 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_AUTOPERIOD_ALLOW");
1872 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1877 * Adjust size of an element for finger usage
1879 * This takes width and height sizes (in pixels) as input and a size multiple
1880 * (which is how many fingers you want to place within the area), and adjusts
1881 * the size tobe large enough to accommodate finger. On return the w and h
1882 * sizes poiner do by these parameters will be modified.
1884 * @param times_w How many fingers should fit horizontally
1885 * @param w Pointer to the width size to adjust
1886 * @param times_h How many fingers should fit vertically
1887 * @param h Pointer to the height size to adjust
1891 elm_coords_finger_size_adjust(int times_w,
1896 if ((w) && (*w < (_elm_config->finger_size * times_w)))
1897 *w = _elm_config->finger_size * times_w;
1898 if ((h) && (*h < (_elm_config->finger_size * times_h)))
1899 *h = _elm_config->finger_size * times_h;
1903 * @defgroup Caches Caches
1906 * These are functions which let one fine-tune some cache values for
1907 * Elementary applications, thus allowing for performance adjustments.
1911 * Flush all caches & dump all data that can be to lean down to use
1922 edje_file_cache_flush();
1923 edje_collection_cache_flush();
1925 EINA_LIST_FOREACH(_elm_win_list, l, obj)
1927 Evas *e = evas_object_evas_get(obj);
1928 evas_image_cache_flush(e);
1929 evas_font_cache_flush(e);
1930 evas_render_dump(e);
1935 * Get the configured cache flush interval time
1937 * This gets the globally configured cache flush interval time, in
1940 * @return The cache flush interval time
1943 * @see elm_all_flush()
1946 elm_cache_flush_interval_get(void)
1948 return _elm_config->cache_flush_poll_interval;
1952 * Set the configured cache flush interval time
1954 * This sets the globally configured cache flush interval time, in ticks
1956 * @param size The cache flush interval time
1959 * @see elm_all_flush()
1962 elm_cache_flush_interval_set(int size)
1964 if (_elm_config->cache_flush_poll_interval == size) return;
1965 _elm_config->cache_flush_poll_interval = size;
1971 * Set the configured cache flush interval time for all applications on the
1974 * This sets the globally configured cache flush interval time -- in ticks
1975 * -- for all applications on the display.
1977 * @param size The cache flush interval time
1981 elm_cache_flush_interval_all_set(int size)
1983 #ifdef HAVE_ELEMENTARY_X
1984 static Ecore_X_Atom atom = 0;
1985 unsigned int size_i = (unsigned int)size;
1987 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_CACHE_FLUSH_INTERVAL");
1988 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1994 * Get the configured cache flush enabled state
1996 * This gets the globally configured cache flush state - if it is enabled
1997 * or not. When cache flushing is enabled, elementary will regularly
1998 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1999 * memory and allow usage to re-seed caches and data in memory where it
2000 * can do so. An idle application will thus minimise its memory usage as
2001 * data will be freed from memory and not be re-loaded as it is idle and
2002 * not rendering or doing anything graphically right now.
2004 * @return The cache flush state
2007 * @see elm_all_flush()
2010 elm_cache_flush_enabled_get(void)
2012 return _elm_config->cache_flush_enable;
2016 * Set the configured cache flush enabled state
2018 * This sets the globally configured cache flush enabled state
2020 * @param size The cache flush enabled state
2023 * @see elm_all_flush()
2026 elm_cache_flush_enabled_set(Eina_Bool enabled)
2028 enabled = !!enabled;
2029 if (_elm_config->cache_flush_enable == enabled) return;
2030 _elm_config->cache_flush_enable = enabled;
2036 * Set the configured cache flush enabled state for all applications on the
2039 * This sets the globally configured cache flush enabled state for all
2040 * applications on the display.
2042 * @param size The cache flush enabled state
2046 elm_cache_flush_enabled_all_set(Eina_Bool enabled)
2048 #ifdef HAVE_ELEMENTARY_X
2049 static Ecore_X_Atom atom = 0;
2050 unsigned int enabled_i = (unsigned int)enabled;
2052 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_CACHE_FLUSH_ENABLE");
2053 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2054 atom, &enabled_i, 1);
2059 * Get the configured font cache size
2061 * This gets the globally configured font cache size, in bytes
2063 * @return The font cache size
2067 elm_font_cache_get(void)
2069 return _elm_config->font_cache;
2073 * Set the configured font cache size
2075 * This sets the globally configured font cache size, in bytes
2077 * @param size The font cache size
2081 elm_font_cache_set(int size)
2083 if (_elm_config->font_cache == size) return;
2084 _elm_config->font_cache = size;
2090 * Set the configured font cache size for all applications on the
2093 * This sets the globally configured font cache size -- in bytes
2094 * -- for all applications on the display.
2096 * @param size The font cache size
2100 elm_font_cache_all_set(int size)
2102 #ifdef HAVE_ELEMENTARY_X
2103 static Ecore_X_Atom atom = 0;
2104 unsigned int size_i = (unsigned int)size;
2106 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FONT_CACHE");
2107 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2113 * Get the configured image cache size
2115 * This gets the globally configured image cache size, in bytes
2117 * @return The image cache size
2121 elm_image_cache_get(void)
2123 return _elm_config->image_cache;
2127 * Set the configured image cache size
2129 * This sets the globally configured image cache size, in bytes
2131 * @param size The image cache size
2135 elm_image_cache_set(int size)
2137 if (_elm_config->image_cache == size) return;
2138 _elm_config->image_cache = size;
2144 * Set the configured image cache size for all applications on the
2147 * This sets the globally configured image cache size -- in bytes
2148 * -- for all applications on the display.
2150 * @param size The image cache size
2154 elm_image_cache_all_set(int size)
2156 #ifdef HAVE_ELEMENTARY_X
2157 static Ecore_X_Atom atom = 0;
2158 unsigned int size_i = (unsigned int)size;
2160 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_IMAGE_CACHE");
2161 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2167 * Get the configured edje file cache size.
2169 * This gets the globally configured edje file cache size, in number
2172 * @return The edje file cache size
2176 elm_edje_file_cache_get(void)
2178 return _elm_config->edje_cache;
2182 * Set the configured edje file cache size
2184 * This sets the globally configured edje file cache size, in number
2187 * @param size The edje file cache size
2191 elm_edje_file_cache_set(int size)
2193 if (_elm_config->edje_cache == size) return;
2194 _elm_config->edje_cache = size;
2200 * Set the configured edje file cache size for all applications on the
2203 * This sets the globally configured edje file cache size -- in number
2204 * of files -- for all applications on the display.
2206 * @param size The edje file cache size
2210 elm_edje_file_cache_all_set(int size)
2212 #ifdef HAVE_ELEMENTARY_X
2213 static Ecore_X_Atom atom = 0;
2214 unsigned int size_i = (unsigned int)size;
2216 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_EDJE_FILE_CACHE");
2217 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2223 * Get the configured edje collections (groups) cache size.
2225 * This gets the globally configured edje collections cache size, in
2226 * number of collections.
2228 * @return The edje collections cache size
2232 elm_edje_collection_cache_get(void)
2234 return _elm_config->edje_collection_cache;
2238 * Set the configured edje collections (groups) cache size
2240 * This sets the globally configured edje collections cache size, in
2241 * number of collections.
2243 * @param size The edje collections cache size
2247 elm_edje_collection_cache_set(int size)
2249 if (_elm_config->edje_collection_cache == size) return;
2250 _elm_config->edje_collection_cache = size;
2256 * Set the configured edje collections (groups) cache size for all
2257 * applications on the display
2259 * This sets the globally configured edje collections cache size -- in
2260 * number of collections -- for all applications on the display.
2262 * @param size The edje collections cache size
2266 elm_edje_collection_cache_all_set(int size)
2268 #ifdef HAVE_ELEMENTARY_X
2269 static Ecore_X_Atom atom = 0;
2270 unsigned int size_i = (unsigned int)size;
2272 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_EDJE_COLLECTION_CACHE");
2273 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2279 elm_object_focus_get(const Evas_Object *obj)
2281 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
2282 return elm_widget_focus_get(obj);
2286 elm_object_focus(Evas_Object *obj)
2288 EINA_SAFETY_ON_NULL_RETURN(obj);
2289 if (elm_widget_focus_get(obj))
2292 elm_widget_focus_cycle(obj, ELM_FOCUS_NEXT);
2296 elm_object_unfocus(Evas_Object *obj)
2298 EINA_SAFETY_ON_NULL_RETURN(obj);
2299 if (!elm_widget_can_focus_get(obj)) return;
2300 elm_widget_focused_object_clear(obj);
2304 elm_object_focus_allow_set(Evas_Object *obj,
2307 EINA_SAFETY_ON_NULL_RETURN(obj);
2308 elm_widget_can_focus_set(obj, enable);
2312 elm_object_focus_allow_get(const Evas_Object *obj)
2314 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
2315 return (elm_widget_can_focus_get(obj)) || (elm_widget_child_can_focus_get(obj));
2319 * Set custom focus chain.
2321 * This function i set one new and overwrite any previous custom focus chain
2322 * with the list of objects. The previous list will be deleted and this list
2323 * will be managed. After setted, don't modity it.
2325 * @note On focus cycle, only will be evaluated children of this container.
2327 * @param obj The container object
2328 * @param objs Chain of objects to pass focus
2332 elm_object_focus_custom_chain_set(Evas_Object *obj,
2335 EINA_SAFETY_ON_NULL_RETURN(obj);
2336 elm_widget_focus_custom_chain_set(obj, objs);
2340 * Unset custom focus chain
2342 * @param obj The container object
2346 elm_object_focus_custom_chain_unset(Evas_Object *obj)
2348 EINA_SAFETY_ON_NULL_RETURN(obj);
2349 elm_widget_focus_custom_chain_unset(obj);
2353 * Get custom focus chain
2355 * @param obj The container object
2358 EAPI const Eina_List *
2359 elm_object_focus_custom_chain_get(const Evas_Object *obj)
2361 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
2362 return elm_widget_focus_custom_chain_get(obj);
2366 * Append object to custom focus chain.
2368 * @note If relative_child equal to NULL or not in custom chain, the object
2369 * will be added in end.
2371 * @note On focus cycle, only will be evaluated children of this container.
2373 * @param obj The container object
2374 * @param child The child to be added in custom chain
2375 * @param relative_child The relative object to position the child
2379 elm_object_focus_custom_chain_append(Evas_Object *obj,
2381 Evas_Object *relative_child)
2383 EINA_SAFETY_ON_NULL_RETURN(obj);
2384 EINA_SAFETY_ON_NULL_RETURN(child);
2385 elm_widget_focus_custom_chain_append(obj, child, relative_child);
2389 * Prepend object to custom focus chain.
2391 * @note If relative_child equal to NULL or not in custom chain, the object
2392 * will be added in begin.
2394 * @note On focus cycle, only will be evaluated children of this container.
2396 * @param obj The container object
2397 * @param child The child to be added in custom chain
2398 * @param relative_child The relative object to position the child
2402 elm_object_focus_custom_chain_prepend(Evas_Object *obj,
2404 Evas_Object *relative_child)
2406 EINA_SAFETY_ON_NULL_RETURN(obj);
2407 EINA_SAFETY_ON_NULL_RETURN(child);
2408 elm_widget_focus_custom_chain_prepend(obj, child, relative_child);
2412 * Give focus to next object in object tree.
2414 * Give focus to next object in focus chain of one object sub-tree.
2415 * If the last object of chain already have focus, the focus will go to the
2416 * first object of chain.
2418 * @param obj The object root of sub-tree
2419 * @param dir Direction to cycle the focus
2424 elm_object_focus_cycle(Evas_Object *obj,
2425 Elm_Focus_Direction dir)
2427 EINA_SAFETY_ON_NULL_RETURN(obj);
2428 elm_widget_focus_cycle(obj, dir);
2432 * Give focus to near object in one direction.
2434 * Give focus to near object in direction of one object.
2435 * If none focusable object in given direction, the focus will not change.
2437 * @param obj The reference object
2438 * @param x Horizontal component of direction to focus
2439 * @param y Vertical component of direction to focus
2444 elm_object_focus_direction_go(Evas_Object *obj,
2448 EINA_SAFETY_ON_NULL_RETURN(obj);
2449 elm_widget_focus_direction_go(obj, x, y);
2453 elm_object_tree_unfocusable_set(Evas_Object *obj,
2454 Eina_Bool tree_unfocusable)
2456 EINA_SAFETY_ON_NULL_RETURN(obj);
2457 elm_widget_tree_unfocusable_set(obj, tree_unfocusable);
2461 elm_object_tree_unfocusable_get(const Evas_Object *obj)
2463 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
2464 return elm_widget_tree_unfocusable_get(obj);
2468 * Get the enable status of the focus highlight
2470 * This gets whether the highlight on focused objects is enabled or not
2474 elm_focus_highlight_enabled_get(void)
2476 return _elm_config->focus_highlight_enable;
2480 * Set the enable status of the focus highlight
2482 * Set whether to show or not the highlight on focused objects
2483 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2487 elm_focus_highlight_enabled_set(Eina_Bool enable)
2489 _elm_config->focus_highlight_enable = !!enable;
2493 * Get the enable status of the highlight animation
2495 * Get whether the focus highlight, if enabled, will animate its switch from
2496 * one object to the next
2500 elm_focus_highlight_animate_get(void)
2502 return _elm_config->focus_highlight_animate;
2506 * Set the enable status of the highlight animation
2508 * Set whether the focus highlight, if enabled, will animate its switch from
2509 * one object to the next
2510 * @param animate Enable animation if EINA_TRUE, disable otherwise
2514 elm_focus_highlight_animate_set(Eina_Bool animate)
2516 _elm_config->focus_highlight_animate = !!animate;
2520 * @defgroup Scrolling Scrolling
2523 * These are functions setting how scrollable views in Elementary
2524 * widgets should behave on user interaction.
2528 * Get whether scrollers should bounce when they reach their
2529 * viewport's edge during a scroll.
2531 * @return the thumb scroll bouncing state
2533 * This is the default behavior for touch screens, in general.
2534 * @ingroup Scrolling
2537 elm_scroll_bounce_enabled_get(void)
2539 return _elm_config->thumbscroll_bounce_enable;
2543 * Set whether scrollers should bounce when they reach their
2544 * viewport's edge during a scroll.
2546 * @param enabled the thumb scroll bouncing state
2548 * @see elm_thumbscroll_bounce_enabled_get()
2549 * @ingroup Scrolling
2552 elm_scroll_bounce_enabled_set(Eina_Bool enabled)
2554 _elm_config->thumbscroll_bounce_enable = enabled;
2558 * Set whether scrollers should bounce when they reach their
2559 * viewport's edge during a scroll, for all Elementary application
2562 * @param enabled the thumb scroll bouncing state
2564 * @see elm_thumbscroll_bounce_enabled_get()
2565 * @ingroup Scrolling
2568 elm_scroll_bounce_enabled_all_set(Eina_Bool enabled)
2570 #ifdef HAVE_ELEMENTARY_X
2571 static Ecore_X_Atom atom = 0;
2572 unsigned int bounce_enable_i = (unsigned int)enabled;
2575 atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BOUNCE_ENABLE");
2576 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2577 atom, &bounce_enable_i, 1);
2582 * Get the amount of inertia a scroller will impose at bounce
2585 * @return the thumb scroll bounce friction
2587 * @ingroup Scrolling
2590 elm_scroll_bounce_friction_get(void)
2592 return _elm_config->thumbscroll_bounce_friction;
2596 * Set the amount of inertia a scroller will impose at bounce
2599 * @param friction the thumb scroll bounce friction
2601 * @see elm_thumbscroll_bounce_friction_get()
2602 * @ingroup Scrolling
2605 elm_scroll_bounce_friction_set(double friction)
2607 _elm_config->thumbscroll_bounce_friction = friction;
2611 * Set the amount of inertia a scroller will impose at bounce
2612 * animations, for all Elementary application windows.
2614 * @param friction the thumb scroll bounce friction
2616 * @see elm_thumbscroll_bounce_friction_get()
2617 * @ingroup Scrolling
2620 elm_scroll_bounce_friction_all_set(double friction)
2622 #ifdef HAVE_ELEMENTARY_X
2623 static Ecore_X_Atom atom = 0;
2624 unsigned int bounce_friction_i = (unsigned int)(friction * 1000.0);
2627 atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BOUNCE_FRICTION");
2628 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2629 atom, &bounce_friction_i, 1);
2634 * Get the amount of inertia a <b>paged</b> scroller will impose at
2635 * page fitting animations.
2637 * @return the page scroll friction
2639 * @ingroup Scrolling
2642 elm_scroll_page_scroll_friction_get(void)
2644 return _elm_config->page_scroll_friction;
2648 * Set the amount of inertia a <b>paged</b> scroller will impose at
2649 * page fitting animations.
2651 * @param friction the page scroll friction
2653 * @see elm_thumbscroll_page_scroll_friction_get()
2654 * @ingroup Scrolling
2657 elm_scroll_page_scroll_friction_set(double friction)
2659 _elm_config->page_scroll_friction = friction;
2663 * Set the amount of inertia a <b>paged</b> scroller will impose at
2664 * page fitting animations, for all Elementary application windows.
2666 * @param friction the page scroll friction
2668 * @see elm_thumbscroll_page_scroll_friction_get()
2669 * @ingroup Scrolling
2672 elm_scroll_page_scroll_friction_all_set(double friction)
2674 #ifdef HAVE_ELEMENTARY_X
2675 static Ecore_X_Atom atom = 0;
2676 unsigned int page_scroll_friction_i = (unsigned int)(friction * 1000.0);
2679 atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_PAGE_SCROLL_FRICTION");
2680 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2681 atom, &page_scroll_friction_i, 1);
2686 * Get the amount of inertia a scroller will impose at region bring
2689 * @return the bring in scroll friction
2691 * @ingroup Scrolling
2694 elm_scroll_bring_in_scroll_friction_get(void)
2696 return _elm_config->bring_in_scroll_friction;
2700 * Set the amount of inertia a scroller will impose at region bring
2703 * @param friction the bring in scroll friction
2705 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2706 * @ingroup Scrolling
2709 elm_scroll_bring_in_scroll_friction_set(double friction)
2711 _elm_config->bring_in_scroll_friction = friction;
2715 * Set the amount of inertia a scroller will impose at region bring
2716 * animations, for all Elementary application windows.
2718 * @param friction the bring in scroll friction
2720 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2721 * @ingroup Scrolling
2724 elm_scroll_bring_in_scroll_friction_all_set(double friction)
2726 #ifdef HAVE_ELEMENTARY_X
2727 static Ecore_X_Atom atom = 0;
2728 unsigned int bring_in_scroll_friction_i = (unsigned int)(friction * 1000.0);
2732 ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BRING_IN_SCROLL_FRICTION");
2733 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2734 atom, &bring_in_scroll_friction_i, 1);
2739 * Get the amount of inertia scrollers will impose at animations
2740 * triggered by Elementary widgets' zooming API.
2742 * @return the zoom friction
2744 * @ingroup Scrolling
2747 elm_scroll_zoom_friction_get(void)
2749 return _elm_config->zoom_friction;
2753 * Set the amount of inertia scrollers will impose at animations
2754 * triggered by Elementary widgets' zooming API.
2756 * @param friction the zoom friction
2758 * @see elm_thumbscroll_zoom_friction_get()
2759 * @ingroup Scrolling
2762 elm_scroll_zoom_friction_set(double friction)
2764 _elm_config->zoom_friction = friction;
2768 * Set the amount of inertia scrollers will impose at animations
2769 * triggered by Elementary widgets' zooming API, for all Elementary
2770 * application windows.
2772 * @param friction the zoom friction
2774 * @see elm_thumbscroll_zoom_friction_get()
2775 * @ingroup Scrolling
2778 elm_scroll_zoom_friction_all_set(double friction)
2780 #ifdef HAVE_ELEMENTARY_X
2781 static Ecore_X_Atom atom = 0;
2782 unsigned int zoom_friction_i = (unsigned int)(friction * 1000.0);
2785 atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_ZOOM_FRICTION");
2786 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2787 atom, &zoom_friction_i, 1);
2792 * Get whether scrollers should be draggable from any point in their
2795 * @return the thumb scroll state
2797 * @note This is the default behavior for touch screens, in general.
2798 * @note All other functions namespaced with "thumbscroll" will only
2799 * have effect if this mode is enabled.
2801 * @ingroup Scrolling
2804 elm_scroll_thumbscroll_enabled_get(void)
2806 return _elm_config->thumbscroll_enable;
2810 * Set whether scrollers should be draggable from any point in their
2813 * @param enabled the thumb scroll state
2815 * @see elm_thumbscroll_enabled_get()
2816 * @ingroup Scrolling
2819 elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled)
2821 _elm_config->thumbscroll_enable = enabled;
2825 * Set whether scrollers should be draggable from any point in their
2826 * views, for all Elementary application windows.
2828 * @param enabled the thumb scroll state
2830 * @see elm_thumbscroll_enabled_get()
2831 * @ingroup Scrolling
2834 elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled)
2836 #ifdef HAVE_ELEMENTARY_X
2837 static Ecore_X_Atom atom = 0;
2838 unsigned int ts_enable_i = (unsigned int)enabled;
2840 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_ENABLE");
2841 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2842 atom, &ts_enable_i, 1);
2847 * Get the number of pixels one should travel while dragging a
2848 * scroller's view to actually trigger scrolling.
2850 * @return the thumb scroll threshould
2852 * One would use higher values for touch screens, in general, because
2853 * of their inherent imprecision.
2854 * @ingroup Scrolling
2857 elm_scroll_thumbscroll_threshold_get(void)
2859 return _elm_config->thumbscroll_threshold;
2863 * Set the number of pixels one should travel while dragging a
2864 * scroller's view to actually trigger scrolling.
2866 * @param threshold the thumb scroll threshould
2868 * @see elm_thumbscroll_threshould_get()
2869 * @ingroup Scrolling
2872 elm_scroll_thumbscroll_threshold_set(unsigned int threshold)
2874 _elm_config->thumbscroll_threshold = threshold;
2878 * Set the number of pixels one should travel while dragging a
2879 * scroller's view to actually trigger scrolling, for all Elementary
2880 * application windows.
2882 * @param threshold the thumb scroll threshould
2884 * @see elm_thumbscroll_threshould_get()
2885 * @ingroup Scrolling
2888 elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold)
2890 #ifdef HAVE_ELEMENTARY_X
2891 static Ecore_X_Atom atom = 0;
2892 unsigned int ts_threshold_i = (unsigned int)threshold;
2894 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_THRESHOLD");
2895 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2896 atom, &ts_threshold_i, 1);
2901 * Get the minimum speed of mouse cursor movement which will trigger
2902 * list self scrolling animation after a mouse up event
2905 * @return the thumb scroll momentum threshould
2907 * @ingroup Scrolling
2910 elm_scroll_thumbscroll_momentum_threshold_get(void)
2912 return _elm_config->thumbscroll_momentum_threshold;
2916 * Set the minimum speed of mouse cursor movement which will trigger
2917 * list self scrolling animation after a mouse up event
2920 * @param threshold the thumb scroll momentum threshould
2922 * @see elm_thumbscroll_momentum_threshould_get()
2923 * @ingroup Scrolling
2926 elm_scroll_thumbscroll_momentum_threshold_set(double threshold)
2928 _elm_config->thumbscroll_momentum_threshold = threshold;
2932 * Set the minimum speed of mouse cursor movement which will trigger
2933 * list self scrolling animation after a mouse up event
2934 * (pixels/second), for all Elementary application windows.
2936 * @param threshold the thumb scroll momentum threshould
2938 * @see elm_thumbscroll_momentum_threshould_get()
2939 * @ingroup Scrolling
2942 elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold)
2944 #ifdef HAVE_ELEMENTARY_X
2945 static Ecore_X_Atom atom = 0;
2946 unsigned int ts_momentum_threshold_i = (unsigned int)(threshold * 1000.0);
2949 atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_MOMENTUM_THRESHOLD");
2950 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
2951 atom, &ts_momentum_threshold_i, 1);
2956 * Get the amount of inertia a scroller will impose at self scrolling
2959 * @return the thumb scroll friction
2961 * @ingroup Scrolling
2964 elm_scroll_thumbscroll_friction_get(void)
2966 return _elm_config->thumbscroll_friction;
2970 * Set the amount of inertia a scroller will impose at self scrolling
2973 * @param friction the thumb scroll friction
2975 * @see elm_thumbscroll_friction_get()
2976 * @ingroup Scrolling
2979 elm_scroll_thumbscroll_friction_set(double friction)
2981 _elm_config->thumbscroll_friction = friction;
2985 * Set the amount of inertia a scroller will impose at self scrolling
2986 * animations, for all Elementary application windows.
2988 * @param friction the thumb scroll friction
2990 * @see elm_thumbscroll_friction_get()
2991 * @ingroup Scrolling
2994 elm_scroll_thumbscroll_friction_all_set(double friction)
2996 #ifdef HAVE_ELEMENTARY_X
2997 static Ecore_X_Atom atom = 0;
2998 unsigned int ts_friction_i = (unsigned int)(friction * 1000.0);
3000 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_FRICTION");
3001 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
3002 atom, &ts_friction_i, 1);
3007 * Get the amount of lag between your actual mouse cursor dragging
3008 * movement and a scroller's view movement itself, while pushing it
3009 * into bounce state manually.
3011 * @return the thumb scroll border friction
3013 * @ingroup Scrolling
3016 elm_scroll_thumbscroll_border_friction_get(void)
3018 return _elm_config->thumbscroll_border_friction;
3022 * Set the amount of lag between your actual mouse cursor dragging
3023 * movement and a scroller's view movement itself, while pushing it
3024 * into bounce state manually.
3026 * @param friction the thumb scroll border friction. @c 0.0 for
3027 * perfect synchrony between two movements, @c 1.0 for maximum
3030 * @see elm_thumbscroll_border_friction_get()
3031 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3033 * @ingroup Scrolling
3036 elm_scroll_thumbscroll_border_friction_set(double friction)
3044 _elm_config->thumbscroll_friction = friction;
3048 * Set the amount of lag between your actual mouse cursor dragging
3049 * movement and a scroller's view movement itself, while pushing it
3050 * into bounce state manually, for all Elementary application windows.
3052 * @param friction the thumb scroll border friction. @c 0.0 for
3053 * perfect synchrony between two movements, @c 1.0 for maximum
3056 * @see elm_thumbscroll_border_friction_get()
3057 * @note parameter value will get bound to 0.0 - 1.0 interval, always
3059 * @ingroup Scrolling
3062 elm_scroll_thumbscroll_border_friction_all_set(double friction)
3070 #ifdef HAVE_ELEMENTARY_X
3071 static Ecore_X_Atom atom = 0;
3072 unsigned int border_friction_i = (unsigned int)(friction * 1000.0);
3075 atom = ecore_x_atom_get("ENLIGHTENMENT_THUMBSCROLL_BORDER_FRICTION");
3076 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
3077 atom, &border_friction_i, 1);
3082 * @defgroup Scrollhints Scrollhints
3085 * Objects when inside a scroller can scroll, but this may not always be
3086 * desirable in certain situations. This allows an object to hint to itself
3087 * and parents to "not scroll" in one of 2 ways.
3089 * 1. To hold on scrolling. This means just flicking and dragging may no
3090 * longer scroll, but pressing/dragging near an edge of the scroller will
3091 * still scroll. This is automastically used by the entry object when
3093 * 2. To totally freeze scrolling. This means it stops. until popped/released.
3097 * Push the scroll hold by 1
3099 * This increments the scroll hold count by one. If it is more than 0 it will
3100 * take effect on the parents of the indicated object.
3102 * @param obj The object
3103 * @ingroup Scrollhints
3106 elm_object_scroll_hold_push(Evas_Object *obj)
3108 EINA_SAFETY_ON_NULL_RETURN(obj);
3109 elm_widget_scroll_hold_push(obj);
3113 * Pop the scroll hold by 1
3115 * This decrements the scroll hold count by one. If it is more than 0 it will
3116 * take effect on the parents of the indicated object.
3118 * @param obj The object
3119 * @ingroup Scrollhints
3122 elm_object_scroll_hold_pop(Evas_Object *obj)
3124 EINA_SAFETY_ON_NULL_RETURN(obj);
3125 elm_widget_scroll_hold_pop(obj);
3129 * Push the scroll freeze by 1
3131 * This increments the scroll freeze count by one. If it is more than 0 it will
3132 * take effect on the parents of the indicated object.
3134 * @param obj The object
3135 * @ingroup Scrollhints
3138 elm_object_scroll_freeze_push(Evas_Object *obj)
3140 EINA_SAFETY_ON_NULL_RETURN(obj);
3141 elm_widget_scroll_freeze_push(obj);
3145 * Lock the scrolling of the given widget (and thus all parents)
3147 * This locks the given object from scrolling in the X axis (and implicitly
3148 * also locks all parent scrollers too from doing the same).
3150 * @param obj The object
3151 * @param lock The lock state (1 == locked, 0 == unlocked)
3152 * @ingroup Scrollhints
3155 elm_object_scroll_lock_x_set(Evas_Object *obj,
3158 EINA_SAFETY_ON_NULL_RETURN(obj);
3159 elm_widget_drag_lock_x_set(obj, lock);
3163 * Lock the scrolling of the given widget (and thus all parents)
3165 * This locks the given object from scrolling in the Y axis (and implicitly
3166 * also locks all parent scrollers too from doing the same).
3168 * @param obj The object
3169 * @param lock The lock state (1 == locked, 0 == unlocked)
3170 * @ingroup Scrollhints
3173 elm_object_scroll_lock_y_set(Evas_Object *obj,
3176 EINA_SAFETY_ON_NULL_RETURN(obj);
3177 elm_widget_drag_lock_y_set(obj, lock);
3181 * Get the scrolling lock of the given widget
3183 * This gets the lock for X axis scrolling.
3185 * @param obj The object
3186 * @ingroup Scrollhints
3189 elm_object_scroll_lock_x_get(const Evas_Object *obj)
3191 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3192 return elm_widget_drag_lock_x_get(obj);
3196 * Get the scrolling lock of the given widget
3198 * This gets the lock for X axis scrolling.
3200 * @param obj The object
3201 * @ingroup Scrollhints
3204 elm_object_scroll_lock_y_get(const Evas_Object *obj)
3206 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3207 return elm_widget_drag_lock_y_get(obj);
3211 * Pop the scroll freeze by 1
3213 * This decrements the scroll freeze count by one. If it is more than 0 it will
3214 * take effect on the parents of the indicated object.
3216 * @param obj The object
3217 * @ingroup Scrollhints
3220 elm_object_scroll_freeze_pop(Evas_Object *obj)
3222 EINA_SAFETY_ON_NULL_RETURN(obj);
3223 elm_widget_scroll_freeze_pop(obj);
3227 * Check if the given Evas Object is an Elementary widget.
3229 * @param obj the object to query.
3230 * @return @c EINA_TRUE if it is an elementary widget variant,
3231 * @c EINA_FALSE otherwise
3232 * @ingroup WidgetNavigation
3235 elm_object_widget_check(const Evas_Object *obj)
3237 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, EINA_FALSE);
3238 return elm_widget_is(obj);
3242 elm_object_parent_widget_get(const Evas_Object *obj)
3244 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3245 return elm_widget_parent_widget_get(obj);
3249 * Get the top level parent of an Elementary widget.
3251 * @param obj The object to query.
3252 * @return The top level Elementary widget, or @c NULL if parent cannot be
3254 * @ingroup WidgetNavigation
3257 elm_object_top_widget_get(const Evas_Object *obj)
3259 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3260 return elm_widget_top_get(obj);
3264 * Get the string that represents this Elementary widget.
3266 * @note Elementary is weird and exposes itself as a single
3267 * Evas_Object_Smart_Class of type "elm_widget", so
3268 * evas_object_type_get() always return that, making debug and
3269 * language bindings hard. This function tries to mitigate this
3270 * problem, but the solution is to change Elementary to use
3271 * proper inheritance.
3273 * @param obj the object to query.
3274 * @return Elementary widget name, or @c NULL if not a valid widget.
3275 * @ingroup WidgetNavigation
3278 elm_object_widget_type_get(const Evas_Object *obj)
3280 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3281 return elm_widget_type_get(obj);
3285 * Send a signal to the widget edje object.
3287 * This function sends a signal to the edje object of the obj. An edje program
3288 * can respond to a signal by specifying matching 'signal' and
3291 * @param obj The object
3292 * @param emission The signal's name.
3293 * @param source The signal's source.
3297 elm_object_signal_emit(Evas_Object *obj,
3298 const char *emission,
3301 EINA_SAFETY_ON_NULL_RETURN(obj);
3302 elm_widget_signal_emit(obj, emission, source);
3306 * Add a callback for a signal emitted by widget edje object.
3308 * This function connects a callback function to a signal emitted by the
3309 * edje object of the obj.
3310 * Globs can occur in either the emission or source name.
3312 * @param obj The object
3313 * @param emission The signal's name.
3314 * @param source The signal's source.
3315 * @param func The callback function to be executed when the signal is
3317 * @param data A pointer to data to pass in to the callback function.
3321 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)
3323 EINA_SAFETY_ON_NULL_RETURN(obj);
3324 EINA_SAFETY_ON_NULL_RETURN(func);
3325 elm_widget_signal_callback_add(obj, emission, source, func, data);
3329 * Remove a signal-triggered callback from an widget edje object.
3331 * This function removes a callback, previoulsy attached to a signal emitted
3332 * by the edje object of the obj.
3333 * The parameters emission, source and func must match exactly those passed to
3334 * a previous call to elm_object_signal_callback_add(). The data pointer that
3335 * was passed to this call will be returned.
3337 * @param obj The object
3338 * @param emission The signal's name.
3339 * @param source The signal's source.
3340 * @param func The callback function to be executed when the signal is
3342 * @return The data pointer
3346 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))
3348 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3349 EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
3350 return elm_widget_signal_callback_del(obj, emission, source, func);
3354 * Add a callback for a event emitted by widget or their children.
3356 * This function connects a callback function to any key_down key_up event
3357 * emitted by the @p obj or their children.
3358 * This only will be called if no other callback has consumed the event.
3359 * If you want consume the event, and no other get it, func should return
3360 * EINA_TRUE and put EVAS_EVENT_FLAG_ON_HOLD in event_flags.
3362 * @warning Accept duplicated callback addition.
3364 * @param obj The object
3365 * @param func The callback function to be executed when the event is
3367 * @param data Data to pass in to the callback function.
3371 elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data)
3373 EINA_SAFETY_ON_NULL_RETURN(obj);
3374 EINA_SAFETY_ON_NULL_RETURN(func);
3375 elm_widget_event_callback_add(obj, func, data);
3379 * Remove a event callback from an widget.
3381 * This function removes a callback, previoulsy attached to event emission
3383 * The parameters func and data must match exactly those passed to
3384 * a previous call to elm_object_event_callback_add(). The data pointer that
3385 * was passed to this call will be returned.
3387 * @param obj The object
3388 * @param func The callback function to be executed when the event is
3390 * @param data Data to pass in to the callback function.
3391 * @return The data pointer
3395 elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data)
3397 EINA_SAFETY_ON_NULL_RETURN_VAL(obj, NULL);
3398 EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
3399 return elm_widget_event_callback_del(obj, func, data);
3404 * @defgroup Debug Debug
3409 * Print Tree object hierarchy in stdout
3411 * @param obj The root object
3415 elm_object_tree_dump(const Evas_Object *top)
3418 elm_widget_tree_dump(top);
3426 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3428 * @param obj The root object
3429 * @param file The path of output file
3433 elm_object_tree_dot_dump(const Evas_Object *top,
3437 FILE *f = fopen(file, "wb");
3438 elm_widget_tree_dot_dump(top, f);
3448 * Set the duration for occuring long press event.
3450 * @param lonpress_timeout Timeout for long press event
3451 * @ingroup Longpress
3454 elm_longpress_timeout_set(double longpress_timeout)
3456 _elm_config->longpress_timeout = longpress_timeout;
3460 * Get the duration for occuring long press event.
3462 * @return Timeout for long press event
3463 * @ingroup Longpress
3466 elm_longpress_timeout_get(void)
3468 return _elm_config->longpress_timeout;