Automatic generation produced by ISE Eiffel
note description: "Shortcut preference." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2019-08-02 00:08:17 -0800 (Fri, 02 Aug 2019) $" revision: "$Revision: 103380 $" class interface SHORTCUT_PREFERENCE create {PREFERENCE_FACTORY} make (a_manager: PREFERENCE_MANAGER; a_name: STRING_8; a_value: TUPLE [alt: BOOLEAN; ctrl: BOOLEAN; shift: BOOLEAN; key_string: STRING_32]) -- New preference with a_name and a_value. -- (from TYPED_PREFERENCE) require -- from TYPED_PREFERENCE manager_not_void: a_manager /= Void name_not_void: a_name /= Void name_not_empty: not a_name.is_empty value_not_void: a_value /= Void ensure -- from TYPED_PREFERENCE has_manager: manager /= Void has_name: name /= Void and not name.is_empty has_change_action: change_actions /= Void make_from_string_value (a_manager: PREFERENCE_MANAGER; a_name: STRING_8; a_value: READABLE_STRING_GENERAL) -- Create preference and set value based on string value a_value. -- (from TYPED_PREFERENCE) require -- from TYPED_PREFERENCE manager_not_void: a_manager /= Void name_not_void: a_name /= Void name_not_empty: not a_name.is_empty value_not_void: a_value /= Void value_valid: is_string_value_validated (a_value) ensure -- from TYPED_PREFERENCE has_manager: manager /= Void has_name: name /= Void and not name.is_empty has_change_action: change_actions /= Void feature -- Access Alt_text: STRING_8 = "Alt" -- (from PREFERENCE_CONSTANTS) auto_preference: detachable SHORTCUT_PREFERENCE -- Preference to use for auto color. -- (from PREFERENCE) auto_value: STRING_32 -- (from PREFERENCE_CONSTANTS) Ctrl_text: STRING_8 = "Ctrl" -- (from PREFERENCE_CONSTANTS) default_value: detachable STRING_32 -- Value to be used for default. -- (from PREFERENCE) description: detachable STRING_32 -- Description of what the preference is all about. -- (from PREFERENCE) display_string: STRING_32 -- String representation of key combination. -- (from MANAGED_SHORTCUT) ensure -- from MANAGED_SHORTCUT result_not_void: Result /= Void f_switch_to_flat_view: STRING_32 -- (from PREFERENCE_CONSTANTS) f_switch_to_tree_view: STRING_32 -- (from PREFERENCE_CONSTANTS) generating_preference_type: STRING_8 -- The generating type of the preference for graphical representation. ensure -- from PREFERENCE generating_preference_type_not_void: Result /= Void generating_type: TYPE [detachable SHORTCUT_PREFERENCE] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty group: detachable MANAGED_SHORTCUT_GROUP -- Group of the shortcut. -- (from MANAGED_SHORTCUT) has_value: BOOLEAN -- Does Current have a value to use? -- (from TYPED_PREFERENCE) require -- from PREFERENCE True ensure then -- from TYPED_PREFERENCE result_implies_value_attached: Result implies value /= Void key_code_from_key_string (key_string: READABLE_STRING_GENERAL): INTEGER_32 -- Key code value from key_string -- (from EV_KEY_CONSTANTS) require -- from EV_KEY_CONSTANTS key_string_not_void: key_string /= Void Key_strings: ARRAY [STRING_32] -- String representations of all key codes. -- (from EV_KEY_CONSTANTS) l_building_flat_view: STRING_32 -- (from PREFERENCE_CONSTANTS) l_building_tree_view: STRING_32 -- (from PREFERENCE_CONSTANTS) l_close: STRING_32 -- (from PREFERENCE_CONSTANTS) l_count_preferences (a_count: READABLE_STRING_GENERAL): STRING_32 -- (from PREFERENCE_CONSTANTS) require -- from PREFERENCE_CONSTANTS a_count_not_void: a_count /= Void l_description: STRING_32 -- (from PREFERENCE_CONSTANTS) l_display_window: STRING_32 -- (from PREFERENCE_CONSTANTS) l_filter: STRING_32 -- (from PREFERENCE_CONSTANTS) l_flat_view: STRING_32 -- (from PREFERENCE_CONSTANTS) l_literal_value: STRING_32 -- (from PREFERENCE_CONSTANTS) l_matches_of_total_preferences (a_count, a_total_count: READABLE_STRING_GENERAL): STRING_32 -- (from PREFERENCE_CONSTANTS) require -- from PREFERENCE_CONSTANTS a_count_not_void: a_count /= Void a_total_count_not_void: a_total_count /= Void l_name: STRING_32 -- (from PREFERENCE_CONSTANTS) l_no_default_value: STRING_32 -- (from PREFERENCE_CONSTANTS) l_request_restart: STRING_32 -- (from PREFERENCE_CONSTANTS) l_restore_default: STRING_32 -- (from PREFERENCE_CONSTANTS) l_restore_defaults: STRING_32 -- (from PREFERENCE_CONSTANTS) l_status: STRING_32 -- (from PREFERENCE_CONSTANTS) l_tree_or_flat_view: STRING_32 -- (from PREFERENCE_CONSTANTS) l_tree_view: STRING_32 -- (from PREFERENCE_CONSTANTS) l_type: STRING_32 -- (from PREFERENCE_CONSTANTS) l_updating_the_view: STRING_32 -- (from PREFERENCE_CONSTANTS) manager: PREFERENCE_MANAGER -- Manager to which Current belongs. -- (from PREFERENCE) modification_deny_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions called when modificaton is denied. -- (from MANAGED_SHORTCUT) ensure -- from MANAGED_SHORTCUT result_not_void: Result /= Void name: STRING_8 -- Name of the preference as it appears in the preference file. -- (from PREFERENCE) no_description_text: STRING_32 -- (from PREFERENCE_CONSTANTS) overridden_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions called when Current is overriden within `group`. -- (from MANAGED_SHORTCUT) ensure -- from MANAGED_SHORTCUT result_not_void: Result /= Void p_default_value: STRING_32 -- (from PREFERENCE_CONSTANTS) Pixmaps_extension_cell: CELL [STRING_8] -- Extension for pixmaps. -- (from PREFERENCE_CONSTANTS) Pixmaps_path_cell: CELL [PATH] -- Path where pixmaps for the preference window should be looked for. -- By default it looks in pixmaps in the current directory, but -- it is possible to change the contents of this cell to change this path. -- (from PREFERENCE_CONSTANTS) Preference_window_icon: STRING_8 = "icon_preference_window" -- Base name of the file that contains the icon of the preferences window. -- (from PREFERENCE_CONSTANTS) preferences_root: STRING_32 -- (from PREFERENCE_CONSTANTS) preferences_title: STRING_32 -- (from PREFERENCE_CONSTANTS) restore_preference_string: STRING_32 -- (from PREFERENCE_CONSTANTS) Shift_text: STRING_8 = "Shift" -- (from PREFERENCE_CONSTANTS) Shortcut_delimiter: STRING_32 = "+" -- (from PREFERENCE_CONSTANTS) shortcut_modification_denied: STRING_32 -- (from PREFERENCE_CONSTANTS) typed_change_actions: ACTION_SEQUENCE [TUPLE [TUPLE [alt: BOOLEAN; ctrl: BOOLEAN; shift: BOOLEAN; key_string: STRING_32]]] -- Actions to be performed when `value` changes after actions of `change_actions`. -- (from TYPED_PREFERENCE) ensure -- from TYPED_PREFERENCE result_attached: Result /= Void user_value: STRING_32 -- (from PREFERENCE_CONSTANTS) value: TUPLE [alt: BOOLEAN; ctrl: BOOLEAN; shift: BOOLEAN; key_string: STRING_32] -- Actual value. -- (from TYPED_PREFERENCE) W_preferences_delayed_resources: STRING_32 -- Texts used in the dialog that tells the user -- they have to restart the application to use the new preferences. -- (from PREFERENCE_CONSTANTS) feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: SHORTCUT_PREFERENCE): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: SHORTCUT_PREFERENCE): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: SHORTCUT_PREFERENCE): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void has_default_value: BOOLEAN -- Does this preference have a default value to use? -- (from PREFERENCE) has_validation_agent: BOOLEAN -- (from PREFERENCE) is_auto: BOOLEAN -- Is Current using auto value? -- (from PREFERENCE) is_fixed: BOOLEAN -- Can this shortcut be overriden when inserting a same one in `group`? -- (from MANAGED_SHORTCUT) is_hidden: BOOLEAN -- Should Current be hidden from user view? -- (from PREFERENCE) is_string_value_validated (a_string: READABLE_STRING_GENERAL): BOOLEAN -- Is a_string valid for this preference type to convert into a value? -- (from PREFERENCE) require -- from PREFERENCE string_not_void: a_string /= Void is_valid_string_for_selection (s: READABLE_STRING_32): BOOLEAN -- Can the string s be used to select a value? -- Same as `is_string_value_validated` for a single-valued preference. -- Checks against a list of known values for a multi-valued (choice) preference. -- (from TYPED_PREFERENCE) is_wiped: BOOLEAN -- If true, shortcut management doesn't take current into account when comparing. -- (from MANAGED_SHORTCUT) matches (a_key: like key; alt, ctrl, shift: BOOLEAN): BOOLEAN -- Do combinations of a_key, alt, ctrl an shift match Current? -- (from MANAGED_SHORTCUT) require -- from MANAGED_SHORTCUT a_key_not_void: a_key /= Void matches_shortcut (a_shortcut: SHORTCUT_PREFERENCE): BOOLEAN -- Do a_shortcut matches current? -- (from MANAGED_SHORTCUT) modifiable_with (a_key: detachable like key; alt, ctrl, shift: BOOLEAN): BOOLEAN -- Is current modifiable considering shortcuts in `group`? -- (from MANAGED_SHORTCUT) restart_required: BOOLEAN -- Is a restart required to apply the preference when changed? (Default: False) -- (from PREFERENCE) same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Duplication copy (other: SHORTCUT_PREFERENCE) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: SHORTCUT_PREFERENCE) -- Effect equivalent to that of: -- `copy` (other . `deep_twin`) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: SHORTCUT_PREFERENCE -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: SHORTCUT_PREFERENCE) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: SHORTCUT_PREFERENCE -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: SHORTCUT_PREFERENCE -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable SHORTCUT_PREFERENCE -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.`default` for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Access key: EV_KEY -- Actual Key ensure -- from MANAGED_SHORTCUT a_key_not_void: Result /= Void Shortcut_keys: ARRAY [INTEGER_32] -- All key codes that are acceptable for use in shortcut preferences. String_type: STRING_8 -- String description of this preference type. ensure -- from PREFERENCE string_type_not_void: Result /= Void no_underscore: not Result.has ('_') feature -- Actions change_actions: ACTION_SEQUENCE -- Actions to be performed when `value` changes, after call to `set_value`. -- (from PREFERENCE) ensure -- from PREFERENCE result_attached: Result /= Void feature -- Change set_validation_agent (agt: like validation_agent) -- Set `validation_agent` to agt. -- (from PREFERENCE) feature -- Constants Key_0: INTEGER_32 = 1 -- (from EV_KEY_CONSTANTS) Key_1: INTEGER_32 = 2 -- (from EV_KEY_CONSTANTS) Key_2: INTEGER_32 = 3 -- (from EV_KEY_CONSTANTS) Key_3: INTEGER_32 = 4 -- (from EV_KEY_CONSTANTS) Key_4: INTEGER_32 = 5 -- (from EV_KEY_CONSTANTS) Key_5: INTEGER_32 = 6 -- (from EV_KEY_CONSTANTS) Key_6: INTEGER_32 = 7 -- (from EV_KEY_CONSTANTS) Key_7: INTEGER_32 = 8 -- (from EV_KEY_CONSTANTS) Key_8: INTEGER_32 = 9 -- (from EV_KEY_CONSTANTS) Key_9: INTEGER_32 = 10 -- (from EV_KEY_CONSTANTS) Key_a: INTEGER_32 = 68 -- (from EV_KEY_CONSTANTS) Key_alt: INTEGER_32 = 96 -- (from EV_KEY_CONSTANTS) Key_b: INTEGER_32 = 69 -- (from EV_KEY_CONSTANTS) Key_back_space: INTEGER_32 = 40 -- (from EV_KEY_CONSTANTS) Key_backquote: INTEGER_32 = 56 -- (from EV_KEY_CONSTANTS) Key_backslash: INTEGER_32 = 54 -- (from EV_KEY_CONSTANTS) Key_c: INTEGER_32 = 70 -- (from EV_KEY_CONSTANTS) Key_caps_lock: INTEGER_32 = 45 -- (from EV_KEY_CONSTANTS) Key_close_bracket: INTEGER_32 = 52 -- (from EV_KEY_CONSTANTS) Key_comma: INTEGER_32 = 47 -- (from EV_KEY_CONSTANTS) Key_ctrl: INTEGER_32 = 95 -- (from EV_KEY_CONSTANTS) Key_d: INTEGER_32 = 71 -- (from EV_KEY_CONSTANTS) Key_dash: INTEGER_32 = 57 -- (from EV_KEY_CONSTANTS) Key_delete: INTEGER_32 = 67 -- (from EV_KEY_CONSTANTS) Key_down: INTEGER_32 = 59 -- (from EV_KEY_CONSTANTS) Key_e: INTEGER_32 = 72 -- (from EV_KEY_CONSTANTS) Key_end: INTEGER_32 = 65 -- (from EV_KEY_CONSTANTS) Key_enter: INTEGER_32 = 41 -- (from EV_KEY_CONSTANTS) Key_equal: INTEGER_32 = 48 -- (from EV_KEY_CONSTANTS) Key_escape: INTEGER_32 = 42 -- (from EV_KEY_CONSTANTS) Key_f: INTEGER_32 = 73 -- (from EV_KEY_CONSTANTS) Key_f1: INTEGER_32 = 27 -- (from EV_KEY_CONSTANTS) Key_f10: INTEGER_32 = 36 -- (from EV_KEY_CONSTANTS) Key_f11: INTEGER_32 = 37 -- (from EV_KEY_CONSTANTS) Key_f12: INTEGER_32 = 38 -- (from EV_KEY_CONSTANTS) Key_f2: INTEGER_32 = 28 -- (from EV_KEY_CONSTANTS) Key_f3: INTEGER_32 = 29 -- (from EV_KEY_CONSTANTS) Key_f4: INTEGER_32 = 30 -- (from EV_KEY_CONSTANTS) Key_f5: INTEGER_32 = 31 -- (from EV_KEY_CONSTANTS) Key_f6: INTEGER_32 = 32 -- (from EV_KEY_CONSTANTS) Key_f7: INTEGER_32 = 33 -- (from EV_KEY_CONSTANTS) Key_f8: INTEGER_32 = 34 -- (from EV_KEY_CONSTANTS) Key_f9: INTEGER_32 = 35 -- (from EV_KEY_CONSTANTS) Key_g: INTEGER_32 = 74 -- (from EV_KEY_CONSTANTS) Key_h: INTEGER_32 = 75 -- (from EV_KEY_CONSTANTS) Key_home: INTEGER_32 = 64 -- (from EV_KEY_CONSTANTS) Key_i: INTEGER_32 = 76 -- (from EV_KEY_CONSTANTS) Key_insert: INTEGER_32 = 66 -- (from EV_KEY_CONSTANTS) Key_j: INTEGER_32 = 77 -- (from EV_KEY_CONSTANTS) Key_k: INTEGER_32 = 78 -- (from EV_KEY_CONSTANTS) Key_l: INTEGER_32 = 79 -- (from EV_KEY_CONSTANTS) Key_left: INTEGER_32 = 60 -- (from EV_KEY_CONSTANTS) Key_left_meta: INTEGER_32 = 97 -- (from EV_KEY_CONSTANTS) Key_m: INTEGER_32 = 80 -- (from EV_KEY_CONSTANTS) Key_menu: INTEGER_32 = 99 -- (from EV_KEY_CONSTANTS) Key_n: INTEGER_32 = 81 -- (from EV_KEY_CONSTANTS) Key_num_lock: INTEGER_32 = 24 -- (from EV_KEY_CONSTANTS) Key_numpad_0: INTEGER_32 = 11 -- (from EV_KEY_CONSTANTS) Key_numpad_1: INTEGER_32 = 12 -- (from EV_KEY_CONSTANTS) Key_numpad_2: INTEGER_32 = 13 -- (from EV_KEY_CONSTANTS) Key_numpad_3: INTEGER_32 = 14 -- (from EV_KEY_CONSTANTS) Key_numpad_4: INTEGER_32 = 15 -- (from EV_KEY_CONSTANTS) Key_numpad_5: INTEGER_32 = 16 -- (from EV_KEY_CONSTANTS) Key_numpad_6: INTEGER_32 = 17 -- (from EV_KEY_CONSTANTS) Key_numpad_7: INTEGER_32 = 18 -- (from EV_KEY_CONSTANTS) Key_numpad_8: INTEGER_32 = 19 -- (from EV_KEY_CONSTANTS) Key_numpad_9: INTEGER_32 = 20 -- (from EV_KEY_CONSTANTS) Key_numpad_add: INTEGER_32 = 21 -- (from EV_KEY_CONSTANTS) Key_numpad_decimal: INTEGER_32 = 26 -- (from EV_KEY_CONSTANTS) Key_numpad_divide: INTEGER_32 = 22 -- (from EV_KEY_CONSTANTS) Key_numpad_multiply: INTEGER_32 = 23 -- (from EV_KEY_CONSTANTS) Key_numpad_subtract: INTEGER_32 = 25 -- (from EV_KEY_CONSTANTS) Key_o: INTEGER_32 = 82 -- (from EV_KEY_CONSTANTS) Key_open_bracket: INTEGER_32 = 51 -- (from EV_KEY_CONSTANTS) Key_p: INTEGER_32 = 83 -- (from EV_KEY_CONSTANTS) Key_page_down: INTEGER_32 = 63 -- (from EV_KEY_CONSTANTS) Key_page_up: INTEGER_32 = 62 -- (from EV_KEY_CONSTANTS) Key_pause: INTEGER_32 = 44 -- (from EV_KEY_CONSTANTS) Key_period: INTEGER_32 = 49 -- (from EV_KEY_CONSTANTS) Key_q: INTEGER_32 = 84 -- (from EV_KEY_CONSTANTS) Key_quote: INTEGER_32 = 55 -- (from EV_KEY_CONSTANTS) Key_r: INTEGER_32 = 85 -- (from EV_KEY_CONSTANTS) Key_right: INTEGER_32 = 61 -- (from EV_KEY_CONSTANTS) Key_right_meta: INTEGER_32 = 98 -- (from EV_KEY_CONSTANTS) Key_s: INTEGER_32 = 86 -- (from EV_KEY_CONSTANTS) Key_scroll_lock: INTEGER_32 = 46 -- (from EV_KEY_CONSTANTS) Key_semicolon: INTEGER_32 = 50 -- (from EV_KEY_CONSTANTS) Key_shift: INTEGER_32 = 94 -- (from EV_KEY_CONSTANTS) Key_slash: INTEGER_32 = 53 -- (from EV_KEY_CONSTANTS) Key_space: INTEGER_32 = 39 -- (from EV_KEY_CONSTANTS) Key_t: INTEGER_32 = 87 -- (from EV_KEY_CONSTANTS) Key_tab: INTEGER_32 = 43 -- (from EV_KEY_CONSTANTS) Key_u: INTEGER_32 = 88 -- (from EV_KEY_CONSTANTS) Key_up: INTEGER_32 = 58 -- (from EV_KEY_CONSTANTS) Key_v: INTEGER_32 = 89 -- (from EV_KEY_CONSTANTS) Key_w: INTEGER_32 = 90 -- (from EV_KEY_CONSTANTS) Key_x: INTEGER_32 = 91 -- (from EV_KEY_CONSTANTS) Key_y: INTEGER_32 = 92 -- (from EV_KEY_CONSTANTS) Key_z: INTEGER_32 = 93 -- (from EV_KEY_CONSTANTS) feature -- Contract support valid_key_code (a_code: INTEGER_32): BOOLEAN -- Is a_code a valid key code? -- (from EV_KEY_CONSTANTS) feature -- Modification reset -- Reset value to `default_value`. -- (from PREFERENCE) ensure -- from PREFERENCE is_reset: old has_default_value implies is_default_value select_value_from_string (s: READABLE_STRING_32) -- Select current value to match s. -- Same as `set_value_from_string` for a single-valued preference. -- Selects an item corresponding to s for a multi-valued preference. -- (from TYPED_PREFERENCE) require -- from PREFERENCE is_valid_string_for_selection (s) set_auto_preference (a_pref: SHORTCUT_PREFERENCE) -- Use value of a_pref for "auto" value for Current. -- (from TYPED_PREFERENCE) require -- from TYPED_PREFERENCE a_pref_not_void: a_pref /= Void and then a_pref.has_value ensure -- from TYPED_PREFERENCE auto_set: auto_preference = a_pref set_default_value (a_value: READABLE_STRING_GENERAL) -- Set the value to be used for default in the event `value` is not set. -- (from PREFERENCE) require -- from PREFERENCE a_value_not_void: a_value /= Void a_value_valid: is_string_value_validated (a_value) ensure -- from PREFERENCE default_value_set: attached internal_default_value as l_value and then l_value.same_string_general (a_value) set_description (new_description: READABLE_STRING_GENERAL) -- Set `description` to new_description. -- (from PREFERENCE) require -- from PREFERENCE new_description_exists: new_description /= Void new_description_not_empty: not new_description.is_empty ensure -- from PREFERENCE description_set: attached description as d and then d.same_string_general (new_description) set_hidden (a_flag: BOOLEAN) -- Set if this is hidden from user view. -- (from PREFERENCE) ensure -- from PREFERENCE value_set: is_hidden = a_flag set_name (new_name: STRING_8) -- Set `name` to new_name. -- (from PREFERENCE) require -- from PREFERENCE new_name_not_void: new_name /= Void new_name_not_empty: not new_name.is_empty ensure -- from PREFERENCE name_set: name = new_name set_restart_required (is_required: BOOLEAN) -- Set 'restart_required' -- (from PREFERENCE) ensure -- from PREFERENCE restart_required_set: restart_required = is_required set_value (a_value: TUPLE [alt: BOOLEAN; ctrl: BOOLEAN; shift: BOOLEAN; key_string: STRING_32]) -- Set the value. -- (from TYPED_PREFERENCE) require -- from TYPED_PREFERENCE value_not_void: a_value /= Void ensure -- from TYPED_PREFERENCE value_set: internal_value = a_value set_value_to_auto -- Set the value to match that of `auto_preference`. -- (from TYPED_PREFERENCE) require -- from TYPED_PREFERENCE has_auto_preference: auto_preference /= Void ensure -- from TYPED_PREFERENCE value_set: (attached auto_preference as el_auto_preference) and then internal_value = el_auto_preference.value feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Query is_alt: BOOLEAN -- Requires Alt key? is_ctrl: BOOLEAN -- Requires Ctrl key? is_default_value: BOOLEAN -- Is this preference value the same as the default value? is_shift: BOOLEAN -- Requires Shift key? valid_value_string (a_string: READABLE_STRING_GENERAL): BOOLEAN -- Is a_string valid for this preference type to convert into a value? require -- from PREFERENCE string_not_void: a_string /= Void feature -- Status Setting set_value_from_string (a_value: READABLE_STRING_GENERAL) -- Parse the string value a_value and set `value`. -- String format: "Alt+Ctrl+Shift+KeyString" require -- from PREFERENCE a_value_not_void: a_value /= Void a_value_valid: is_string_value_validated (a_value) feature -- Status change set_group (a_group: MANAGED_SHORTCUT_GROUP) -- Set `group` with a_group. -- Change elements in `group` and a_group also. -- (from MANAGED_SHORTCUT) ensure -- from MANAGED_SHORTCUT group_set: group = a_group group_element_set: ((attached (old group) as l_old_group) implies not (l_old_group).shortcuts.has (Current)) and (a_group /= Void implies a_group.shortcuts.has (Current)) set_values (a_key: detachable like key; alt, ctrl, shift: BOOLEAN) -- Set values. -- (from MANAGED_SHORTCUT) require -- from MANAGED_SHORTCUT modifiable: modifiable_with (a_key, alt, ctrl, shift) feature -- Validation validation_agent: detachable FUNCTION [READABLE_STRING_GENERAL, BOOLEAN] -- Validation agent to test if a READABLE_STRING_GENERAL is a valid text value for Current -- (from PREFERENCE) invariant -- from TYPED_PREFERENCE typed_change_actions_not_void: typed_change_actions /= Void attached_auto_preference_has_value: (attached auto_preference as l_auto_preference) implies l_auto_preference.has_value -- from PREFERENCE has_manager: manager /= Void name_not_void: name /= Void has_change_actions: change_actions /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2019, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class SHORTCUT_PREFERENCE -- Generated by Eiffel Studio --
For more details: eiffel.org