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;
26 * @defgroup Start Getting Started
28 * To write an Elementary app, you can get started with the following:
31 * #include <Elementary.h>
32 * #ifndef ELM_LIB_QUICKLAUNCH
34 * elm_main(int argc, char **argv)
36 * // create window(s) here and do any application init
37 * elm_run(); // run main loop
38 * elm_shutdown(); // after mainloop finishes running, shutdown
39 * return 0; // exit 0 for exit code
45 * To take full advantage of the quicklaunch architecture for launching
46 * processes as quickly as possible (saving time at startup time like
47 * connecting to X11, loading and linking shared libraries) you may want to
48 * use the following configure.in/configure.ac and Makefile.am and autogen.sh
49 * script to generate your files. It is assumed your application uses the
50 * main.c file for its code.
52 * configure.in/configure.ac:
55 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
57 AC_CONFIG_SRCDIR(configure.in)
59 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
60 AM_CONFIG_HEADER(config.h)
70 define([AC_LIBTOOL_LANG_CXX_CONFIG], [:])dnl
71 define([AC_LIBTOOL_LANG_F77_CONFIG], [:])dnl
74 PKG_CHECK_MODULES([ELEMENTARY], elementary)
82 AUTOMAKE_OPTIONS = 1.4 foreign
83 MAINTAINERCLEANFILES = Makefile.in
85 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
88 myapp_LTLIBRARIES = myapp.la
92 myapp_la_SOURCES = main.c
93 myapp_la_LIBADD = @ELEMENTARY_LIBS@
95 myapp_la_LDFLAGS = -module -avoid-version -no-undefined
97 myapp_SOURCES = main.c
98 myapp_LDADD = @ELEMENTARY_LIBS@
99 myapp_CFLAGS = -DELM_LIB_QUICKLAUNCH=1
106 rm -rf autom4te.cache
107 rm -f aclocal.m4 ltmain.sh
112 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS -I m4 || exit 1
113 echo "Running autoheader..." ; autoheader || exit 1
114 echo "Running autoconf..." ; autoconf || exit 1
115 echo "Running libtoolize..." ; (libtoolize --copy --automake || glibtoolize --automake) || exit 1
116 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
118 if [ -z "$NOCONFIGURE" ]; then
123 * To gnerate all the things needed to bootstrap just run:
129 * This will generate Makefile.in's, the confgure script and everything else.
130 * After this it works like all normal autotools projects:
137 * Note sudo was assumed to get root permissions, as this would install in
138 * /usr/local which is system-owned. Ue any way you like to gain root, or
139 * specify a different prefix with configure:
142 ./confiugre --prefix=$HOME/mysoftware
145 * Also remember that autotools buys you some useful commands like:
150 * This uninstalls the software after it was installed with "make install".
151 * It is very useful to clear up what you built if you wish to clean the
158 * This firstly checks if your build tree is "clean" and ready for
159 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
160 * ready to upload and distribute to the world, that contains the generated
161 * Makefile.in's and configure script. The users do not need to run
162 * autogen.sh - just configure and on. They don't need autotools installed.
163 * This tarball also builds cleanly, has all the sources it needs to build
164 * included (that is sources for your application, not libraries it depends
165 * on like Elementary). It builds cleanly in a buildroot and does not
166 * contain any files that are temporarily generated like binaries and other
167 * build-gnerated files, so the tarball is clean, and no need to worry
168 * about cleaning up your tree before packaging.
174 * This cleans up all build files (binaries, objects etc.) from the tree.
180 * This cleans out all files from the build and from configure's output too.
183 make maintainer-clean
186 * This deletes all the files autogen.sh will produce so the tree is clean
187 * to be put into a revision-control system (like CVS, SVN or GIT for example).
189 * The above will build a library - libmyapp.so and install in the target
190 * library directory (default is /usr/local/lib). You will also get a
191 * myapp.a and myapp.la - these are useless and can be deleted. Libtool likes
192 * to generate these all the time. You will also get a binary in the target
193 * binary directory (default is /usr/local/bin). This is a "debug binary".
194 * This will run and dlopen() the myapp.so and then jump to it's elm_main
195 * function. This allows for easy debugging with GDB and Valgrind. When you
196 * are ready to go to production do the following:
198 * 1. delete the myapp binary. i.e. rm /usr/local/bin/myapp
200 * 2. symlink the myapp binary to elementary_run (supplied by elementary).
201 * i.e. ln -s elmentary_run /usr/local/bin/myapp
203 * 3. run elementary_quicklaunch as part of your graphical login session and
206 * This will man elementary_quicklaunch does pre-initialization before the
207 * application needs to be run, saving the effort at the time the application
208 * is needed, thus speeding up the time it takes to appear.
210 * If you don't want to use the quicklaunch infrastructure (which is
211 * optional), you can execute the old fashioned way by just running the
212 * myapp binary loader than will load the myapp.so for you, or you can
213 * remove the split-file binary and put it into one binary as things always
214 * have been with the following configure.in/configure.ac and Makfile.am
217 * configure.in/configure.ac:
220 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
222 AC_CONFIG_SRCDIR(configure.in)
224 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
225 AM_CONFIG_HEADER(config.h)
234 PKG_CHECK_MODULES([ELEMENTARY], elementary)
242 AUTOMAKE_OPTIONS = 1.4 foreign
243 MAINTAINERCLEANFILES = Makefile.in
245 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
249 myapp_SOURCES = main.c
250 myapp_LDADD = @ELEMENTARY_LIBS@
254 * Notice that they are the same as before, just with libtool and library
255 * building sections removed. Both ways work for building elementary
256 * applications. It is up to you to decide what is best for you. If you just
257 * follow the template above, you can do it both ways and can decide at build
258 * time. The more advanced of you may suggest making it a configure option.
259 * That is perfectly valid, bu has been left out here for simplicity, as our
260 * aim to have an Elementary (and EFL) tutorial, not an autoconf & automake
265 static int _elm_signal_exit(void *data, int ev_type, void *ev);
267 char *_elm_appname = NULL;
268 const char *_elm_data_dir = NULL;
269 const char *_elm_lib_dir = NULL;
270 int _elm_log_dom = -1;
272 EAPI int ELM_EVENT_POLICY_CHANGED = 0;
274 static int _elm_init_count = 0;
275 static int _elm_policies[ELM_POLICY_LAST];
276 static Ecore_Event_Handler *_elm_exit_handler = NULL;
279 _elm_signal_exit(void *data __UNUSED__, int ev_type __UNUSED__, void *ev __UNUSED__)
288 edje_scale_set(_elm_config->scale);
293 * @defgroup General General
297 * Inititalise Elementary
299 * This call is exported only for use by the ELM_MAIN() macro. There is no
300 * need to use this if you use this macro (which is highly advisable).
304 elm_init(int argc, char **argv)
307 if (_elm_init_count != 1) return;
308 elm_quicklaunch_init(argc, argv);
309 elm_quicklaunch_sub_init(argc, argv);
313 * Shut down Elementary
315 * This should be called at the end of your application just before it ceases
316 * to do any more processing. This will clean up any permanent resources your
317 * application may have allocated via Elementary that would otherwise persist
318 * on an exit without this call.
325 if (_elm_init_count != 0) return;
326 elm_quicklaunch_sub_shutdown();
327 elm_quicklaunch_shutdown();
331 static Eina_Bool _elm_need_e_dbus = EINA_FALSE;
334 elm_need_e_dbus(void)
337 if (_elm_need_e_dbus) return;
338 _elm_need_e_dbus = 1;
345 _elm_unneed_e_dbus(void)
348 if (_elm_need_e_dbus)
350 _elm_need_e_dbus = 0;
358 static Eina_Bool _elm_need_efreet = EINA_FALSE;
361 elm_need_efreet(void)
364 if (_elm_need_efreet) return;
365 _elm_need_efreet = 1;
373 list = efreet_icon_extra_list_get();
376 e_user_dir_concat_static(buf, "icons");
377 *list = eina_list_prepend(*list, (void *)eina_stringshare_add(buf));
378 e_prefix_data_concat_static(buf, "data/icons");
379 *list = eina_list_prepend(*list, (void *)eina_stringshare_add(buf));
387 _elm_unneed_efreet(void)
390 if (_elm_need_efreet)
392 _elm_need_efreet = 0;
393 efreet_trash_shutdown();
394 efreet_mime_shutdown();
401 elm_quicklaunch_init(int argc, char **argv)
403 char buf[PATH_MAX], *s;
406 _elm_log_dom = eina_log_domain_register("elementary", EINA_COLOR_LIGHTBLUE);
409 EINA_LOG_ERR("could not register elementary log domain.");
410 _elm_log_dom = EINA_LOG_DOMAIN_GLOBAL;
415 ecore_app_args_set(argc, (const char **)argv);
417 memset(_elm_policies, 0, sizeof(_elm_policies));
418 if (ELM_EVENT_POLICY_CHANGED == 0)
419 ELM_EVENT_POLICY_CHANGED = ecore_event_type_new();
424 ecore_evas_init(); // FIXME: check errors
428 _elm_exit_handler = ecore_event_handler_add(ECORE_EVENT_SIGNAL_EXIT, _elm_signal_exit, NULL);
430 if (argv) _elm_appname = strdup(ecore_file_file_get(argv[0]));
434 s = getenv("ELM_DATA_DIR");
435 _elm_data_dir = eina_stringshare_add(s);
439 s = getenv("ELM_PREFIX");
442 snprintf(buf, sizeof(buf), "%s/share/elementary", s);
443 _elm_data_dir = eina_stringshare_add(buf);
448 s = getenv("ELM_LIB_DIR");
449 _elm_lib_dir = eina_stringshare_add(s);
453 s = getenv("ELM_PREFIX");
456 snprintf(buf, sizeof(buf), "%s/lib", s);
457 _elm_lib_dir = eina_stringshare_add(buf);
461 if ((!_elm_data_dir) || (!_elm_lib_dir))
463 Dl_info elementary_dl;
464 // libelementary.so/../../share/elementary/
465 if (dladdr(elm_init, &elementary_dl))
469 dir = ecore_file_dir_get(elementary_dl.dli_fname);
474 if (ecore_file_is_dir(dir))
475 _elm_lib_dir = eina_stringshare_add(dir);
479 dir2 = ecore_file_dir_get(dir);
482 snprintf(buf, sizeof(buf), "%s/share/elementary", dir2);
483 if (ecore_file_is_dir(buf))
484 _elm_data_dir = eina_stringshare_add(buf);
494 _elm_data_dir = eina_stringshare_add(PACKAGE_DATA_DIR);
496 _elm_data_dir = eina_stringshare_add("/");
498 _elm_lib_dir = eina_stringshare_add(PACKAGE_LIB_DIR);
500 _elm_lib_dir = eina_stringshare_add("/");
506 elm_quicklaunch_sub_init(int argc, char **argv)
508 ecore_app_args_set(argc, (const char **)argv);
509 _elm_config_sub_init();
513 elm_quicklaunch_sub_shutdown(void)
516 if ((_elm_config->engine == ELM_SOFTWARE_X11) ||
517 (_elm_config->engine == ELM_SOFTWARE_16_X11) ||
518 (_elm_config->engine == ELM_XRENDER_X11) ||
519 (_elm_config->engine == ELM_OPENGL_X11) ||
520 (_elm_config->engine == ELM_SOFTWARE_SDL) ||
521 (_elm_config->engine == ELM_SOFTWARE_16_SDL) ||
522 (_elm_config->engine == ELM_OPENGL_SDL) ||
523 (_elm_config->engine == ELM_SOFTWARE_WIN32) ||
524 (_elm_config->engine == ELM_SOFTWARE_16_WINCE))
526 #ifdef HAVE_ELEMENTARY_X
527 ecore_x_disconnect();
529 evas_cserve_disconnect();
534 elm_quicklaunch_shutdown(void)
536 eina_stringshare_del(_elm_data_dir);
537 _elm_data_dir = NULL;
538 eina_stringshare_del(_elm_lib_dir);
544 _elm_config_shutdown();
546 ecore_event_handler_del(_elm_exit_handler);
547 _elm_exit_handler = NULL;
549 _elm_theme_shutdown();
550 _elm_unneed_efreet();
551 _elm_unneed_e_dbus();
552 _elm_unneed_ethumb();
553 _elm_module_shutdown();
554 ecore_imf_shutdown();
555 ecore_evas_shutdown();
558 ecore_file_shutdown();
562 if ((_elm_log_dom > -1) && (_elm_log_dom != EINA_LOG_DOMAIN_GLOBAL))
564 eina_log_domain_unregister(_elm_log_dom);
572 elm_quicklaunch_seed(void)
574 Evas_Object *win, *bg, *bt;
576 win = elm_win_add(NULL, "seed", ELM_WIN_BASIC);
577 bg = elm_bg_add(win);
578 elm_win_resize_object_add(win, bg);
579 evas_object_show(bg);
580 bt = elm_button_add(win);
581 elm_button_label_set(bt, " abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~-_=+\\|]}[{;:'\",<.>/?");
582 elm_win_resize_object_add(win, bt);
583 ecore_main_loop_iterate();
584 evas_object_del(win);
585 ecore_main_loop_iterate();
586 if ((_elm_config->engine == ELM_SOFTWARE_X11) ||
587 (_elm_config->engine == ELM_SOFTWARE_16_X11) ||
588 (_elm_config->engine == ELM_XRENDER_X11) ||
589 (_elm_config->engine == ELM_OPENGL_X11))
591 #ifdef HAVE_ELEMENTARY_X
595 ecore_main_loop_iterate();
598 static void *qr_handle = NULL;
599 static int (*qr_main) (int argc, char **argv) = NULL;
602 elm_quicklaunch_prepare(int argc __UNUSED__, char **argv)
605 char *exe = elm_quicklaunch_exe_path_get(argv[0]);
608 ERR("requested quicklaunch binary '%s' does not exist\n", argv[0]);
616 exe2 = malloc(strlen(exe) + 1 + 10);
618 p = strrchr(exe2, '/');
621 exename = alloca(strlen(p) + 1);
624 strcat(p, "../lib/");
627 if (access(exe2, R_OK | X_OK) == 0)
635 qr_handle = dlopen(exe, RTLD_NOW | RTLD_GLOBAL);
638 fprintf(stderr, "dlerr: %s\n", dlerror());
639 WRN("dlopen('%s') failed: %s", exe, dlerror());
643 INF("dlopen('%s') = %p", exe, qr_handle);
645 qr_main = dlsym(qr_handle, "elm_main");
646 INF("dlsym(%p, 'elm_main') = %p", qr_handle, qr_main);
649 WRN("not quicklauncher capable: no elm_main in '%s'", exe);
665 extern char **environ;
670 for (i = 0, size = 0; environ[i] != NULL; i++)
671 size += strlen(environ[i]) + 1;
673 p = malloc((i + 1) * sizeof(char *));
678 for (i = 0; oldenv[i] != NULL; i++)
679 environ[i] = strdup(oldenv[i]);
685 elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data)
694 // need to accept current environment from elementary_run
701 if (child > 0) return EINA_TRUE;
704 perror("could not fork");
709 perror("could not chdir");
710 args = alloca((argc + 1) * sizeof(char *));
711 for (i = 0; i < argc; i++) args[i] = argv[i];
713 WRN("%s not quicklaunch capable, fallback...", argv[0]);
714 execvp(argv[0], args);
715 ERR("failed to execute '%s': %s", argv[0], strerror(errno));
719 if (child > 0) return EINA_TRUE;
722 perror("could not fork");
725 if (postfork_func) postfork_func(postfork_data);
729 perror("could not chdir");
730 // FIXME: this is very linux specific. it changes argv[0] of the process
731 // so ps etc. report what you'd expect. for other unixes and os's this
738 ecore_app_args_get(&real_argc, &real_argv);
739 lastarg = real_argv[real_argc - 1] + strlen(real_argv[real_argc - 1]);
740 for (p = real_argv[0]; p < lastarg; p++) *p = 0;
741 strcpy(real_argv[0], argv[0]);
743 ecore_app_args_set(argc, (const char **)argv);
744 ret = qr_main(argc, argv);
753 elm_quicklaunch_cleanup(void)
766 elm_quicklaunch_fallback(int argc, char **argv)
769 elm_quicklaunch_init(argc, argv);
770 elm_quicklaunch_sub_init(argc, argv);
771 elm_quicklaunch_prepare(argc, argv);
772 ret = qr_main(argc, argv);
778 elm_quicklaunch_exe_path_get(const char *exe)
780 static char *path = NULL;
781 static Eina_List *pathlist = NULL;
785 if (exe[0] == '/') return strdup(exe);
786 if ((exe[0] == '.') && (exe[1] == '/')) return strdup(exe);
787 if ((exe[0] == '.') && (exe[1] == '.') && (exe[2] == '/')) return strdup(exe);
792 path = getenv("PATH");
793 buf2 = alloca(strlen(path) + 1);
798 if ((*p == ':') || (*p == 0))
803 strncpy(buf2, pp, len);
805 pathlist = eina_list_append(pathlist, eina_stringshare_add(buf2));
817 EINA_LIST_FOREACH(pathlist, l, pathitr)
819 snprintf(buf, sizeof(buf), "%s/%s", pathitr, exe);
820 if (access(buf, R_OK | X_OK) == 0) return strdup(buf);
828 * This call should be called just after all initialization is complete. This
829 * function will not return until elm_exit() is called. It will keep looping
830 * running the main event/processing loop for Elementary.
836 ecore_main_loop_begin();
842 * If this call is called, it will flag the main loop to cease processing and
843 * return back to its parent function.
849 ecore_main_loop_quit();
854 * Set new policy value.
856 * This will emit the ecore event ELM_EVENT_POLICY_CHANGED in the main
857 * loop giving the event information Elm_Event_Policy_Changed with
858 * policy identifier, new and old values.
860 * @param policy policy identifier as in Elm_Policy.
861 * @param value policy value, depends on identifiers, usually there is
862 * an enumeration with the same prefix as the policy name, for
863 * example: ELM_POLICY_QUIT and Elm_Policy_Quit
864 * (ELM_POLICY_QUIT_NONE, ELM_POLICY_QUIT_LAST_WINDOW_CLOSED).
866 * @return @c EINA_TRUE on success or @c EINA_FALSE on error (right
867 * now just invalid policy identifier, but in future policy
868 * value might be enforced).
871 elm_policy_set(unsigned int policy, int value)
873 Elm_Event_Policy_Changed *ev;
875 if (policy >= ELM_POLICY_LAST)
878 if (value == _elm_policies[policy])
881 /* TODO: validade policy? */
883 ev = malloc(sizeof(*ev));
885 ev->new_value = value;
886 ev->old_value = _elm_policies[policy];
888 _elm_policies[policy] = value;
890 ecore_event_add(ELM_EVENT_POLICY_CHANGED, ev, NULL, NULL);
896 * Gets the policy value set for given identifier.
898 * @param policy policy identifier as in Elm_Policy.
900 * @return policy value. Will be 0 if policy identifier is invalid.
903 elm_policy_get(unsigned int policy)
905 if (policy >= ELM_POLICY_LAST)
907 return _elm_policies[policy];
911 * Flush all caches & dump all data that can be to lean down to use less memory
919 EINA_LIST_FOREACH(_elm_win_list, l, obj)
921 Evas *e = evas_object_evas_get(obj);
922 edje_file_cache_flush();
923 edje_collection_cache_flush();
924 evas_image_cache_flush(e);
925 evas_font_cache_flush(e);
931 * @defgroup Scaling Selective Widget Scaling
933 * Different widgets can be scaled independently. These functions allow you to
934 * manipulate this scaling on a per-widget basis. The object and all its
935 * children get their scaling factors multiplied by the scale factor set.
936 * This is multiplicative, in that if a child also has a scale size set it is
937 * in turn multiplied by its parent's scale size. 1.0 means “don't scale”,
938 * 2.0 is double size, 0.5 is half etc.
942 * Set the scaling factor
944 * @param obj The object
945 * @param scale Scale factor (from 0.0 up, with 1.0 == no scaling)
949 elm_object_scale_set(Evas_Object *obj, double scale)
951 elm_widget_scale_set(obj, scale);
955 * Get the scaling factor
957 * @param obj The object
958 * @return The scaling factor set by elm_object_scale_set()
962 elm_object_scale_get(const Evas_Object *obj)
964 return elm_widget_scale_get(obj);
968 * @defgroup Styles Styles
970 * Widgets can have different styles of look. These generic API's set
971 * styles of widgets, if they support them (and if the theme(s) do).
977 * This sets the name of the style
978 * @param obj The object
979 * @param style The style name to use
983 elm_object_style_set(Evas_Object *obj, const char *style)
985 elm_widget_style_set(obj, style);
991 * This gets the style being used for that widget. Note that the string
992 * pointer is only valid as longas the object is valid and the style doesn't
995 * @param obj The object
996 * @return The style name
1000 elm_object_style_get(const Evas_Object *obj)
1002 return elm_widget_style_get(obj);
1006 * Set the disable state
1008 * This sets the disable state for the widget.
1010 * @param obj The object
1011 * @param disabled The state
1015 elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled)
1017 elm_widget_disabled_set(obj, disabled);
1021 * Get the disable state
1023 * This gets the disable state for the widget.
1025 * @param obj The object
1026 * @return True, if the widget is disabled
1030 elm_object_disabled_get(const Evas_Object *obj)
1032 return elm_widget_disabled_get(obj);
1036 * Get the global scaling factor
1038 * This gets the globally configured scaling factor that is applied to all
1041 * @return The scaling factor
1047 return _elm_config->scale;
1051 * Set the global scaling factor
1053 * This sets the globally configured scaling factor that is applied to all
1056 * @param scale The scaling factor to set
1060 elm_scale_set(double scale)
1062 if (_elm_config->scale == scale) return;
1063 _elm_config->scale = scale;
1068 * Set the global scaling factor for all applications on the display
1070 * This sets the globally configured scaling factor that is applied to all
1071 * objects for all applications.
1072 * @param scale The scaling factor to set
1076 elm_scale_all_set(double scale)
1078 #ifdef HAVE_ELEMENTARY_X
1079 static Ecore_X_Atom atom = 0;
1080 unsigned int scale_i = (unsigned int)(scale * 1000.0);
1082 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_SCALE");
1083 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1089 * @defgroup Fingers Fingers
1091 * Elementary is designed to be finger-friendly for touchscreens, and so in
1092 * addition to scaling for display resolution, it can also scale based on
1093 * finger "resolution" (or size).
1097 * Get the configured finger size
1099 * This gets the globally configured finger size in pixels
1101 * @return The finger size
1105 elm_finger_size_get(void)
1107 return _elm_config->finger_size;
1111 * Set the configured finger size
1113 * This sets the globally configured finger size in pixels
1115 * @param size The finger size
1119 elm_finger_size_set(Evas_Coord size)
1121 if (_elm_config->finger_size == size) return;
1122 _elm_config->finger_size = size;
1127 * Set the configured finger size for all applications on the display
1129 * This sets the globally configured finger size in pixels for all applications
1132 * @param size The finger size
1136 elm_finger_size_all_set(Evas_Coord size)
1138 #ifdef HAVE_ELEMENTARY_X
1139 static Ecore_X_Atom atom = 0;
1140 unsigned int size_i = (unsigned int)size;
1142 if (!atom) atom = ecore_x_atom_get("ENLIGHTENMENT_FINGER_SIZE");
1143 ecore_x_window_prop_card32_set(ecore_x_window_root_first_get(),
1149 * Adjust size of an element for finger usage
1151 * This takes width and height sizes (in pixels) as input and a size multiple
1152 * (which is how many fingers you want to place within the area), and adjusts
1153 * the size tobe large enough to accomodate finger. On return the w and h
1154 * sizes poiner do by these parameters will be modified.
1156 * @param times_w How many fingers should fit horizontally
1157 * @param w Pointer to the width size to adjust
1158 * @param times_h How many fingers should fit vertically
1159 * @param h Pointer to the height size to adjust
1163 elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h)
1165 if ((w) && (*w < (_elm_config->finger_size * times_w)))
1166 *w = _elm_config->finger_size * times_w;
1167 if ((h) && (*h < (_elm_config->finger_size * times_h)))
1168 *h = _elm_config->finger_size * times_h;
1172 * @defgroup Focus Focus
1174 * Objects have focus. This is what determines where the keyboard input goes to
1175 * within the application window.
1179 * Get the focus of the object
1181 * This gets the focused property of the object.
1183 * @param obj The object
1184 * @return 1 if the object is focused, 0 if not.
1188 elm_object_focus_get(Evas_Object *obj)
1190 return elm_widget_focus_get(obj);
1194 * Set the focus to the object
1196 * This sets the focus target for keyboard input to be the object indicated.
1198 * @param obj The object
1202 elm_object_focus(Evas_Object *obj)
1204 if (!elm_widget_can_focus_get(obj)) return;
1205 elm_widget_focus_steal(obj);
1209 * Remove the focus from the object
1211 * This removes the focus target for keyboard input from be the object
1214 * @param obj The object
1218 elm_object_unfocus(Evas_Object *obj)
1220 if (!elm_widget_can_focus_get(obj)) return;
1221 elm_widget_focused_object_clear(obj);
1225 * Set the ability for the object to focus
1227 * This sets the ability for the object to be able to get keyboard focus or
1228 * not. By default all objects are able to be focused.
1230 * @param obj The object
1231 * @param enable 1 if the object can be focused, 0 if not
1235 elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable)
1237 elm_widget_can_focus_set(obj, enable);
1241 * Get the ability for the object to focus
1243 * This gets the ability for the object to be able to get keyboard focus or
1244 * not. By default all objects are able to be focused.
1246 * @param obj The object
1247 * @return 1 if the object is allowed to be focused, 0 if not.
1251 elm_object_focus_allow_get(const Evas_Object *obj)
1253 return elm_widget_can_focus_get(obj);
1257 * @defgroup Scrollhints Scrollhints
1259 * Objects when inside a scroller can scroll, but this may not always be
1260 * desireable in certain situations. This allows an object to hint to itself
1261 * and parents to "not scroll" in one of 2 ways.
1263 * 1. To hold on scrolling. This means just flicking and dragging may no
1264 * longer scroll, but pressing/dragging near an edge of the scroller will
1265 * still scroll. This is automastically used by the entry object when
1267 * 2. To totally freeze scrolling. This means it stops. until popped/released.
1271 * Push the scroll hold by 1
1273 * This increments the scroll hold count by one. If it is more than 0 it will
1274 * take effect on the parents of the indicated object.
1276 * @param obj The object
1277 * @ingroup Scrollhints
1280 elm_object_scroll_hold_push(Evas_Object *obj)
1282 elm_widget_scroll_hold_push(obj);
1286 * Pop the scroll hold by 1
1288 * This decrements the scroll hold count by one. If it is more than 0 it will
1289 * take effect on the parents of the indicated object.
1291 * @param obj The object
1292 * @ingroup Scrollhints
1295 elm_object_scroll_hold_pop(Evas_Object *obj)
1297 elm_widget_scroll_hold_pop(obj);
1301 * Push the scroll freeze by 1
1303 * This increments the scroll freeze count by one. If it is more than 0 it will
1304 * take effect on the parents of the indicated object.
1306 * @param obj The object
1307 * @ingroup Scrollhints
1310 elm_object_scroll_freeze_push(Evas_Object *obj)
1312 elm_widget_scroll_freeze_push(obj);
1316 * Lock the scrolling of the given widget (and thus all parents)
1318 * This locks the given object from scrolling in the X axis (and implicitly
1319 * also locks all parent scrollers too from doing the same).
1321 * @param obj The object
1322 * @param lock The lock state (1 == locked, 0 == unlocked)
1323 * @ingroup Scrollhints
1326 elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock)
1328 elm_widget_drag_lock_x_set(obj, lock);
1332 * Lock the scrolling of the given widget (and thus all parents)
1334 * This locks the given object from scrolling in the Y axis (and implicitly
1335 * also locks all parent scrollers too from doing the same).
1337 * @param obj The object
1338 * @param lock The lock state (1 == locked, 0 == unlocked)
1339 * @ingroup Scrollhints
1342 elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock)
1344 elm_widget_drag_lock_y_set(obj, lock);
1348 * Get the scrolling lock of the given widget
1350 * This gets the lock for X axis scrolling.
1352 * @param obj The object
1353 * @ingroup Scrollhints
1356 elm_object_scroll_lock_x_get(const Evas_Object *obj)
1358 return elm_widget_drag_lock_x_get(obj);
1362 * Get the scrolling lock of the given widget
1364 * This gets the lock for X axis scrolling.
1366 * @param obj The object
1367 * @ingroup Scrollhints
1370 elm_object_scroll_lock_y_get(const Evas_Object *obj)
1372 return elm_widget_drag_lock_y_get(obj);
1376 * Pop the scroll freeze by 1
1378 * This decrements the scroll freeze count by one. If it is more than 0 it will
1379 * take effect on the parents of the indicated object.
1381 * @param obj The object
1382 * @ingroup Scrollhints
1385 elm_object_scroll_freeze_pop(Evas_Object *obj)
1387 elm_widget_scroll_freeze_pop(obj);
1392 * Check if the given Evas Object is an Elementary widget.
1394 * @param obj the object to query.
1395 * @return @c EINA_TRUE if it is an elementary widget variant,
1396 * @c EINA_FALSE otherwise
1399 elm_object_widget_check(const Evas_Object *obj)
1401 return elm_widget_is(obj);
1405 * Get the first parent of the given object that is an Elementary widget.
1407 * @param obj the object to query.
1408 * @return the parent object that is an Elementary widget, or @c NULL
1409 * if no parent is, or no parents at all.
1412 elm_object_parent_widget_get(const Evas_Object *obj)
1414 return elm_widget_parent_widget_get(obj);
1418 * Get the string that represents this Elementary widget.
1420 * @note Elementary is weird and exposes itself as a single
1421 * Evas_Object_Smart_Class of type "elm_widget", so
1422 * evas_object_type_get() always return that, making debug and
1423 * language bindings hard. This function tries to mitigate this
1424 * problem, but the solution is to change Elementary to use
1425 * proper inheritance.
1427 * @param obj the object to query.
1428 * @return Elementary widget name, or @c NULL if not a valid widget.
1431 elm_object_widget_type_get(const Evas_Object *obj)
1433 return elm_widget_type_get(obj);