Automatic generation produced by ISE Eiffel
note description: "Cell consisting of only of a text label. Implementation Interface." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2021-11-17 05:24:44 -0900 (Wed, 17 Nov 2021) $" revision: "$Revision: 105961 $" class interface EV_GRID_LABEL_ITEM_I create make -- Initialize Current. require -- from EV_ANY_I True ensure -- from EV_ANY_I is_initialized: get_state_flag (Is_initialized_flag) feature -- Access background_color: detachable EV_COLOR -- Color displayed behind foreground features. -- (from EV_GRID_ITEM_I) column: EV_GRID_COLUMN -- Column to which current item belongs. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I is_parented: is_parented ensure -- from EV_GRID_ITEM_I column_not_void: Result /= Void foreground_color: detachable EV_COLOR -- Color of foreground features like text. -- (from EV_GRID_ITEM_I) generating_type: TYPE [detachable EV_GRID_LABEL_ITEM_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 hash_code: INTEGER_32 -- Used to uniquely identify grid item within `parent_i`. -- Should be set to 0 if Current is not parented. -- (from EV_GRID_ITEM_I) height: INTEGER_32 -- Height of Current in pixels. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: is_parented ensure -- from EV_GRID_ITEM_I result_non_negative: Result >= 0 horizontal_indent: INTEGER_32 -- Horizontal distance in pixels from left edge of Current to left edge of `column`. -- This may not be set, but the value is determined by the current tree structure -- of `parent` and `row`. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: parent /= Void ensure -- from EV_GRID_ITEM_I parent_attached: attached parent as l_parent not_parent_tree_enabled_implies_result_zero: not l_parent.is_tree_enabled implies Result = 0 parent_tree_enabled_implies_result_greater_or_equal_to_zero: l_parent.is_tree_enabled implies Result >= 0 parent: detachable EV_GRID -- Grid to which Current is displayed in. -- (from EV_GRID_ITEM_I) row: EV_GRID_ROW -- Row to which current item belongs. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: is_parented ensure -- from EV_GRID_ITEM_I row_not_void: Result /= Void tooltip: detachable STRING_32 -- Tooltip displayed on Current. -- If Result is Void or is_empty then no tooltip is displayed. -- (from EV_GRID_ITEM_I) virtual_x_position: INTEGER_32 -- Horizontal offset of Current in relation to the -- the virtual area of `parent` grid in pixels. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: parent /= Void ensure -- from EV_GRID_ITEM_I valid_result: attached parent as l_parent implies Result >= 0 and Result <= l_parent.virtual_width - column.width + horizontal_indent virtual_y_position: INTEGER_32 -- Vertical offset of Current in relation to the -- the virtual area of `parent` grid in pixels. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: parent /= Void ensure -- from EV_GRID_ITEM_I valid_result_when_parent_row_height_fixed: attached parent as l_parent and then l_parent.is_row_height_fixed implies Result >= 0 and Result <= l_parent.virtual_height - l_parent.row_height valid_result_when_parent_row_height_not_fixed: attached parent as l_parent2 and then not l_parent2.is_row_height_fixed implies Result >= 0 and Result <= l_parent2.virtual_height - row.height width: INTEGER_32 -- Width of Current in pixels. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: is_parented ensure -- from EV_GRID_ITEM_I result_non_negative: 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_LABEL_ITEM_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_LABEL_ITEM_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_LABEL_ITEM_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 is_destroyed: BOOLEAN -- Is Current destroyed? -- (from EV_GRID_ITEM_I) is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) is_parented: BOOLEAN -- Does current item belongs to an EV_GRID? -- (from EV_GRID_ITEM_I) is_selectable: BOOLEAN -- Is Current selectable? -- (from EV_GRID_ITEM_I) is_selected: BOOLEAN -- Is Current selected? -- (from EV_GRID_ITEM_I) is_tab_navigatable: BOOLEAN -- Is Current tab key navigatable? -- (from EV_GRID_ITEM_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)) feature -- Status setting activate -- Setup Current for user interactive editing. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: is_parented deactivate -- Cleanup from previous call to `activate`. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: is_parented disable_select -- Set `is_selected` False. -- (from EV_GRID_ITEM_I) require -- from EV_DESELECTABLE_I is_selectable: is_selectable ensure -- from EV_DESELECTABLE_I deselected: not is_selected enable_select -- Set `is_selected` True. -- (from EV_GRID_ITEM_I) require -- from EV_SELECTABLE_I is_selectable: is_selectable ensure -- from EV_SELECTABLE_I selected: is_selected ensure_visible -- Ensure Current is visible in viewable area of `parent`. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I parented: parent /= Void ensure -- from EV_GRID_ITEM_I parent_not_void: attached parent as l_par virtual_x_position_not_changed_if_indent_greater_or_equal_to_column_width: old (horizontal_indent > column.width) implies old virtual_x_position = virtual_x_position row_visible_when_heights_fixed_in_parent: l_par.is_row_height_fixed implies row.virtual_y_position >= l_par.virtual_y_position and virtual_y_position + l_par.row_height <= l_par.virtual_y_position + (l_par.viewable_height).max (l_par.row_height) row_visible_when_heights_not_fixed_in_parent: not l_par.is_row_height_fixed implies row.virtual_y_position >= l_par.virtual_y_position and virtual_y_position + row.height <= l_par.virtual_y_position + (l_par.viewable_height).max (row.height) virtual_x_position_visible_if_indent_less_than_row_indent: horizontal_indent < column.width implies virtual_x_position >= l_par.virtual_x_position and virtual_x_position + width <= l_par.virtual_x_position + (l_par.viewable_width).max (width) redraw -- Force Current to be re-drawn when next idle. -- (from EV_GRID_ITEM_I) 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 feature -- Element change set_background_color (a_color: like background_color) -- Set `background_color` with a_color. -- (from EV_GRID_ITEM_I) set_foreground_color (a_color: like foreground_color) -- Set `foreground_color` with a_color. -- (from EV_GRID_ITEM_I) ensure -- from EV_GRID_ITEM_I foreground_color_assigned: foreground_color = a_color set_is_tab_navigatable (a_is_tab_navigatable: BOOLEAN) -- Set tab navigatable state to a_is_tab_navigatable -- Used to determine whether it may be tabbed to if a_is_tab_navigatable is True. -- (from EV_GRID_ITEM_I) require -- from EV_GRID_ITEM_I not_destroyed: not is_destroyed ensure -- from EV_GRID_ITEM_I is_tab_navigatable_set: is_tab_navigatable = a_is_tab_navigatable set_tooltip (a_tooltip: detachable READABLE_STRING_GENERAL) -- Assign a_tooltip to `tooltip`. -- pass Void to remove the tooltip. -- (from EV_GRID_ITEM_I) ensure -- from EV_GRID_ITEM_I tooltip_reset: a_tooltip = Void implies tooltip = Void tooltip_set: a_tooltip /= Void and then attached tooltip as l_tooltip implies (l_tooltip.same_string_general (a_tooltip)) feature -- Duplication copy (other: EV_GRID_LABEL_ITEM_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_LABEL_ITEM_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_LABEL_ITEM_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_LABEL_ITEM_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_LABEL_ITEM_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_LABEL_ITEM_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_LABEL_ITEM_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 activate_actions: EV_LITE_ACTION_SEQUENCE [EV_POPUP_WINDOW] -- Actions to be performed to setup Current for activation. -- Overrides default setup of activatable items. -- Arguments of TUPLE (with names for clarity): -- -- popup_window: EV_WINDOW -- The popup window used to interactively edit activate_item, window has already been sized and positioned. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) deactivate_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when Current is deactivated. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I result_not_void: Result /= Void deselect_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when an item is deselected. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I result_not_void: Result /= Void drop_actions: EV_PND_ACTION_SEQUENCE -- Actions to be performed when a pebble is dropped here. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void key_press_actions: EV_KEY_ACTION_SEQUENCE -- Actions to be performed when a keyboard key is pressed. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void key_press_string_actions: EV_KEY_STRING_ACTION_SEQUENCE -- Actions to be performed when a keyboard press generates a displayable character. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void key_release_actions: EV_KEY_ACTION_SEQUENCE -- Actions to be performed when a keyboard key is released. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void pointer_button_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is pressed. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void pointer_button_release_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is released. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void pointer_double_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer is double clicked. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void pointer_enter_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when screen pointer enters widget. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void pointer_leave_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when screen pointer leaves widget. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void pointer_motion_actions: EV_POINTER_MOTION_ACTION_SEQUENCE -- Actions to be performed when screen pointer moves. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void select_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when an item is selected. -- (from EV_GRID_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_GRID_ITEM_ACTION_SEQUENCES_I result_not_void: Result /= Void 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 feature -- Status Report is_displayed: BOOLEAN -- Is Current visible on the screen? -- True when parent displayed. -- An item that is_displayed does not necessarily have to be visible on screen at that particular time. -- (from EV_GRID_ITEM_I) required_width: INTEGER_32 -- Width in pixels required to fully display contents, based -- on current settings. invariant -- from EV_GRID_ITEM_I is_parented_implies_parents_set: is_parented implies parent_i /= Void and then column_i /= Void and then row_i /= Void not_is_parented_implies_parents_not_set: not is_parented implies parent_i = Void and then column_i = Void and then row_i = Void hash_code_valid: is_initialized implies ((not is_parented and hash_code = 0) or (is_parented and then hash_code > 0)) -- 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-2021, 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_LABEL_ITEM_I -- Generated by Eiffel Studio --
For more details: eiffel.org