/usr/include/elementary-1/elm_config.h is in libelementary-dev 1.8.5-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 | /**
* @defgroup Config Elementary Config
* @ingroup Elementary
*
* Elementary configuration is formed by a set options bounded to a
* given @ref Profile profile, like @ref Theme theme, @ref Fingers
* "finger size", etc. These are functions with which one synchronizes
* changes made to those values to the configuration storing files, de
* facto. You most probably don't want to use the functions in this
* group unless you're writing an elementary configuration manager.
*
* @{
*/
/**
* Save back Elementary's configuration, so that it will persist on
* future sessions.
*
* @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
* @ingroup Config
*
* This function will take effect -- thus, do I/O -- immediately. Use
* it when you want to save all configuration changes at once. The
* current configuration set will get saved onto the current profile
* configuration file.
*
*/
EAPI Eina_Bool elm_config_save(void);
/**
* Reload Elementary's configuration, bounded to current selected
* profile.
*
* @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
* @ingroup Config
*
* Useful when you want to force reloading of configuration values for
* a profile. If one removes user custom configuration directories,
* for example, it will force a reload with system values instead.
*
*/
EAPI void elm_config_reload(void);
/**
* Flush all config settings then apply those settings to all applications
* using elementary on the current display.
*
* @ingroup Config
*/
EAPI void elm_config_all_flush(void);
/**
* @}
*/
/**
* @defgroup Profile Elementary Profile
* @ingroup Elementary
*
* Profiles are pre-set options that affect the whole look-and-feel of
* Elementary-based applications. There are, for example, profiles
* aimed at desktop computer applications and others aimed at mobile,
* touchscreen-based ones. You most probably don't want to use the
* functions in this group unless you're writing an elementary
* configuration manager.
*
* @{
*/
/**
* Get Elementary's profile in use.
*
* This gets the global profile that is applied to all Elementary
* applications.
*
* @return The profile's name
* @ingroup Profile
*/
EAPI const char *elm_config_profile_get(void);
/**
* Get an Elementary's profile directory path in the filesystem. One
* may want to fetch a system profile's dir or a user one (fetched
* inside $HOME).
*
* @param profile The profile's name
* @param is_user Whether to lookup for a user profile (@c EINA_TRUE)
* or a system one (@c EINA_FALSE)
* @return The profile's directory path.
* @ingroup Profile
*
* @note You must free it with elm_config_profile_dir_free().
*/
EAPI const char *elm_config_profile_dir_get(const char *profile, Eina_Bool is_user);
/**
* Free an Elementary's profile directory path, as returned by
* elm_config_profile_dir_get().
*
* @param p_dir The profile's path
* @ingroup Profile
*
*/
EAPI void elm_config_profile_dir_free(const char *p_dir);
/**
* Get Elementary's list of available profiles.
*
* @return The profiles list. List node data are the profile name
* strings.
* @ingroup Profile
*
* @note One must free this list, after usage, with the function
* elm_config_profile_list_free().
*/
EAPI Eina_List *elm_config_profile_list_get(void);
/**
* Free Elementary's list of available profiles.
*
* @param l The profiles list, as returned by elm_config_profile_list_get().
* @ingroup Profile
*
*/
EAPI void elm_config_profile_list_free(Eina_List *l);
/**
* Set Elementary's profile.
*
* This sets the global profile that is applied to Elementary
* applications. Just the process the call comes from will be
* affected.
*
* @param profile The profile's name
* @ingroup Profile
*
*/
EAPI void elm_config_profile_set(const char *profile);
/**
* @}
*/
/**
* @defgroup Scrolling Elementary Scrolling
* @ingroup Elementary
*
* These are functions setting how scrollable views in Elementary
* widgets should behave on user interaction.
*
* @{
*/
/**
* Get whether scrollers should bounce when they reach their
* viewport's edge during a scroll.
*
* @return the thumb scroll bouncing state
*
* This is the default behavior for touch screens, in general.
* @ingroup Scrolling
*/
EAPI Eina_Bool elm_config_scroll_bounce_enabled_get(void);
/**
* Set whether scrollers should bounce when they reach their
* viewport's edge during a scroll.
*
* @param enabled the thumb scroll bouncing state
*
* @see elm_config_scroll_bounce_enabled_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_bounce_enabled_set(Eina_Bool enabled);
/**
* Get the amount of inertia a scroller will impose at bounce
* animations.
*
* @return the thumb scroll bounce friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_bounce_friction_get(void);
/**
* Set the amount of inertia a scroller will impose at bounce
* animations.
*
* @param friction the thumb scroll bounce friction
*
* @see elm_config_scroll_bounce_friction_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_bounce_friction_set(double friction);
/**
* Get the amount of inertia a <b>paged</b> scroller will impose at
* page fitting animations.
*
* @return the page scroll friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_page_scroll_friction_get(void);
/**
* Set the amount of inertia a <b>paged</b> scroller will impose at
* page fitting animations.
*
* @param friction the page scroll friction
*
* @see elm_config_scroll_page_scroll_friction_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_page_scroll_friction_set(double friction);
/**
* Get the amount of inertia a scroller will impose at region bring
* animations.
*
* @return the bring in scroll friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_bring_in_scroll_friction_get(void);
/**
* Set the amount of inertia a scroller will impose at region bring
* animations.
*
* @param friction the bring in scroll friction
*
* @see elm_config_scroll_bring_in_scroll_friction_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_bring_in_scroll_friction_set(double friction);
/**
* Get the amount of inertia scrollers will impose at animations
* triggered by Elementary widgets' zooming API.
*
* @return the zoom friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_zoom_friction_get(void);
/**
* Set the amount of inertia scrollers will impose at animations
* triggered by Elementary widgets' zooming API.
*
* @param friction the zoom friction
*
* @see elm_config_scroll_zoom_friction_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_zoom_friction_set(double friction);
/**
* Get whether scrollers should be draggable from any point in their
* views.
*
* @return the thumb scroll state
*
* @note This is the default behavior for touch screens, in general.
* @note All other functions namespaced with "thumbscroll" will only
* have effect if this mode is enabled.
*
* @ingroup Scrolling
*/
EAPI Eina_Bool elm_config_scroll_thumbscroll_enabled_get(void);
/**
* Set whether scrollers should be draggable from any point in their
* views.
*
* @param enabled the thumb scroll state
*
* @see elm_config_scroll_thumbscroll_enabled_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
/**
* Get the number of pixels one should travel while dragging a
* scroller's view to actually trigger scrolling.
*
* @return the thumb scroll threshold
*
* One would use higher values for touch screens, in general, because
* of their inherent imprecision.
* @ingroup Scrolling
*/
EAPI unsigned int elm_config_scroll_thumbscroll_threshold_get(void);
/**
* Set the number of pixels one should travel while dragging a
* scroller's view to actually trigger scrolling.
*
* @param threshold the thumb scroll threshold
*
* @see elm_config_thumbscroll_threshold_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_threshold_set(unsigned int threshold);
/**
* Get the number of pixels the range which can be scrolled,
* while the scroller is holded.
*
* @return the thumb scroll hold threshold
*
* @ingroup Scrolling
*/
EAPI unsigned int elm_config_scroll_thumbscroll_hold_threshold_get(void);
/**
* Set the number of pixels the range which can be scrolled,
* while the scroller is holded.
*
* @param threshold the thumb scroll hold threshold
*
* @see elm_config_thumbscroll_hold_threshold_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_hold_threshold_set(unsigned int threshold);
/**
* Get the minimum speed of mouse cursor movement which will trigger
* list self scrolling animation after a mouse up event
* (pixels/second).
*
* @return the thumb scroll momentum threshold
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_momentum_threshold_get(void);
/**
* Set the minimum speed of mouse cursor movement which will trigger
* list self scrolling animation after a mouse up event
* (pixels/second).
*
* @param threshold the thumb scroll momentum threshold
*
* @see elm_config_thumbscroll_momentum_threshold_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_momentum_threshold_set(double threshold);
/**
* Get the number of pixels the maximum distance which can be flicked.
* If it is flicked more than this,
* the flick distance is same with maximum distance.
*
* @return the thumb scroll maximum flick distance
*
* @ingroup Scrolling
*/
EAPI unsigned int elm_config_scroll_thumbscroll_flick_distance_tolerance_get(void);
/**
* Set the number of pixels the maximum distance which can be flicked.
* If it is flicked more than this,
* the flick distance is same with maximum distance.
*
* @param distance the thumb scroll maximum flick distance
*
* @see elm_config_thumbscroll_flick_distance_tolerance_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_flick_distance_tolerance_set(unsigned int distance);
/**
* Get the amount of inertia a scroller will impose at self scrolling
* animations.
*
* @return the thumb scroll friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_friction_get(void);
/**
* Set the amount of inertia a scroller will impose at self scrolling
* animations.
*
* @param friction the thumb scroll friction
*
* @see elm_config_thumbscroll_friction_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_friction_set(double friction);
/**
* Get the min amount of inertia a scroller will impose at self scrolling
* animations.
*
* @return the thumb scroll min friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_min_friction_get(void);
/**
* Set the min amount of inertia a scroller will impose at self scrolling
* animations.
*
* @param friction the thumb scroll min friction
*
* @see elm_config_thumbscroll_min_friction_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_min_friction_set(double friction);
/**
* Get the standard velocity of the scroller. The scroll animation time is
* same with thumbscroll friction, if the velocity is same with standard
* velocity.
*
* @return the thumb scroll friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_friction_standard_get(void);
/**
* Set the standard velocity of the scroller. The scroll animation time is
* same with thumbscroll friction, if the velocity is same with standard
* velocity.
*
* @param friction the thumb scroll friction standard
*
* @see elm_config_thumbscroll_friction_standard_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_friction_standard_set(double standard);
/**
* Get the amount of lag between your actual mouse cursor dragging
* movement and a scroller's view movement itself, while pushing it
* into bounce state manually.
*
* @return the thumb scroll border friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_border_friction_get(void);
/**
* Set the amount of lag between your actual mouse cursor dragging
* movement and a scroller's view movement itself, while pushing it
* into bounce state manually.
*
* @param friction the thumb scroll border friction. @c 0.0 for
* perfect synchrony between two movements, @c 1.0 for maximum
* lag.
*
* @see elm_config_thumbscroll_border_friction_get()
* @note parameter value will get bound to 0.0 - 1.0 interval, always
*
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_border_friction_set(double friction);
/**
* Get the sensitivity amount which is be multiplied by the length of
* mouse dragging.
*
* @return the thumb scroll sensitivity friction
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_sensitivity_friction_get(void);
/**
* Set the sensitivity amount which is be multiplied by the length of
* mouse dragging.
*
* @param friction the thumb scroll sensitivity friction. @c 0.1 for
* minimum sensitivity, @c 1.0 for maximum sensitivity. 0.25
* is proper.
*
* @see elm_config_thumbscroll_sensitivity_friction_get()
* @note parameter value will get bound to 0.1 - 1.0 interval, always
*
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_sensitivity_friction_set(double friction);
/**
* Get the minimum speed of mouse cursor movement which will accelerate
* scrolling velocity after a mouse up event
* (pixels/second).
*
* @return the thumb scroll acceleration threshold
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_acceleration_threshold_get(void);
/**
* Set the minimum speed of mouse cursor movement which will accelerate
* scrolling velocity after a mouse up event
* (pixels/second).
*
* @param threshold the thumb scroll acceleration threshold
*
* @see elm_config_thumbscroll_acceleration_threshold_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_acceleration_threshold_set(double threshold);
/**
* Get the time limit for accelerating velocity.
*
* @return the thumb scroll acceleration time limit
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_acceleration_time_limit_get(void);
/**
* Set the time limit for accelerating velocity.
*
* @param threshold the thumb scroll acceleration time limit
*
* @see elm_config_thumbscroll_acceleration_time_limit_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_acceleration_time_limit_set(double time_limit);
/**
* Get the weight for the acceleration.
*
* @return the thumb scroll acceleration weight
*
* @ingroup Scrolling
*/
EAPI double elm_config_scroll_thumbscroll_acceleration_weight_get(void);
/**
* Set the weight for the acceleration.
*
* @param threshold the thumb scroll acceleration weight
*
* @see elm_config_thumbscroll_acceleration_weight_get()
* @ingroup Scrolling
*/
EAPI void elm_config_scroll_thumbscroll_acceleration_weight_set(double weight);
/**
* @}
*/
/**
* Get the duration for occurring long press event.
*
* @return Timeout for long press event
* @ingroup Longpress
*/
EAPI double elm_config_longpress_timeout_get(void);
/**
* Set the duration for occurring long press event.
*
* @param lonpress_timeout Timeout for long press event
* @ingroup Longpress
*/
EAPI void elm_config_longpress_timeout_set(double longpress_timeout);
typedef enum _Elm_Softcursor_Mode
{
ELM_SOFTCURSOR_MODE_AUTO, /**< Auto-detect if a software cursor should be used (default) */
ELM_SOFTCURSOR_MODE_ON, /**< Always use a softcursor */
ELM_SOFTCURSOR_MODE_OFF /**< Never use a softcursor */
} Elm_Softcursor_Mode; /**< @since 1.7 */
/**
* Set the mode used for software provided mouse cursors inline in the window
* canvas.
*
* A software rendered cursor can be provided for rendering inline inside the
* canvas windows in the event the native display system does not provide one
* or the native one is not wanted.
*
* @param lonpress_timeout Timeout for long press event
* @ingroup Softcursor
*
* @see elm_config_softcursor_mode_get()
* @since 1.7
*/
EAPI void elm_config_softcursor_mode_set(Elm_Softcursor_Mode mode);
/**
* Get the software cursor mode
*
* @return The mode used for software cursors
* @ingroup Softcursor
*
* @see elm_config_softcursor_mode_set()
* @since 1.7
*/
EAPI Elm_Softcursor_Mode elm_config_softcursor_mode_get(void);
/**
* Get the duration after which tooltip will be shown.
*
* @return Duration after which tooltip will be shown.
*/
EAPI double elm_config_tooltip_delay_get(void);
/**
* Set the duration after which tooltip will be shown.
*
* @return EINA_TRUE if value is set.
*/
EAPI void elm_config_tooltip_delay_set(double delay);
/**
* Get the configured cursor engine only usage
*
* This gets the globally configured exclusive usage of engine cursors.
*
* @return 1 if only engine cursors should be used
* @ingroup Cursors
*/
EAPI Eina_Bool elm_config_cursor_engine_only_get(void);
/**
* Set the configured cursor engine only usage
*
* This sets the globally configured exclusive usage of engine cursors.
* It won't affect cursors set before changing this value.
*
* @param engine_only If 1 only engine cursors will be enabled, if 0 will
* look for them on theme before.
* @ingroup Cursors
*/
EAPI void elm_config_cursor_engine_only_set(Eina_Bool engine_only);
/**
* Get the global scaling factor
*
* This gets the globally configured scaling factor that is applied to all
* objects.
*
* @return The scaling factor
* @ingroup Scaling
*/
EAPI double elm_config_scale_get(void);
/**
* Set the global scaling factor
*
* This sets the globally configured scaling factor that is applied to all
* objects.
*
* @param scale The scaling factor to set
* @ingroup Scaling
*/
EAPI void elm_config_scale_set(double scale);
/**
* @defgroup Password_last_show Password show last
* @ingroup Elementary
*
* Show last feature of password mode enables user to view
* the last input entered for few seconds before masking it.
* These functions allow to set this feature in password mode
* of entry widget and also allow to manipulate the duration
* for which the input has to be visible.
*
* @{
*/
/**
* Get the "show last" setting of password mode.
*
* This gets the "show last" setting of password mode which might be
* enabled or disabled.
*
* @return @c EINA_TRUE, if the "show last" setting is enabled,
* @c EINA_FALSE if it's disabled.
*
* @ingroup Password_last_show
*/
EAPI Eina_Bool elm_config_password_show_last_get(void);
/**
* Set show last setting in password mode.
*
* This enables or disables show last setting of password mode.
*
* @param password_show_last If EINA_TRUE enables "show last" in password mode.
* @see elm_config_password_show_last_timeout_set()
* @ingroup Password_last_show
*/
EAPI void elm_config_password_show_last_set(Eina_Bool password_show_last);
/**
* Get the timeout value in "show last" password mode.
*
* This gets the time out value for which the last input entered in password
* mode will be visible.
*
* @return The timeout value of "show last" password mode.
* @ingroup Password_last_show
*/
EAPI double elm_config_password_show_last_timeout_get(void);
/**
* Set's the timeout value in "show last" password mode.
*
* This sets the time out value for which the last input entered in password
* mode will be visible.
*
* @param password_show_last_timeout The timeout value.
* @see elm_config_password_show_last_set()
* @ingroup Password_last_show
*/
EAPI void elm_config_password_show_last_timeout_set(double password_show_last_timeout);
/**
* @}
*/
/**
* @defgroup Engine Elementary Engine
* @ingroup Elementary
*
* These are functions setting and querying which rendering engine
* Elementary will use for drawing its windows' pixels.
*
* The following are the available engines:
* @li "software_x11"
* @li "fb"
* @li "directfb"
* @li "software_16_x11"
* @li "software_8_x11"
* @li "xrender_x11"
* @li "opengl_x11"
* @li "software_gdi"
* @li "software_16_wince_gdi"
* @li "sdl"
* @li "software_16_sdl"
* @li "opengl_sdl"
* @li "buffer"
* @li "ews"
* @li "opengl_cocoa"
* @li "psl1ght"
*
* @{
*/
/**
* @brief Get Elementary's rendering engine in use.
*
* @return The rendering engine's name
* @note there's no need to free the returned string, here.
*
* This gets the global rendering engine that is applied to all Elementary
* applications.
*
* @see elm_config_engine_set()
*/
EAPI const char *elm_config_engine_get(void);
/**
* @brief Set Elementary's rendering engine for use.
*
* @param engine The rendering engine's name
*
* Note that it will take effect only to Elementary windows created after
* this is called.
*
* @see elm_win_add()
*/
EAPI void elm_config_engine_set(const char *engine);
/**
* @brief Get Elementary's preferred engine to use.
*
* @return The rendering engine's name
* @note there's no need to free the returned string, here.
*
* This gets the global rendering engine that is applied to all Elementary
* applications and is PREFERRED by the application. This can (and will)
* override the engine configured for all applications which.
*
* @see elm_config_preferred_engine_set()
*/
EAPI const char *elm_config_preferred_engine_get(void);
/**
* @brief Set Elementary's preferred rendering engine for use.
*
* @param engine The rendering engine's name
*
* Note that it will take effect only to Elementary windows created after
* this is called. This overrides the engine set by configuration at
* application startup. Note that it is a hint and may not be honored.
*
* @see elm_win_add()
*/
EAPI void elm_config_preferred_engine_set(const char *engine);
typedef struct _Elm_Text_Class
{
const char *name;
const char *desc;
} Elm_Text_Class;
typedef struct _Elm_Font_Overlay
{
const char *text_class;
const char *font;
Evas_Font_Size size;
} Elm_Font_Overlay;
/**
* Get Elementary's list of supported text classes.
*
* @return The text classes list, with @c Elm_Text_Class blobs as data.
* @ingroup Fonts
*
* Release the list with elm_text_classes_list_free().
*/
EAPI Eina_List *elm_config_text_classes_list_get(void);
/**
* Free Elementary's list of supported text classes.
*
* @ingroup Fonts
*
* @see elm_config_text_classes_list_get().
*/
EAPI void elm_config_text_classes_list_free(Eina_List *list);
/**
* Get Elementary's list of font overlays, set with
* elm_config_font_overlay_set().
*
* @return The font overlays list, with @c Elm_Font_Overlay blobs as
* data.
*
* @ingroup Fonts
*
* For each text class, one can set a <b>font overlay</b> for it,
* overriding the default font properties for that class coming from
* the theme in use. There is no need to free this list.
*
* @see elm_config_font_overlay_set() and elm_config_font_overlay_unset().
*/
EAPI const Eina_List *elm_config_font_overlay_list_get(void);
/**
* Set a font overlay for a given Elementary text class.
*
* @param text_class Text class name
* @param font Font name and style string
* @param size Font size.
*
* @note If the @p size is lower than zero, the value will be the amount of the size percentage. ex) -50: half of the current size, -100: current size, -10: 1/10 size.
*
* @ingroup Fonts
*
* @p font has to be in the format returned by elm_font_fontconfig_name_get().
* @see elm_config_font_overlay_list_get()
* @see elm_config_font_overlay_unset()
* @see edje_object_text_class_set()
*/
EAPI void elm_config_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
/**
* Get access mode
*
* @return the access mode bouncing state
*
* @since 1.7
*
* @ingroup Access
*
* @see elm_config_access_set()
*/
EAPI Eina_Bool elm_config_access_get(void);
/**
* Set access mode
*
* @param is_accesss If EINA_TRUE enables access mode
*
* @note Elementary objects may have information (e.g. label on the elm_button)
* to be read. This information is read by access module when an object
* receives EVAS_CALLBACK_MOUSE_IN event
*
* @since 1.7
*
* @ingroup Access
*
* @see elm_config_access_get()
*/
EAPI void elm_config_access_set(Eina_Bool is_access);
/**
* Get whether selection should be cleared when entry widget is unfocused.
*
* @return if the selection would be cleared on unfocus.
*
* @since 1.7
*
* @ingroup Selection
*
* @see elm_config_selection_unfocused_clear_set()
*/
EAPI Eina_Bool elm_config_selection_unfocused_clear_get(void);
/**
* Set whether selection should be cleared when entry widget is unfocused.
*
* @param enabled If EINA_TRUE clear selection when unfocus,
* otherwise does not clear selection when unfocus.
*
* @since 1.7
*
* @ingroup Selection
*
* @see elm_config_selection_unfocused_clear_get()
*/
EAPI void elm_config_selection_unfocused_clear_set(Eina_Bool enabled);
/**
* Unset a font overlay for a given Elementary text class.
*
* @param text_class Text class name
*
* @ingroup Fonts
*
* This will bring back text elements belonging to text class
* @p text_class back to their default font settings.
*/
EAPI void elm_config_font_overlay_unset(const char *text_class);
/**
* Apply the changes made with elm_config_font_overlay_set() and
* elm_config_font_overlay_unset() on the current Elementary window.
*
* @ingroup Fonts
*
* This applies all font overlays set to all objects in the UI.
*/
EAPI void elm_config_font_overlay_apply(void);
/**
* Get the configured "finger size"
*
* @return The finger size
*
* This gets the globally configured finger size, <b>in pixels</b>
*
* @ingroup Fingers
*/
EAPI Evas_Coord elm_config_finger_size_get(void);
/**
* Set the configured finger size
*
* This sets the globally configured finger size in pixels
*
* @param size The finger size
* @ingroup Fingers
*/
EAPI void elm_config_finger_size_set(Evas_Coord size);
/**
* Get the configured cache flush interval time
*
* This gets the globally configured cache flush interval time, in
* ticks
*
* @return The cache flush interval time
* @ingroup Caches
*
* @see elm_cache_all_flush()
*/
EAPI int elm_config_cache_flush_interval_get(void);
/**
* Set the configured cache flush interval time
*
* This sets the globally configured cache flush interval time, in ticks
*
* @param size The cache flush interval time
*
* @note The @p size must be greater than 0. if not, the cache flush will be
* ignored.
*
* @ingroup Caches
*
* @see elm_cache_all_flush()
*/
EAPI void elm_config_cache_flush_interval_set(int size);
/**
* Get the configured cache flush enabled state
*
* This gets the globally configured cache flush state - if it is enabled
* or not. When cache flushing is enabled, elementary will regularly
* (see elm_config_cache_flush_interval_get() ) flush caches and dump data out of
* memory and allow usage to re-seed caches and data in memory where it
* can do so. An idle application will thus minimize its memory usage as
* data will be freed from memory and not be re-loaded as it is idle and
* not rendering or doing anything graphically right now.
*
* @return The cache flush state
* @ingroup Caches
*
* @see elm_cache_all_flush()
*/
EAPI Eina_Bool elm_config_cache_flush_enabled_get(void);
/**
* Set the configured cache flush enabled state
*
* This sets the globally configured cache flush enabled state.
*
* @param enabled The cache flush enabled state
* @ingroup Caches
*
* @see elm_cache_all_flush()
*/
EAPI void elm_config_cache_flush_enabled_set(Eina_Bool enabled);
/**
* Get the configured font cache size
*
* This gets the globally configured font cache size, in kilo bytes.
*
* @return The font cache size
* @ingroup Caches
*/
EAPI int elm_config_cache_font_cache_size_get(void);
/**
* Set the configured font cache size
*
* This sets the globally configured font cache size, in kilo bytes
*
* @param size The font cache size
* @ingroup Caches
*/
EAPI void elm_config_cache_font_cache_size_set(int size);
/**
* Get the configured image cache size
*
* This gets the globally configured image cache size, in kilo bytes
*
* @return The image cache size
* @ingroup Caches
*/
EAPI int elm_config_cache_image_cache_size_get(void);
/**
* Set the configured image cache size
*
* This sets the globally configured image cache size, in kilo bytes
*
* @param size The image cache size
* @ingroup Caches
*/
EAPI void elm_config_cache_image_cache_size_set(int size);
/**
* Get the configured edje file cache size.
*
* This gets the globally configured edje file cache size, in number
* of files.
*
* @return The edje file cache size
* @ingroup Caches
*/
EAPI int elm_config_cache_edje_file_cache_size_get(void);
/**
* Set the configured edje file cache size
*
* This sets the globally configured edje file cache size, in number
* of files.
*
* @param size The edje file cache size
* @ingroup Caches
*/
EAPI void elm_config_cache_edje_file_cache_size_set(int size);
/**
* Get the configured edje collections (groups) cache size.
*
* This gets the globally configured edje collections cache size, in
* number of collections.
*
* @return The edje collections cache size
* @ingroup Caches
*/
EAPI int elm_config_cache_edje_collection_cache_size_get(void);
/**
* Set the configured edje collections (groups) cache size
*
* This sets the globally configured edje collections cache size, in
* number of collections.
*
* @param size The edje collections cache size
* @ingroup Caches
*/
EAPI void elm_config_cache_edje_collection_cache_size_set(int size);
/**
* Get the enable status of the focus highlight
*
* This gets whether the highlight on focused objects is enabled or not
*
* @see elm_config_focus_highlight_enabled_set()
* @ingroup Focus
*/
EAPI Eina_Bool elm_config_focus_highlight_enabled_get(void);
/**
* Set the enable status of the focus highlight
*
* @param enable Enable highlight if EINA_TRUE, disable otherwise
*
* Set whether to show or not the highlight on focused objects
*
* Note that it will take effect only to Elementary windows created after
* this is called.
*
* @see elm_win_add()
*
* @ingroup Focus
*/
EAPI void elm_config_focus_highlight_enabled_set(Eina_Bool enable);
/**
* Get the enable status of the highlight animation
*
* @return The focus highlight mode set
*
* Get whether the focus highlight, if enabled, will animate its switch from
* one object to the next
*
* @ingroup Focus
*/
EAPI Eina_Bool elm_config_focus_highlight_animate_get(void);
/**
* Set the enable status of the highlight animation
*
* @param animate Enable animation if EINA_TRUE, disable otherwise
*
* Set whether the focus highlight, if enabled, will animate its switch from
* one object to the next
*
* Note that it will take effect only to Elementary windows created after
* this is called.
*
* @see elm_win_add()
*
* @ingroup Focus
*/
EAPI void elm_config_focus_highlight_animate_set(Eina_Bool animate);
/**
* Get the system mirrored mode. This determines the default mirrored mode
* of widgets.
*
* @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_config_mirrored_get(void);
/**
* Set the system mirrored mode. This determines the default mirrored mode
* of widgets.
*
* @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
*/
EAPI void elm_config_mirrored_set(Eina_Bool mirrored);
/**
* Get the clouseau state. EINA_TRUE if clouseau was tried to be run.
*
* @since 1.8
* @return EINA_TRUE if clouseau was tried to run, EINA_FALSE otherwise
*/
EAPI Eina_Bool elm_config_clouseau_enabled_get(void);
/**
* Get the clouseau state. EINA_TRUE if clouseau should be attempted to be run.
*
* @since 1.8
* @param enabled EINA_TRUE to try and run clouseau, EINA_FALSE otherwise.
*/
EAPI void elm_config_clouseau_enabled_set(Eina_Bool enabled);
/**
* Get the indicator service name according to the rotation degree.
*
* @param rotation The rotation which related with the indicator service name, in degrees (0-360),
*
* @return The indicator service name according to the rotation degree.
*/
EAPI const char *elm_config_indicator_service_get(int rotation);
/**
* Get the duration for occurring long tap event of gesture layer.
*
* @return Timeout for long tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
*/
EAPI double elm_config_glayer_long_tap_start_timeout_get(void);
/**
* Set the duration for occurring long tap event of gesture layer.
*
* @param long_tap_timeout Timeout for long tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
*/
EAPI void elm_config_glayer_long_tap_start_timeout_set(double long_tap_timeout);
/**
* Get the duration for occurring double tap event of gesture layer.
*
* @return Timeout for double tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
*/
EAPI double elm_config_glayer_double_tap_timeout_get(void);
/**
* Set the duration for occurring double tap event of gesture layer.
*
* @param long_tap_timeout Timeout for double tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
*/
EAPI void elm_config_glayer_double_tap_timeout_set(double double_tap_timeout);
/**
* @}
*/
|