Automatic generation produced by ISE Eiffel
note description: "Eiffel Vision menu item list. Implementation interface." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2013-05-20 15:15:17 -0800 (Mon, 20 May 2013) $" revision: "$Revision: 92557 $" deferred class interface EV_MENU_ITEM_LIST_I feature -- Access cursor: EV_DYNAMIC_LIST_CURSOR [EV_MENU_ITEM] -- Current cursor position. -- (from EV_DYNAMIC_LIST_I) ensure -- from EV_DYNAMIC_LIST_I not_void: Result /= Void generating_type: TYPE [detachable EV_MENU_ITEM_LIST_I] -- 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 i_th (i: INTEGER_32): EV_MENU_ITEM -- Item at i-th position. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I i_within_bounds: i > 0 and then i <= count ensure -- from EV_DYNAMIC_LIST_I not_void: Result /= Void index: INTEGER_32 -- Index of current position -- (from EV_DYNAMIC_LIST_I) index_of (v: detachable like item; i: INTEGER_32): INTEGER_32 -- Index of i_th item v, if present. -- As dynamic list descendants are all sets, -- Result will be zero for all values of i -- that are not equal to one -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I positive_occurrences: i > 0 item: EV_MENU_ITEM -- Current item -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I readable: index > 0 and then index <= count ensure -- from EV_DYNAMIC_LIST_I not_void: Result /= Void item_by_data (data: ANY): detachable like item -- First item with data. -- (from EV_ITEM_LIST_I) require -- from EV_ITEM_LIST_I data_not_void: data /= Void off: BOOLEAN -- Is there no current item? -- (from EV_DYNAMIC_LIST_I) retrieve_item_by_data (data: detachable ANY; should_compare_objects: BOOLEAN): detachable EV_MENU_ITEM -- Result is first item in Current with data -- matching some_data. Compare objects if -- should_compare_objects otherwise compare references. -- (from EV_DYNAMIC_LIST_I) retrieve_items_by_data (data: ANY; should_compare_objects: BOOLEAN): ARRAYED_LIST [EV_MENU_ITEM] -- Result is all items in Current with data -- matching some_data. Compare objects if -- should_compare_objects otherwise compare references. -- (from EV_DYNAMIC_LIST_I) feature -- Measurement count: INTEGER_32 -- Number of items. -- (from EV_DYNAMIC_LIST_I) 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: EV_MENU_ITEM_LIST_I): 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: EV_MENU_ITEM_LIST_I): 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: EV_MENU_ITEM_LIST_I): 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 (v: detachable like item): BOOLEAN -- Does structure contain v? -- (from EV_DYNAMIC_LIST_I) is_destroyed: BOOLEAN -- Is Current no longer usable? -- (from EV_ANY_I) 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)) valid_cursor (p: CURSOR): BOOLEAN -- Can the cursor be moved to position p? -- This is True if p conforms to EV_DYNAMIC_LIST_CURSOR and -- if it points to an item, Current must have it. -- (from EV_DYNAMIC_LIST_I) feature -- Cursor movement back -- Move to previous item. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I not_before: index > 0 forth -- Move cursor to next position. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I not_after: index <= count go_i_th (i: INTEGER_32) -- Move cursor to i-th position. -- (from EV_DYNAMIC_LIST_I) go_to (p: CURSOR) -- Move cursor to position p. -- (from EV_DYNAMIC_LIST_I) move (i: INTEGER_32) -- Move cursor i positions. -- (from EV_DYNAMIC_LIST_I) start -- Move cursor to first position. -- (from EV_DYNAMIC_LIST_I) ensure -- from EV_DYNAMIC_LIST_I index_on_first: index = 1 feature -- Element change append (s: SEQUENCE [EV_MENU_ITEM]) -- Append a copy of s. Do not move cursor. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I sequence_not_void: s /= Void ensure -- from EV_DYNAMIC_LIST_I count_increased: old count + s.count = count extend (v: like item) -- Add v to end. Do not move cursor. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I v_not_void: v /= Void ensure -- from EV_DYNAMIC_LIST_I has_v: has (v) merge_left (other: like attached_interface) -- Merge other into current structure before cursor -- position. Do not move cursor. Empty other. -- (from EV_DYNAMIC_LIST_I) merge_right (other: like attached_interface) -- Merge other into current structure after cursor -- position. Do not move cursor. Empty other. -- (from EV_DYNAMIC_LIST_I) put_front (v: like item) -- Add v at beginning. Do not move cursor. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I v_not_void: v /= Void ensure -- from EV_DYNAMIC_LIST_I has_v: has (v) put_i_th (v: like item; i: INTEGER_32) -- Replace item at i-th position by v. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I valid_index: i > 0 and i <= count v_not_void: v /= Void ensure -- from EV_DYNAMIC_LIST_I has_v: has (v) put_left (v: like item) -- Add v to the left of cursor position. Do not move cursor. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I v_not_void: v /= Void ensure -- from EV_DYNAMIC_LIST_I has_v: has (v) put_right (v: like item) -- Add v to the right of cursor position. Do not move cursor. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I v_not_void: v /= Void ensure -- from EV_DYNAMIC_LIST_I has_v: has (v) replace (v: like item) -- Replace current item by v. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I writable: index > 0 and then index <= count v_not_void: v /= Void ensure -- from EV_DYNAMIC_LIST_I has_v: has (v) feature -- Removal prune (v: like item) -- Remove v if present. Do not move cursor, except if -- cursor was on v, move to right neighbor. -- (from EV_DYNAMIC_LIST_I) ensure -- from EV_DYNAMIC_LIST_I cursor_not_moved: not old has (v) implies old attached_interface.index = attached_interface.index cursor_not_moved: old has (v) and then old attached_interface.index < old index_of (v, 1) implies index = old index cursor_not_moved: old has (v) and then old attached_interface.index >= old index_of (v, 1) implies index = old index - 1 not_has_v: not has (v) remove -- Remove current item. Move cursor to right neighbor -- (or after if no right neighbor). -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I writable: not off ensure -- from EV_DYNAMIC_LIST_I not_has_v: not has (old item) remove_left -- Remove item to the left of cursor position. -- Do not move cursor. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I left_exists: index > 1 not_before: not (index = 0) ensure then -- from EV_DYNAMIC_LIST_I left_neighbor_removed: not has (old i_th (index - 1)) remove_right -- Remove item to the right of cursor position. -- Do not move cursor. -- (from EV_DYNAMIC_LIST_I) require -- from EV_DYNAMIC_LIST_I right_exists: index < count ensure then -- from EV_DYNAMIC_LIST_I right_neighbor_removed: not has (old i_th (index + 1)) wipe_out -- Remove all items. -- (from EV_DYNAMIC_LIST_I) feature -- Duplication copy (other: EV_MENU_ITEM_LIST_I) -- 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: EV_MENU_ITEM_LIST_I) -- 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: EV_MENU_ITEM_LIST_I -- 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: EV_MENU_ITEM_LIST_I) -- 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: EV_MENU_ITEM_LIST_I -- 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: EV_MENU_ITEM_LIST_I -- 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 EV_MENU_ITEM_LIST_I -- 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 -- Event handling item_select_actions: EV_MENU_ITEM_SELECT_ACTION_SEQUENCE -- Actions to be performed when a menu item is selected. -- (from EV_MENU_ITEM_LIST_ACTION_SEQUENCES_I) ensure -- from EV_MENU_ITEM_LIST_ACTION_SEQUENCES_I not_void: Result /= Void 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 invariant -- from EV_DYNAMIC_LIST_I index_within_bounds: is_usable implies (index >= 0 and then index <= count + 1) -- from EV_ANY_I interface_coupled: is_usable implies interface /= Void and then attached_interface.implementation = Current base_make_called: is_usable implies base_make_called -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2006, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 356 Storke Road, 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 EV_MENU_ITEM_LIST_I -- Generated by Eiffel Studio --
For more details: eiffel.org