2 # include "elementary_config.h"
9 #include <dlfcn.h> /* dlopen,dlclose,etc */
11 #ifdef HAVE_CRT_EXTERNS_H
12 # include <crt_externs.h>
19 #include <Elementary.h>
22 static Elm_Version _version = { VMAJ, VMIN, VMIC, VREV };
23 EAPI Elm_Version *elm_version = &_version;
28 * This group includes functions of elm_main.c
33 * @defgroup Start Getting Started
36 * To write an Elementary app, you can get started with the following:
39 * #include <Elementary.h>
40 * #ifndef ELM_LIB_QUICKLAUNCH
42 * elm_main(int argc, char **argv)
44 * // create window(s) here and do any application init
45 * elm_run(); // run main loop
46 * elm_shutdown(); // after mainloop finishes running, shutdown
47 * return 0; // exit 0 for exit code
53 * To take full advantage of the quicklaunch architecture for launching
54 * processes as quickly as possible (saving time at startup time like
55 * connecting to X11, loading and linking shared libraries) you may want to
56 * use the following configure.in/configure.ac and Makefile.am and autogen.sh
57 * script to generate your files. It is assumed your application uses the
58 * main.c file for its code.
60 * configure.in/configure.ac:
63 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
65 AC_CONFIG_SRCDIR(configure.in)
67 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
68 AM_CONFIG_HEADER(config.h)
78 define([AC_LIBTOOL_LANG_CXX_CONFIG], [:])dnl
79 define([AC_LIBTOOL_LANG_F77_CONFIG], [:])dnl
82 PKG_CHECK_MODULES([ELEMENTARY], elementary)
90 AUTOMAKE_OPTIONS = 1.4 foreign
91 MAINTAINERCLEANFILES = Makefile.in
93 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
96 myapp_LTLIBRARIES = myapp.la
100 myapp_la_SOURCES = main.c
101 myapp_la_LIBADD = @ELEMENTARY_LIBS@
103 myapp_la_LDFLAGS = -module -avoid-version -no-undefined
105 myapp_SOURCES = main.c
106 myapp_LDADD = @ELEMENTARY_LIBS@
107 myapp_CFLAGS = -DELM_LIB_QUICKLAUNCH=1
114 rm -rf autom4te.cache
115 rm -f aclocal.m4 ltmain.sh
120 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS -I m4 || exit 1
121 echo "Running autoheader..." ; autoheader || exit 1
122 echo "Running autoconf..." ; autoconf || exit 1
123 echo "Running libtoolize..." ; (libtoolize --copy --automake || glibtoolize --automake) || exit 1
124 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
126 if [ -z "$NOCONFIGURE" ]; then
131 * To gnerate all the things needed to bootstrap just run:
137 * This will generate Makefile.in's, the confgure script and everything else.
138 * After this it works like all normal autotools projects:
145 * Note sudo was assumed to get root permissions, as this would install in
146 * /usr/local which is system-owned. Ue any way you like to gain root, or
147 * specify a different prefix with configure:
150 ./confiugre --prefix=$HOME/mysoftware
153 * Also remember that autotools buys you some useful commands like:
158 * This uninstalls the software after it was installed with "make install".
159 * It is very useful to clear up what you built if you wish to clean the
166 * This firstly checks if your build tree is "clean" and ready for
167 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
168 * ready to upload and distribute to the world, that contains the generated
169 * Makefile.in's and configure script. The users do not need to run
170 * autogen.sh - just configure and on. They don't need autotools installed.
171 * This tarball also builds cleanly, has all the sources it needs to build
172 * included (that is sources for your application, not libraries it depends
173 * on like Elementary). It builds cleanly in a buildroot and does not
174 * contain any files that are temporarily generated like binaries and other
175 * build-gnerated files, so the tarball is clean, and no need to worry
176 * about cleaning up your tree before packaging.
182 * This cleans up all build files (binaries, objects etc.) from the tree.
188 * This cleans out all files from the build and from configure's output too.
191 make maintainer-clean
194 * This deletes all the files autogen.sh will produce so the tree is clean
195 * to be put into a revision-control system (like CVS, SVN or GIT for example).
197 * The above will build a library - libmyapp.so and install in the target
198 * library directory (default is /usr/local/lib). You will also get a
199 * myapp.a and myapp.la - these are useless and can be deleted. Libtool likes
200 * to generate these all the time. You will also get a binary in the target
201 * binary directory (default is /usr/local/bin). This is a "debug binary".
202 * This will run and dlopen() the myapp.so and then jump to it's elm_main
203 * function. This allows for easy debugging with GDB and Valgrind. When you
204 * are ready to go to production do the following:
206 * 1. delete the myapp binary. i.e. rm /usr/local/bin/myapp
208 * 2. symlink the myapp binary to elementary_run (supplied by elementary).
209 * i.e. ln -s elmentary_run /usr/local/bin/myapp
211 * 3. run elementary_quicklaunch as part of your graphical login session and
214 * This will man elementary_quicklaunch does pre-initialization before the
215 * application needs to be run, saving the effort at the time the application
216 * is needed, thus speeding up the time it takes to appear.
218 * If you don't want to use the quicklaunch infrastructure (which is
219 * optional), you can execute the old fashioned way by just running the
220 * myapp binary loader than will load the myapp.so for you, or you can
221 * remove the split-file binary and put it into one binary as things always
222 * have been with the following configure.in/configure.ac and Makfile.am
225 * configure.in/configure.ac:
228 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
230 AC_CONFIG_SRCDIR(configure.in)
232 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
233 AM_CONFIG_HEADER(config.h)
242 PKG_CHECK_MODULES([ELEMENTARY], elementary)
250 AUTOMAKE_OPTIONS = 1.4 foreign
251 MAINTAINERCLEANFILES = Makefile.in
253 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
257 myapp_SOURCES = main.c
258 myapp_LDADD = @ELEMENTARY_LIBS@
262 * Notice that they are the same as before, just with libtool and library
263 * building sections removed. Both ways work for building elementary
264 * applications. It is up to you to decide what is best for you. If you just
265 * follow the template above, you can do it both ways and can decide at build
266 * time. The more advanced of you may suggest making it a configure option.
267 * That is perfectly valid, bu has been left out here for simplicity, as our
268 * aim to have an Elementary (and EFL) tutorial, not an autoconf & automake
273 static int _elm_signal_exit(void *data, int ev_type, void *ev);
275 char *_elm_appname = NULL;
276 const char *_elm_data_dir = NULL;
277 const char *_elm_lib_dir = NULL;
278 int _elm_log_dom = -1;
280 EAPI int ELM_EVENT_POLICY_CHANGED = 0;
282 static int _elm_init_count = 0;
283 static int _elm_policies[ELM_POLICY_LAST];
284 static Ecore_Event_Handler *_elm_exit_handler = NULL;
287 _elm_signal_exit(void *data __UNUSED__, int ev_type __UNUSED__, void *ev __UNUSED__)
296 edje_scale_set(_elm_config->scale);
300 static Eina_List *widtypes = NULL;
303 _elm_widtype_register(const char **ptr)
305 widtypes = eina_list_append(widtypes, (void *)ptr);
309 _elm_widtype_clear(void)
313 EINA_LIST_FREE(widtypes, ptr)
315 eina_stringshare_del(*ptr);
325 buf = getenv("ELM_THEME");
326 if (buf != NULL && ((!strcmp(buf, "beat") || !strcmp(buf, "kessler"))))
327 setenv("ELM_MODULES","ctxpopup_copypasteUI>entry/api",1);
331 * @defgroup General General
336 * Inititalise Elementary
338 * This call is exported only for use by the ELM_MAIN() macro. There is no
339 * need to use this if you use this macro (which is highly advisable).
343 elm_init(int argc, char **argv)
346 if (_elm_init_count != 1) return;
348 elm_quicklaunch_init(argc, argv);
349 elm_quicklaunch_sub_init(argc, argv);
353 * Shut down Elementary
355 * This should be called at the end of your application just before it ceases
356 * to do any more processing. This will clean up any permanent resources your
357 * application may have allocated via Elementary that would otherwise persist
358 * on an exit without this call.
365 if (_elm_init_count != 0) return;
366 elm_quicklaunch_sub_shutdown();
367 elm_quicklaunch_shutdown();
371 static Eina_Bool _elm_need_e_dbus = EINA_FALSE;
374 elm_need_e_dbus(void)
377 if (_elm_need_e_dbus) return;
378 _elm_need_e_dbus = 1;
385 _elm_unneed_e_dbus(void)
388 if (_elm_need_e_dbus)
390 _elm_need_e_dbus = 0;
398 static Eina_Bool _elm_need_efreet = EINA_FALSE;
401 elm_need_efreet(void)
404 if (_elm_need_efreet) return;
405 _elm_need_efreet = 1;
413 list = efreet_icon_extra_list_get();
416 e_user_dir_concat_static(buf, "icons");
417 *list = eina_list_prepend(*list, (void *)eina_stringshare_add(buf));
418 e_prefix_data_concat_static(buf, "data/icons");
419 *list = eina_list_prepend(*list, (void *)eina_stringshare_add(buf));
427 _elm_unneed_efreet(void)
430 if (_elm_need_efreet)
432 _elm_need_efreet = 0;
433 efreet_trash_shutdown();
434 efreet_mime_shutdown();
441 elm_quicklaunch_init(int argc, char **argv)
443 char buf[PATH_MAX], *s;
446 _elm_log_dom = eina_log_domain_register("elementary", EINA_COLOR_LIGHTBLUE);
449 EINA_LOG_ERR("could not register elementary log domain.");
450 _elm_log_dom = EINA_LOG_DOMAIN_GLOBAL;
455 ecore_app_args_set(argc, (const char **)argv);
457 memset(_elm_policies, 0, sizeof(_elm_policies));
458 if (ELM_EVENT_POLICY_CHANGED == 0)
459 ELM_EVENT_POLICY_CHANGED = ecore_event_type_new();
464 ecore_evas_init(); // FIXME: check errors
468 _elm_exit_handler = ecore_event_handler_add(ECORE_EVENT_SIGNAL_EXIT, _elm_signal_exit, NULL);
470 if (argv) _elm_appname = strdup(ecore_file_file_get(argv[0]));
474 s = getenv("ELM_DATA_DIR");
475 _elm_data_dir = eina_stringshare_add(s);
479 s = getenv("ELM_PREFIX");
482 snprintf(buf, sizeof(buf), "%s/share/elementary", s);
483 _elm_data_dir = eina_stringshare_add(buf);
488 s = getenv("ELM_LIB_DIR");
489 _elm_lib_dir = eina_stringshare_add(s);
493 s = getenv("ELM_PREFIX");
496 snprintf(buf, sizeof(buf), "%s/lib", s);
497 _elm_lib_dir = eina_stringshare_add(buf);
501 if ((!_elm_data_dir) || (!_elm_lib_dir))
503 Dl_info elementary_dl;
504 // libelementary.so/../../share/elementary/
505 if (dladdr(elm_init, &elementary_dl))
509 dir = ecore_file_dir_get(elementary_dl.dli_fname);
514 if (ecore_file_is_dir(dir))
515 _elm_lib_dir = eina_stringshare_add(dir);
519 dir2 = ecore_file_dir_get(dir);
522 snprintf(buf, sizeof(buf), "%s/share/elementary", dir2);
523 if (ecore_file_is_dir(buf))
524 _elm_data_dir = eina_stringshare_add(buf);
534 _elm_data_dir = eina_stringshare_add(PACKAGE_DATA_DIR);
536 _elm_data_dir = eina_stringshare_add("/");
538 _elm_lib_dir = eina_stringshare_add(PACKAGE_LIB_DIR);
540 _elm_lib_dir = eina_stringshare_add("/");
546 elm_quicklaunch_sub_init(int argc, char **argv)
548 ecore_app_args_set(argc, (const char **)argv);
549 _elm_config_sub_init();
553 elm_quicklaunch_sub_shutdown(void)
556 if ((_elm_config->engine == ELM_SOFTWARE_X11) ||
557 (_elm_config->engine == ELM_SOFTWARE_16_X11) ||
558 (_elm_config->engine == ELM_XRENDER_X11) ||
559 (_elm_config->engine == ELM_OPENGL_X11) ||
560 (_elm_config->engine == ELM_SOFTWARE_SDL) ||
561 (_elm_config->engine == ELM_SOFTWARE_16_SDL) ||
562 (_elm_config->engine == ELM_OPENGL_SDL) ||
563 (_elm_config->engine == ELM_SOFTWARE_WIN32) ||
564 (_elm_config->engine == ELM_SOFTWARE_16_WINCE))
566 #ifdef HAVE_ELEMENTARY_X
567 ecore_x_disconnect();
569 evas_cserve_disconnect();
574 elm_quicklaunch_shutdown(void)
576 eina_stringshare_del(_elm_data_dir);
577 _elm_data_dir = NULL;
578 eina_stringshare_del(_elm_lib_dir);
584 _elm_config_shutdown();
586 ecore_event_handler_del(_elm_exit_handler);
587 _elm_exit_handler = NULL;
589 _elm_theme_shutdown();
590 _elm_unneed_efreet();
591 _elm_unneed_e_dbus();
592 _elm_unneed_ethumb();
593 _elm_module_shutdown();
594 ecore_imf_shutdown();
595 ecore_evas_shutdown();
598 ecore_file_shutdown();
602 if ((_elm_log_dom > -1) && (_elm_log_dom != EINA_LOG_DOMAIN_GLOBAL))
604 eina_log_domain_unregister(_elm_log_dom);
608 _elm_widtype_clear();
614 elm_quicklaunch_seed(void)
616 Evas_Object *win, *bg, *bt;
618 win = elm_win_add(NULL, "seed", ELM_WIN_BASIC);
619 bg = elm_bg_add(win);
620 elm_win_resize_object_add(win, bg);
621 evas_object_show(bg);
622 bt = elm_button_add(win);
623 elm_button_label_set(bt, " abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~-_=+\\|]}[{;:'\",<.>/?");
624 elm_win_resize_object_add(win, bt);
625 ecore_main_loop_iterate();
626 evas_object_del(win);
627 ecore_main_loop_iterate();
628 if ((_elm_config->engine == ELM_SOFTWARE_X11) ||
629 (_elm_config->engine == ELM_SOFTWARE_16_X11) ||
630 (_elm_config->engine == ELM_XRENDER_X11) ||
631 (_elm_config->engine == ELM_OPENGL_X11))
633 #ifdef HAVE_ELEMENTARY_X
637 ecore_main_loop_iterate();
640 static void *qr_handle = NULL;
641 static int (*qr_main) (int argc, char **argv) = NULL;
644 elm_quicklaunch_prepare(int argc __UNUSED__, char **argv)
647 char *exe = elm_quicklaunch_exe_path_get(argv[0]);
650 ERR("requested quicklaunch binary '%s' does not exist\n", argv[0]);
658 exe2 = malloc(strlen(exe) + 1 + 10);
660 p = strrchr(exe2, '/');
663 exename = alloca(strlen(p) + 1);
666 strcat(p, "../lib/");
669 if (access(exe2, R_OK | X_OK) == 0)
677 qr_handle = dlopen(exe, RTLD_NOW | RTLD_GLOBAL);
680 fprintf(stderr, "dlerr: %s\n", dlerror());
681 WRN("dlopen('%s') failed: %s", exe, dlerror());
685 INF("dlopen('%s') = %p", exe, qr_handle);
687 qr_main = dlsym(qr_handle, "elm_main");
688 INF("dlsym(%p, 'elm_main') = %p", qr_handle, qr_main);
691 WRN("not quicklauncher capable: no elm_main in '%s'", exe);
707 extern char **environ;
712 for (i = 0, size = 0; environ[i] != NULL; i++)
713 size += strlen(environ[i]) + 1;
715 p = malloc((i + 1) * sizeof(char *));
720 for (i = 0; oldenv[i] != NULL; i++)
721 environ[i] = strdup(oldenv[i]);
727 elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data)
736 // need to accept current environment from elementary_run
743 if (child > 0) return EINA_TRUE;
746 perror("could not fork");
751 perror("could not chdir");
752 args = alloca((argc + 1) * sizeof(char *));
753 for (i = 0; i < argc; i++) args[i] = argv[i];
755 WRN("%s not quicklaunch capable, fallback...", argv[0]);
756 execvp(argv[0], args);
757 ERR("failed to execute '%s': %s", argv[0], strerror(errno));
761 if (child > 0) return EINA_TRUE;
764 perror("could not fork");
767 if (postfork_func) postfork_func(postfork_data);
771 perror("could not chdir");
772 // FIXME: this is very linux specific. it changes argv[0] of the process
773 // so ps etc. report what you'd expect. for other unixes and os's this
780 ecore_app_args_get(&real_argc, &real_argv);
781 lastarg = real_argv[real_argc - 1] + strlen(real_argv[real_argc - 1]);
782 for (p = real_argv[0]; p < lastarg; p++) *p = 0;
783 strcpy(real_argv[0], argv[0]);
785 ecore_app_args_set(argc, (const char **)argv);
786 ret = qr_main(argc, argv);
795 elm_quicklaunch_cleanup(void)
808 elm_quicklaunch_fallback(int argc, char **argv)
811 elm_quicklaunch_init(argc, argv);
812 elm_quicklaunch_sub_init(argc, argv);
813 elm_quicklaunch_prepare(argc, argv);
814 ret = qr_main(argc, argv);
820 elm_quicklaunch_exe_path_get(const char *exe)
822 static char *path = NULL;
823 static Eina_List *pathlist = NULL;
827 if (exe[0] == '/') return strdup(exe);
828 if ((exe[0] == '.') && (exe[1] == '/')) return strdup(exe);
829 if ((exe[0] == '.') && (exe[1] == '.') && (exe[2] == '/')) return strdup(exe);
834 path = getenv("PATH");
835 buf2 = alloca(strlen(path) + 1);
840 if ((*p == ':') || (*p == 0))
845 strncpy(buf2, pp, len);
847 pathlist = eina_list_append(pathlist, eina_stringshare_add(buf2));
859 EINA_LIST_FOREACH(pathlist, l, pathitr)
861 snprintf(buf, sizeof(buf), "%s/%s", pathitr, exe);
862 if (access(buf, R_OK | X_OK) == 0) return strdup(buf);
870 * This call should be called just after all initialization is complete. This
871 * function will not return until elm_exit() is called. It will keep looping
872 * running the main event/processing loop for Elementary.
878 ecore_main_loop_begin();
884 * If this call is called, it will flag the main loop to cease processing and
885 * return back to its parent function.
891 ecore_main_loop_quit();
896 * Set new policy value.
898 * This will emit the ecore event ELM_EVENT_POLICY_CHANGED in the main
899 * loop giving the event information Elm_Event_Policy_Changed with
900 * policy identifier, new and old values.
902 * @param policy policy identifier as in Elm_Policy.
903 * @param value policy value, depends on identifiers, usually there is
904 * an enumeration with the same prefix as the policy name, for
905 * example: ELM_POLICY_QUIT and Elm_Policy_Quit
906 * (ELM_POLICY_QUIT_NONE, ELM_POLICY_QUIT_LAST_WINDOW_CLOSED).
908 * @return @c EINA_TRUE on success or @c EINA_FALSE on error (right
909 * now just invalid policy identifier, but in future policy
910 * value might be enforced).
913 elm_policy_set(unsigned int policy, int value)
915 Elm_Event_Policy_Changed *ev;
917 if (policy >= ELM_POLICY_LAST)
920 if (value == _elm_policies[policy])
923 /* TODO: validade policy? */
925 ev = malloc(sizeof(*ev));
927 ev->new_value = value;
928 ev->old_value = _elm_policies[policy];
930 _elm_policies[policy] = value;
932 ecore_event_add(ELM_EVENT_POLICY_CHANGED, ev, NULL, NULL);
938 * Gets the policy value set for given identifier.
940 * @param policy policy identifier as in Elm_Policy.
942 * @return policy value. Will be 0 if policy identifier is invalid.
945 elm_policy_get(unsigned int policy)
947 if (policy >= ELM_POLICY_LAST)
949 return _elm_policies[policy];
953 * Flush all caches & dump all data that can be to lean down to use less memory
961 EINA_LIST_FOREACH(_elm_win_list, l, obj)
963 Evas *e = evas_object_evas_get(obj);
964 edje_file_cache_flush();
965 edje_collection_cache_flush();
966 evas_image_cache_flush(e);
967 evas_font_cache_flush(e);
973 * @defgroup Scaling Selective Widget Scaling
976 * Different widgets can be scaled independently. These functions allow you to
977 * manipulate this scaling on a per-widget basis. The object and all its
978 * children get their scaling factors multiplied by the scale factor set.
979 * This is multiplicative, in that if a child also has a scale size set it is
980 * in turn multiplied by its parent's scale size. 1.0 means “don't scale”,
981 * 2.0 is double size, 0.5 is half etc.
985 * Set the scaling factor
987 * @param obj The object
988 * @param scale Scale factor (from 0.0 up, with 1.0 == no scaling)
992 elm_object_scale_set(Evas_Object *obj, double scale)
994 elm_widget_scale_set(obj, scale);
998 * Get the scaling factor
1000 * @param obj The object
1001 * @return The scaling factor set by elm_object_scale_set()
1005 elm_object_scale_get(const Evas_Object *obj)
1007 return elm_widget_scale_get(obj);
1011 * @defgroup Styles Styles
1014 * Widgets can have different styles of look. These generic API's set
1015 * styles of widgets, if they support them (and if the theme(s) do).
1021 * This sets the name of the style
1022 * @param obj The object
1023 * @param style The style name to use
1027 elm_object_style_set(Evas_Object *obj, const char *style)
1029 elm_widget_style_set(obj, style);
1035 * This gets the style being used for that widget. Note that the string
1036 * pointer is only valid as longas the object is valid and the style doesn't
1039 * @param obj The object
1040 * @return The style name
1044 elm_object_style_get(const Evas_Object *obj)
1046 return elm_widget_style_get(obj);
1050 * Set the disable state
1052 * This sets the disable state for the widget.
1054 * @param obj The object
1055 * @param disabled The state
1059 elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled)
1061 elm_widget_disabled_set(obj, disabled);
1065 * Get the disable state
1067 * This gets the disable state for the widget.
1069 * @param obj The object
1070 * @return True, if the widget is disabled
1074 elm_object_disabled_get(const Evas_Object *obj)
1076 return elm_widget_disabled_get(obj);
1080 * Get the global scaling factor
1082 * This gets the globally configured scaling factor that is applied to all
1085 * @return The scaling factor
1091 return _elm_config->scale;
1095 * Set the global scaling factor
1097 * This sets the globally configured scaling factor that is applied to all
1100 * @param scale The scaling factor to set
1104 elm_scale_set(double scale)
1106 if (_elm_config->scale == scale) return;
1107 _elm_config->scale = scale;
1112 * Set the global scaling factor for all applications on the display
1114 * This sets the globally configured scaling factor that is applied to all
1115 * objects for all applications.
1116 * @param scale The scaling factor to set
1120 elm_scale_all_set(double scale)
1122 #ifdef HAVE_ELEMENTARY_X
1123 static Ecore_X_Atom atom = 0;
1124 unsigned int scale_i = (unsigned int)(scale * 1000.0);
1126 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_SCALE");
1127 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1133 * @defgroup Fingers Fingers
1136 * Elementary is designed to be finger-friendly for touchscreens, and so in
1137 * addition to scaling for display resolution, it can also scale based on
1138 * finger "resolution" (or size).
1142 * Get the configured finger size
1144 * This gets the globally configured finger size in pixels
1146 * @return The finger size
1150 elm_finger_size_get(void)
1152 return _elm_config->finger_size;
1156 * Set the configured finger size
1158 * This sets the globally configured finger size in pixels
1160 * @param size The finger size
1164 elm_finger_size_set(Evas_Coord size)
1166 if (_elm_config->finger_size == size) return;
1167 _elm_config->finger_size = size;
1172 * Set the configured finger size for all applications on the display
1174 * This sets the globally configured finger size in pixels for all applications
1177 * @param size The finger size
1181 elm_finger_size_all_set(Evas_Coord size)
1183 #ifdef HAVE_ELEMENTARY_X
1184 static Ecore_X_Atom atom = 0;
1185 unsigned int size_i = (unsigned int)size;
1187 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FINGER_SIZE");
1188 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1194 * Adjust size of an element for finger usage
1196 * This takes width and height sizes (in pixels) as input and a size multiple
1197 * (which is how many fingers you want to place within the area), and adjusts
1198 * the size tobe large enough to accomodate finger. On return the w and h
1199 * sizes poiner do by these parameters will be modified.
1201 * @param times_w How many fingers should fit horizontally
1202 * @param w Pointer to the width size to adjust
1203 * @param times_h How many fingers should fit vertically
1204 * @param h Pointer to the height size to adjust
1208 elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h)
1210 if ((w) && (*w < (_elm_config->finger_size * times_w)))
1211 *w = _elm_config->finger_size * times_w;
1212 if ((h) && (*h < (_elm_config->finger_size * times_h)))
1213 *h = _elm_config->finger_size * times_h;
1217 * @defgroup Focus Focus
1220 * Objects have focus. This is what determines where the keyboard input goes to
1221 * within the application window.
1225 * Get the focus of the object
1227 * This gets the focused property of the object.
1229 * @param obj The object
1230 * @return 1 if the object is focused, 0 if not.
1234 elm_object_focus_get(Evas_Object *obj)
1236 return elm_widget_focus_get(obj);
1240 * Set the focus to the object
1242 * This sets the focus target for keyboard input to be the object indicated.
1244 * @param obj The object
1248 elm_object_focus(Evas_Object *obj)
1250 if (!elm_widget_can_focus_get(obj)) return;
1251 elm_widget_focus_steal(obj);
1255 * Remove the focus from the object
1257 * This removes the focus target for keyboard input from be the object
1260 * @param obj The object
1264 elm_object_unfocus(Evas_Object *obj)
1266 if (!elm_widget_can_focus_get(obj)) return;
1267 elm_widget_focused_object_clear(obj);
1271 * Set the ability for the object to focus
1273 * This sets the ability for the object to be able to get keyboard focus or
1274 * not. By default all objects are able to be focused.
1276 * @param obj The object
1277 * @param enable 1 if the object can be focused, 0 if not
1281 elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable)
1283 elm_widget_can_focus_set(obj, enable);
1287 * Get the ability for the object to focus
1289 * This gets the ability for the object to be able to get keyboard focus or
1290 * not. By default all objects are able to be focused.
1292 * @param obj The object
1293 * @return 1 if the object is allowed to be focused, 0 if not.
1297 elm_object_focus_allow_get(const Evas_Object *obj)
1299 return elm_widget_can_focus_get(obj);
1303 * @defgroup Scrollhints Scrollhints
1306 * Objects when inside a scroller can scroll, but this may not always be
1307 * desireable in certain situations. This allows an object to hint to itself
1308 * and parents to "not scroll" in one of 2 ways.
1310 * 1. To hold on scrolling. This means just flicking and dragging may no
1311 * longer scroll, but pressing/dragging near an edge of the scroller will
1312 * still scroll. This is automastically used by the entry object when
1314 * 2. To totally freeze scrolling. This means it stops. until popped/released.
1318 * Push the scroll hold by 1
1320 * This increments the scroll hold count by one. If it is more than 0 it will
1321 * take effect on the parents of the indicated object.
1323 * @param obj The object
1324 * @ingroup Scrollhints
1327 elm_object_scroll_hold_push(Evas_Object *obj)
1329 elm_widget_scroll_hold_push(obj);
1333 * Pop the scroll hold by 1
1335 * This decrements the scroll hold count by one. If it is more than 0 it will
1336 * take effect on the parents of the indicated object.
1338 * @param obj The object
1339 * @ingroup Scrollhints
1342 elm_object_scroll_hold_pop(Evas_Object *obj)
1344 elm_widget_scroll_hold_pop(obj);
1348 * Push the scroll freeze by 1
1350 * This increments the scroll freeze count by one. If it is more than 0 it will
1351 * take effect on the parents of the indicated object.
1353 * @param obj The object
1354 * @ingroup Scrollhints
1357 elm_object_scroll_freeze_push(Evas_Object *obj)
1359 elm_widget_scroll_freeze_push(obj);
1363 * Lock the scrolling of the given widget (and thus all parents)
1365 * This locks the given object from scrolling in the X axis (and implicitly
1366 * also locks all parent scrollers too from doing the same).
1368 * @param obj The object
1369 * @param lock The lock state (1 == locked, 0 == unlocked)
1370 * @ingroup Scrollhints
1373 elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock)
1375 elm_widget_drag_lock_x_set(obj, lock);
1379 * Lock the scrolling of the given widget (and thus all parents)
1381 * This locks the given object from scrolling in the Y axis (and implicitly
1382 * also locks all parent scrollers too from doing the same).
1384 * @param obj The object
1385 * @param lock The lock state (1 == locked, 0 == unlocked)
1386 * @ingroup Scrollhints
1389 elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock)
1391 elm_widget_drag_lock_y_set(obj, lock);
1395 * Get the scrolling lock of the given widget
1397 * This gets the lock for X axis scrolling.
1399 * @param obj The object
1400 * @ingroup Scrollhints
1403 elm_object_scroll_lock_x_get(const Evas_Object *obj)
1405 return elm_widget_drag_lock_x_get(obj);
1409 * Get the scrolling lock of the given widget
1411 * This gets the lock for X axis scrolling.
1413 * @param obj The object
1414 * @ingroup Scrollhints
1417 elm_object_scroll_lock_y_get(const Evas_Object *obj)
1419 return elm_widget_drag_lock_y_get(obj);
1423 * Pop the scroll freeze by 1
1425 * This decrements the scroll freeze count by one. If it is more than 0 it will
1426 * take effect on the parents of the indicated object.
1428 * @param obj The object
1429 * @ingroup Scrollhints
1432 elm_object_scroll_freeze_pop(Evas_Object *obj)
1434 elm_widget_scroll_freeze_pop(obj);
1439 * Check if the given Evas Object is an Elementary widget.
1441 * @param obj the object to query.
1442 * @return @c EINA_TRUE if it is an elementary widget variant,
1443 * @c EINA_FALSE otherwise
1446 elm_object_widget_check(const Evas_Object *obj)
1448 return elm_widget_is(obj);
1452 * Get the first parent of the given object that is an Elementary widget.
1454 * @param obj the object to query.
1455 * @return the parent object that is an Elementary widget, or @c NULL
1456 * if no parent is, or no parents at all.
1459 elm_object_parent_widget_get(const Evas_Object *obj)
1461 return elm_widget_parent_widget_get(obj);
1465 * Get the string that represents this Elementary widget.
1467 * @note Elementary is weird and exposes itself as a single
1468 * Evas_Object_Smart_Class of type "elm_widget", so
1469 * evas_object_type_get() always return that, making debug and
1470 * language bindings hard. This function tries to mitigate this
1471 * problem, but the solution is to change Elementary to use
1472 * proper inheritance.
1474 * @param obj the object to query.
1475 * @return Elementary widget name, or @c NULL if not a valid widget.
1478 elm_object_widget_type_get(const Evas_Object *obj)
1480 return elm_widget_type_get(obj);