Automatic generation produced by ISE Eiffel
note description: "Preference for a choice among STRING_32 values." class interface STRING_CHOICE_PREFERENCE create {PREFERENCE_FACTORY} make (a_manager: PREFERENCE_MANAGER; a_name: STRING_8; a_value: LIST [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 auto_preference: detachable STRING_CHOICE_PREFERENCE -- Preference to use for auto color. -- (from PREFERENCE) 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) Generating_preference_type: STRING_8 -- The generating type of the preference for graphical representation. -- (from CHOICE_PREFERENCE) require -- from PREFERENCE True ensure -- from PREFERENCE generating_preference_type_not_void: Result /= Void generating_type: TYPE [detachable STRING_CHOICE_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 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 manager: PREFERENCE_MANAGER -- Manager to which Current belongs. -- (from PREFERENCE) name: STRING_8 -- Name of the preference as it appears in the preference file. -- (from PREFERENCE) selected_index: INTEGER_32 -- Selected index from list. -- (from CHOICE_PREFERENCE) selected_value: detachable STRING_32 -- Value of the selected index. -- (from CHOICE_PREFERENCE) selected_value_as_text: detachable STRING_32 -- (from CHOICE_PREFERENCE) String_type: STRING_8 -- String description of this preference type. -- (from CHOICE_PREFERENCE) require -- from PREFERENCE True ensure -- from PREFERENCE string_type_not_void: Result /= Void no_underscore: not Result.has ('_') typed_change_actions: ACTION_SEQUENCE [LIST [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 value: LIST [STRING_32] -- Actual value. -- (from TYPED_PREFERENCE) value_as_array: ARRAY [STRING_32] -- `value` as an ARRAY [G] -- to ease migration from ARRAY_PREFERENCE to LIST_PREFERENCE -- (from LIST_PREFERENCE) ensure -- from LIST_PREFERENCE value_unmodified: value.count = old value.count same_count: Result.count = value.count same: not value.is_empty implies ∀ c: value ¦ c ~ Result [Result.lower + .target_index - .first_index] value_as_list_of_text: LIST [STRING_32] -- (from LIST_PREFERENCE) require -- from ABSTRACT_CHOICE_PREFERENCE has_value feature -- Measurement value_count: INTEGER_32 -- (from LIST_PREFERENCE) 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: STRING_CHOICE_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: STRING_CHOICE_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: STRING_CHOICE_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_default_value: BOOLEAN -- Is this preference value the same as the default value? -- (from PREFERENCE) 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 ABSTRACT_CHOICE_PREFERENCE) require -- from PREFERENCE True ensure then -- from ABSTRACT_CHOICE_PREFERENCE Result implies has_value Result implies value_as_list_of_text.has (s.as_string_32) 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: STRING_CHOICE_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: STRING_CHOICE_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: STRING_CHOICE_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: STRING_CHOICE_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: STRING_CHOICE_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: STRING_CHOICE_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 STRING_CHOICE_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 -- 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_selected_index (a_index: INTEGER_32) -- Set `selected_index` -- (from CHOICE_PREFERENCE) require -- from ABSTRACT_CHOICE_PREFERENCE index_valid: a_index > 0 ensure -- from ABSTRACT_CHOICE_PREFERENCE index_set: selected_index = a_index set_validation_agent (agt: like validation_agent) -- Set `validation_agent` to agt. -- (from PREFERENCE) set_value_from_string (a_value: READABLE_STRING_GENERAL) -- Parse the string value a_value and set `value`. -- (from CHOICE_PREFERENCE) require -- from PREFERENCE a_value_not_void: a_value /= Void a_value_valid: is_string_value_validated (a_value) feature -- Formatting escaped_string (s: STRING_32): STRING_32 -- Escaped string s to avoid issue with `item_separator` (i.e ';') -- (from LIST_PREFERENCE) require -- from ABSTRACT_CHOICE_PREFERENCE True unescaped_string (s: STRING_32): STRING_32 -- (from LIST_PREFERENCE) 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 ABSTRACT_CHOICE_PREFERENCE) require -- from PREFERENCE is_valid_string_for_selection (s) ensure then -- from ABSTRACT_CHOICE_PREFERENCE value_as_list_of_text [selected_index].same_string (s) set_auto_preference (a_pref: STRING_CHOICE_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: LIST [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 valid_value_string (a_string: READABLE_STRING_GENERAL): BOOLEAN -- Is a_string valid for this preference type to convert into a value? -- (from LIST_PREFERENCE) require -- from PREFERENCE string_not_void: a_string /= Void 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 date: "$Date: Ñп$" revision: "$Revision: 103735 $" 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 STRING_CHOICE_PREFERENCE -- Generated by Eiffel Studio --
For more details: eiffel.org