Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "Representation of a row of an EV_GRID" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2019-08-01 20:03:18 -0800 (Thu, 01 Aug 2019) $" revision: "$Revision: 103375 $" class interface EV_GRID_ROW_I create make -- Initialize Current. ensure -- from EV_ANY_I is_initialized: get_state_flag (Is_initialized_flag) feature -- Access collapse_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when Current is collapsed. -- (from EV_GRID_ROW_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ROW_ACTION_SEQUENCES_I result_not_void: Result /= Void deselect_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when Current is deselected. -- (from EV_GRID_ROW_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ROW_ACTION_SEQUENCES_I result_not_void: Result /= Void expand_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when Current is expanded. -- (from EV_GRID_ROW_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ROW_ACTION_SEQUENCES_I result_not_void: Result /= Void generating_type: TYPE [detachable EV_GRID_ROW_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 has_subrow (a_row: EV_GRID_ROW): BOOLEAN -- Is a_row a child of Current? require a_row_not_void: a_row /= Void is_parented: parent /= Void ensure has_subrow_same_parent: Result implies ((a_row.parent /= Void and parent /= Void) and then a_row.parent = parent) hash_code: INTEGER_32 -- Number to uniquely identify grid row within `parent_i`. -- Should be set to 0 if Current is not parented. height: INTEGER_32 -- Height of Current when displayed in a `parent` -- that has is_row_height_fixed set to False. -- Note that `height` is ignored if the parent has -- is_row_height_fixed set to True and then all rows -- are displayed with identical heights set to parent.row_height. require is_parented: parent /= Void ensure result_not_negative: Result >= 0 internal_are_all_non_void_items_selected: BOOLEAN -- Are all the non void items in Current selected? -- False if no non void items are present. internal_height: INTEGER_32 -- Internal storage for Current. internal_is_selected: BOOLEAN -- Is Current selected in either row selection mode? internal_update_selection (a_selection_state: BOOLEAN) -- Set the selection state of all non void items in Current to a_selection_state. is_expandable: BOOLEAN -- May Current be expanded? require is_parented: parent /= Void is_expanded: BOOLEAN -- Are subrows of Current displayed? is_selectable: BOOLEAN -- May the object be selected? is_selected: BOOLEAN -- Is objects state set to selected. item (i: INTEGER_32): detachable EV_GRID_ITEM -- Item at i-th column, Void if none. require i_within_bounds: i > 0 and i <= count is_parented: parent /= Void parent: detachable EV_GRID -- Grid to which current row belongs. parent_row: detachable EV_GRID_ROW -- Parent row of Current if any, Void otherwise. require is_parented: parent /= Void ensure result_void_when_tree_node_enabled: (parent = Void) or (attached parent as l_parent and then not l_parent.is_tree_enabled) implies Result = Void has_parent: Result /= Void implies Result.has_subrow (attached_interface) parent_row_root: detachable EV_GRID_ROW -- Parent row which is the root of the tree structure -- in which Current is contained. May be Current if -- Current is the root node of a tree structure. require is_parented: parent /= Void ensure result_consistent_with_parent_tree_properties: (parent = Void or else (attached parent as l_parent and then not l_parent.is_tree_enabled)) = (Result = Void) select_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when Current is selected. -- (from EV_GRID_ROW_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ROW_ACTION_SEQUENCES_I result_not_void: Result /= Void selected_items: ARRAYED_LIST [EV_GRID_ITEM] -- All items selected in Current. require is_parented: parent /= Void ensure result_not_void: Result /= Void valid_count: Result.count <= count subrow (i: INTEGER_32): EV_GRID_ROW -- i-th child of Current. require is_parented: parent /= Void i_positive: i > 0 i_less_than_subrow_count: i <= subrow_count ensure subrow_not_void: Result /= Void subrow_valid: (Result.parent /= Void) and then has_subrow (Result) and then Result.parent_row = attached_interface virtual_y_position: INTEGER_32 -- Vertical offset of Current in relation to the -- the virtual area of `parent` grid in pixels. -- Result is 0 if `parent` is Void. ensure parent_void_implies_result_zero: parent = Void implies Result = 0 virtual_y_position_unlocked: INTEGER_32 -- Vertical offset of unlocked position of Current, in relation to the -- virtual area of `parent` grid in pixels. -- If not `is_locked`, then `virtual_y_position` = unlocked_virtual_y_position. -- If `is_locked` then Result is the "shadow" position where the row would -- be if not locked. ensure parent_void_implies_result_zero: parent = Void implies Result = 0 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_GRID_ROW_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_GRID_ROW_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_GRID_ROW_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 background_color: detachable EV_COLOR -- Color displayed as background of Current except where there are items contained that -- have a non-Void `background_color`. If Void, `background_color` of `parent` is displayed.. 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 count: INTEGER_32 -- Number of items in current. ensure count_not_negative: count >= 0 foreground_color: detachable EV_COLOR -- Color displayed for foreground features of Current except where there are items contained that -- have a non-Void `foreground_color`. If Void, `foreground_color` of `parent` is displayed. index: INTEGER_32 -- Position of Current in `parent`. index_of_first_item: INTEGER_32 -- Return the index of the first non Void item within Current -- or 0 if none. ensure valid_result: Result >= 0 and Result <= count value_valid: index_of_first_item_internal = index_of_first_item_value index_of_first_item_value: INTEGER_32 -- Return the index of the first non Void item within Current -- or 0 if none. ensure valid_result: Result >= 0 and Result <= count is_destroyed: BOOLEAN -- Is Current no longer usable? -- (from EV_ANY_I) is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) is_locked: BOOLEAN -- Is Current locked so that it no longer scrolls? -- Note that this could be implemented as a function -- "Result := parent_i.locked_rows.item (index) /= Void" but this has not been done -- so for performance reasons. locked_position: INTEGER_32 -- Locked position of Current from top edge of viewable area of `parent`. -- Result is 0 if not `is_locked`. ensure not_locked_implies_result_zero: not is_locked implies Result = 0 locked_row: detachable EV_GRID_LOCKED_ROW_I -- Locked row information for Current. -- Void if not locked. 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)) subrow_count: INTEGER_32 -- Number of children. require is_parented: parent /= Void ensure subrow_count_non_negative: subrow_count >= 0 subrow_count_in_range: attached parent as l_parent and then subrow_count <= (l_parent.row_count - index) subrow_count_recursive: INTEGER_32 -- Number of child rows and their child rows recursively. subrow_index: INTEGER_32 -- Position of Current in `parent_row` if any. feature -- Status setting collapse -- Hide all subrows of Current. require is_parented: parent /= Void ensure not_is_expanded: not is_expanded node_counts_correct: node_counts_correct ensure_expandable -- Ensure Current displays an expand pixmap to simulate a row_count greater than 0. -- May be used for dynamic behavior by filling subrows upon firing of grid.row_expand_actions. -- If no items are added to Current during the firing of grid.row_expand_actions then -- Current is no longer expandable. This may be re-instated by calling `ensure_expandable` again -- from grid.row_expand_actions. Note that once a subrow is added to Current after a call to -- `ensure_expandable`, it is no longer be displayed as expandable if all subrows are then removed. -- In this case, you must explicitly call `ensure_expandable` again after removing all subrows. require parented: attached parent as l_parent parent_tree_enabled: l_parent.is_tree_enabled ensure is_expandable: is_expandable ensure_non_expandable -- Restore expanded state of Current after a call to `ensure_expandable`. Note that if a row -- has one or more subrows, it is always drawn as expanded, hence the "no_subrows_contained" precondition. require parented: parent /= Void no_subrows_contained: subrow_count = 0 ensure not_is_expandable: not is_expandable ensure_visible -- Ensure Current is visible in viewable area of `parent`. require parented: parent /= Void ensure parent_virtual_x_position_unchanged: attached old parent as l_old_parent and then attached parent as l_parent and then l_old_parent.virtual_x_position = l_parent.virtual_x_position to_implement_assertion ("old_is_visible_implies_vertical_position_not_changed") row_visible_in_parent: virtual_y_position >= l_parent.virtual_y_position and virtual_y_position + height <= l_parent.virtual_y_position + (l_parent.viewable_height).max (height) expand -- Display all subrows of Current. require is_parented: parent /= Void is_expandable: is_expandable ensure is_expanded: is_expanded or subrow_count = 0 node_counts_correct: node_counts_correct hide -- Prevent Current from being shown in `parent`. require parented: parent /= Void is_displayed: BOOLEAN -- Is Current visible on the screen? -- True when show requested and parent displayed. -- A row that is_displayed does not necessarily have to be visible on screen at that particular time. is_ensured_expandable: BOOLEAN -- May current be expanded even through it is empty? is_show_requested: BOOLEAN -- May Current be displayed? -- Will return False if `hide` has been called on Current. lock_at_position (a_position: INTEGER_32) -- Ensure `is_locked` is True with the vertical offset from -- the top edge of the viewable area of `parent` set to a_position. ensure is_locked: is_locked locked_position_set: locked_position = a_position redraw -- Force all items within Current to be re-drawn when next idle. require parented: parent /= Void set_background_color (a_color: like background_color) -- Set `background_color` with a_color. require is_parented: parent /= Void ensure background_color_set: background_color = a_color set_foreground_color (a_color: like foreground_color) -- Set `foreground_color` with a_color. require is_parented: parent /= Void ensure foreground_color_set: foreground_color = a_color set_height (a_height: INTEGER_32) -- Assign a_height to `height`. require is_parented: parent /= Void not_is_row_height_fixed: attached parent as l_parent and then not l_parent.is_row_height_fixed height_valid: a_height >= 0 ensure height_set: height = a_height show -- Ensure Current is shown in `parent`. require parented: parent /= Void toggle -- Change `is_selected`. -- (from EV_DESELECTABLE_I) require -- from EV_DESELECTABLE_I not_is_destroyed: not is_destroyed can_be_selected: not is_selected implies is_selectable unlock -- Ensure `is_locked` is False. ensure not_is_locked: not is_locked feature -- Element change disable_select -- Deselect the object. require -- from EV_DESELECTABLE_I is_selectable: is_selectable ensure -- from EV_DESELECTABLE_I deselected: not is_selected enable_select -- Select the object. require -- from EV_SELECTABLE_I is_selectable: is_selectable ensure -- from EV_SELECTABLE_I selected: is_selected feature -- Duplication copy (other: EV_GRID_ROW_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_GRID_ROW_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_GRID_ROW_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_GRID_ROW_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_GRID_ROW_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_GRID_ROW_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_GRID_ROW_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 -- Contract Support attached_parent: EV_GRID -- Grid to which current row belongs. -- Used for old evaluation require parent_i_attached: attached parent feature -- Markers fixme (comment: READABLE_STRING_8) -- Mark code that has to be "fixed" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement (comment: READABLE_STRING_8) -- Mark code that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement_assertion (comment: READABLE_STRING_8): BOOLEAN -- Mark assertion that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class 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 subrows_not_void: is_initialized implies subrows /= Void hash_code_valid: is_initialized implies ((parent = Void and then hash_code = 0) or else (parent /= Void and then hash_code > 0)) -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- 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 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 EV_GRID_ROW_I
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

-- Generated by Eiffel Studio --
For more details: eiffel.org