    indexing
    	description: "Action sequences for EV_GRID_I."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	keywords: "event, action, sequence"

    deferred class interface
    	EV_GRID_ACTION_SEQUENCES_I

    feature -- Access

    	generating_type: STRING_8
    			-- Name of current object's generating type
    			-- (type of which it is a direct instance)
    			-- (from ANY)

    	generator: STRING_8
    			-- Name of current object's generating class
    			-- (base class of the type of which it is a direct instance)
    			-- (from ANY)

    feature -- Comparison

    	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void
    			-- or attached to isomorphic object structures?
    			-- (from ANY)
    		ensure -- from ANY
    			shallow_implies_deep: standard_equal (some, other) implies Result
    			both_or_none_void: (some = Void) implies (Result = (other = Void))
    			same_type: (Result and (some /= Void)) implies some.same_type (other)
    			symmetric: Result implies deep_equal (other, some)

    	frozen equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void or attached
    			-- to objects considered equal?
    			-- (from ANY)
    		ensure -- from ANY
    			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

    	is_equal (other: like Current): 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.is_equal (Current)
    			consistent: standard_is_equal (other) implies Result

    	frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' 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
    			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

    	frozen standard_is_equal (other: like Current): 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

    	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: like Current)
    			-- 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: is_equal (other)

    	frozen deep_copy (other: like Current)
    			-- 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: like Current
    			-- New object structure recursively duplicated from Current.
    			-- (from ANY)
    		ensure -- from ANY
    			deep_equal: deep_equal (Current, Result)

    	frozen standard_copy (other: like Current)
    			-- 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: like Current
    			-- 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: like Current
    			-- New object equal to `Current'
    			-- twin calls copy; to change copying/twining semantics, redefine copy.
    			-- (from ANY)
    		ensure -- from ANY
    			twin_not_void: Result /= Void
    			is_equal: Result.is_equal (Current)

    feature -- Basic operations

    	frozen default: like Current
    			-- 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)

    	default_rescue
    			-- Process exception for routines with no Rescue clause.
    			-- (Default: do nothing.)
    			-- (from ANY)

    	frozen do_nothing
    			-- Execute a null action.
    			-- (from ANY)

    feature -- Event handling

    	column_deselect_actions: ACTION_SEQUENCE [TUPLE [EV_GRID_COLUMN]]
    			-- Actions to be performed when a column is deselected.
    		ensure
    			result_not_void: Result /= Void

    	column_select_actions: ACTION_SEQUENCE [TUPLE [EV_GRID_COLUMN]]
    			-- Actions to be performed when a column is selected.
    		ensure
    			result_not_void: Result /= Void

    	fill_background_actions: ACTION_SEQUENCE [TUPLE [EV_DRAWABLE, INTEGER_32, INTEGER_32, INTEGER_32, INTEGER_32]]
    			-- Actions to be performed when part of the background area of the grid that is outside of the
    			-- area filled by `row_count' and `column_count' needs to be redrawn.
    			-- By default, the grid fills the area in its `background_color'. If one or more agents are
    			-- contained in this action sequence, the grid is no longer responsible for drawing its background
    			-- and the agents must redraw this area, otherwise graphical glitches may appear.
    			-- The five pieces of event data passed are:
    			-- drawable: EV_DRAWABLE The drawable into which you must draw the background.
    			-- virtual_x: INTEGER The virtual x position of the area to be redrawn.
    			-- virtual_y: INTEGER The virtual y position of the area to be redrawn.
    			-- width: INTEGER The width of the area that must be redrawn.
    			-- height: INTEGER The height of the area that must be redrawn.
    			-- The upper left corner of the drawing must start at 0x0 in `drawable' with an area given by `width'
    			-- and `height'. The virtual coordinates specify the position of the area in relation to the grid's
    			-- virtual positiion which is essential if you wish to draw something such as a texture which must be
    			-- matched based on its position.
    			-- Note that fill_background_actions may be fired multiple times to fill the complete area of the
    			-- background that is invalid.
    		ensure
    			not_void: Result /= Void

    	item_activate_actions: ACTION_SEQUENCE [TUPLE [EV_GRID_ITEM, EV_POPUP_WINDOW]]
    			-- Actions to be performed to setup an item that is currently activated.
    			-- Overrides default setup of activatable items.
    			-- Arguments of TUPLE (with names for clarity):
    			--
    			-- activate_item: EV_GRID_ITEM -- The item that is currently activated.
    			-- popup_window: EV_WINDOW -- The popup window used to interactively edit `activate_item', window has already been sized and positioned.

    	item_deactivate_actions: EV_GRID_ITEM_ACTION_SEQUENCE
    			-- Actions to be performed when an item is deactivated.
    		ensure
    			result_not_void: Result /= Void

    	item_deselect_actions: EV_GRID_ITEM_ACTION_SEQUENCE
    			-- Actions to be performed when an item is deselected.
    		ensure
    			result_not_void: Result /= Void

    	item_drop_actions: ACTION_SEQUENCE [TUPLE [EV_GRID_ITEM, ANY]]
    			-- Actions to be performed when a pebble is dropped here.
    		ensure
    			not_void: Result /= Void

    	item_select_actions: EV_GRID_ITEM_ACTION_SEQUENCE
    			-- Actions to be performed when an item is selected.
    		ensure
    			result_not_void: Result /= Void

    	pointer_button_press_item_actions: ACTION_SEQUENCE [TUPLE [INTEGER_32, INTEGER_32, INTEGER_32, EV_GRID_ITEM]]
    			-- Actions to be performed when a pointer press event is received by a grid.
    			-- Arguments (with names for clarity):
    			--
    			-- x_pos: INTEGER -- The x position of the press in grid virtual coordinates.
    			-- y_pos: INTEGER -- The y position of the press in grid virtual coordinates.
    			-- a_button: INTEGER -- The index of the pressed button.
    			-- item: EV_GRID_ITEM -- If the press occurred above an item, this is the pointed item, otherwise argument is set to `Void'.
    		ensure
    			result_not_void: Result /= Void

    	pointer_button_release_item_actions: ACTION_SEQUENCE [TUPLE [INTEGER_32, INTEGER_32, INTEGER_32, EV_GRID_ITEM]]
    			-- Actions to be performed when a pointer release event is received by a grid.
    			-- Arguments (with names for clarity):
    			--
    			-- x_pos: INTEGER -- The x position of the release in grid virtual coordinates.
    			-- y_pos: INTEGER -- The y position of the release in grid virtual coordinates.
    			-- a_button: INTEGER -- The index of the released button.
    			-- item: EV_GRID_ITEM -- If the release occurred above an item, this is the pointed item, otherwise argument is set to `Void'.
    		ensure
    			result_not_void: Result /= Void

    	pointer_double_press_item_actions: ACTION_SEQUENCE [TUPLE [INTEGER_32, INTEGER_32, INTEGER_32, EV_GRID_ITEM]]
    			-- Actions to be performed when a pointer double press event is received by a grid.
    			-- Arguments (with names for clarity):
    			--
    			-- x_pos: INTEGER -- The x position of the double press in grid virtual coordinates.
    			-- y_pos: INTEGER -- The y position of the double press in grid virtual coordinates.
    			-- a_button: INTEGER -- The index of the pressed button.
    			-- item: EV_GRID_ITEM -- If the double press occurred above an item, this is the pointed item, otherwise argument is set to `Void'.
    		ensure
    			result_not_void: Result /= Void

    	pointer_enter_item_actions: ACTION_SEQUENCE [TUPLE [BOOLEAN, EV_GRID_ITEM]]
    			-- Actions to be performed when a pointer enter event is received by a grid or grid item
    			-- Arguments (with names for clarity):
    			--
    			-- on_grid: BOOLEAN -- Did the enter event occur for the grid?
    			-- item: EV_GRID_ITEM -- If the enter event occurred for an item, this is the item.
    			--
    			-- Note that `on_grid' may be set to `True' and `item' may be non-Void
    			-- in the case where the pointer enters a grid at a location where there
    			-- is an item contained.
    		ensure
    			result_not_void: Result /= Void

    	pointer_leave_item_actions: ACTION_SEQUENCE [TUPLE [BOOLEAN, EV_GRID_ITEM]]
    			-- Actions to be performed when a pointer leave event is received by a grid or grid item
    			-- Arguments (with names for clarity):
    			--
    			-- on_grid: BOOLEAN -- Did the leave event occur for the grid?
    			-- item: EV_GRID_ITEM -- If the leave event occurred for an item, this is the item.
    			--
    			-- Note that `on_grid' may be set to `True' and `item' may be non-Void
    			-- in the case where the pointer leaves a grid from a location where there.
    		ensure
    			result_not_void: Result /= Void

    	pointer_motion_item_actions: ACTION_SEQUENCE [TUPLE [INTEGER_32, INTEGER_32, EV_GRID_ITEM]]
    			-- Actions to be performed when a screen pointer moves over a grid.
    			-- Arguments (with names for clarity):
    			--
    			-- x_pos: INTEGER -- The x position of the motion in grid virtual coordinates.
    			-- y_pos: INTEGER -- The y position of the motion in grid virtual coordinates.
    			-- item: EV_GRID_ITEM -- If the motion occurred above an item, this is the pointed item, otherwise argument is set to `Void'.
    		ensure
    			result_not_void: Result /= Void

    	post_draw_overlay_actions: ACTION_SEQUENCE [TUPLE [EV_DRAWABLE, EV_GRID_ITEM, INTEGER_32, INTEGER_32]]
    			-- Actions to be performed after an item cell in `Current'  has been drawn. The four pieces of event data are:
    			-- drawable: EV_DRAWABLE The drawable into which you may draw to overlay onto the already drawn item.
    			-- grid_item: EV_GRID_ITEM The item which has just been drawn, may be Void in the case that an
    			-- item cell is being drawn which does not contain an item.
    			-- a_column_index: INTEGER The column index of the grid cell that has just been drawn.
    			-- a_row_index: INTEGER The row index of the grid cell that has just been drawn.
    			-- This is useful for drawing additional border styles or other such effects. The upper left corner
    			-- of the item cell starts at coordinates 0x0 in the passed drawable. All drawing Performed
    			-- in the drawable is clipped to `width' of the column at `a_column_index' and `height' of row at `a_row_index'.
    			-- Note that the upper left corner of `drawable' corresponds to the upper left corner of the item
    			-- cell and not the actual items horizontal position within the cell which may be greater than 0 if
    			-- the item is within a tree structure. Use `horizontal_indent' of the item to determine this.
    		ensure
    			not_void: Result /= Void

    	pre_draw_overlay_actions: ACTION_SEQUENCE [TUPLE [EV_DRAWABLE, EV_GRID_ITEM, INTEGER_32, INTEGER_32]]
    			-- Actions to be performed before the features of an item cell in `Current' have been drawn but after the background of
    			-- the cell has been drawn. The four pieces of event data are:
    			-- drawable: EV_DRAWABLE The drawable into which you may draw to overlay onto the already drawn background.
    			-- grid_item: EV_GRID_ITEM The item which has just been drawn, may be Void in the case that an
    			-- item cell is being drawn which does not contain an item.
    			-- a_column_index: INTEGER The column index of the grid cell that has just been drawn.
    			-- a_row_index: INTEGER The row index of the grid cell that has just been drawn.
    			-- This is useful for drawing additional border styles or other such effects. The upper left corner
    			-- of the item cell starts at coordinates 0x0 in the passed drawable. All drawing Performed
    			-- in the drawable is clipped to `width' of the column at `a_column_index' and `height' of row at `a_row_index'.
    			-- Note that the upper left corner of `drawable' corresponds to the upper left corner of the item
    			-- cell and not the actual items horizontal position within the cell which may be greater than 0 if
    			-- the item is within a tree structure. Use `horizontal_indent' of the item to determine this.
    		ensure
    			not_void: Result /= Void

    	row_collapse_actions: EV_GRID_ROW_ACTION_SEQUENCE
    			-- Actions to be performed when a row is collapsed.
    		ensure
    			result_not_void: Result /= Void

    	row_deselect_actions: EV_GRID_ROW_ACTION_SEQUENCE
    			-- Actions to be performed when a row is deselected.
    		ensure
    			result_not_void: Result /= Void

    	row_expand_actions: EV_GRID_ROW_ACTION_SEQUENCE
    			-- Actions to be performed when a row is expanded.
    		ensure
    			result_not_void: Result /= Void

    	row_select_actions: EV_GRID_ROW_ACTION_SEQUENCE
    			-- Actions to be performed when a row is selected.
    		ensure
    			result_not_void: Result /= Void

    	virtual_position_changed_actions: ACTION_SEQUENCE [TUPLE [INTEGER_32, INTEGER_32]]
    			-- Actions to be performed upon next idle after `virtual_x_position' or `virtual_y_position' changed in grid.
    			-- Arguments (with names for clarity)
    			--
    			-- a_virtual_x_position: INTEGER -- New `virtual_x_position' of grid.
    			-- a_virtual_y_position: INTEGER -- New `virtual_y_position' of grid.

    	virtual_size_changed_actions: ACTION_SEQUENCE [TUPLE [INTEGER_32, INTEGER_32]]
    			-- Actions to be performed upon next idle after `virtual_width' or `virtual_height' changed in grid.
    			-- Arguments (with names for clarity)
    			--
    			-- a_virtual_width: INTEGER -- New `virtual_width' of grid.
    			-- a_virtual_height: INTEGER -- New `virtual_height' of grid.

    feature -- Markers

    	fixme (comment: STRING_8)
    			-- Mark code that has to be "fixed" with `comment'.
    			-- (from REFACTORING_HELPER)
    		require -- from REFACTORING_HELPER
    			comment_not_void: comment /= Void

    	to_implement (comment: STRING_8)
    			-- Mark code that has to be "implemented" with `comment'.
    			-- (from REFACTORING_HELPER)
    		require -- from REFACTORING_HELPER
    			comment_not_void: comment /= Void

    	to_implement_assertion (comment: STRING_8): BOOLEAN
    			-- Mark assertion that has to be "implemented" with `comment'.
    			-- (from REFACTORING_HELPER)
    		require -- from REFACTORING_HELPER
    			comment_not_void: comment /= Void

    feature -- Output

    	io: STD_FILES
    			-- Handle to standard file setup
    			-- (from ANY)

    	out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of tagged_out.
    			-- (from ANY)

    	print (some: ANY)
    			-- Write terse external representation of `some'
    			-- on standard output.
    			-- (from ANY)

    	frozen tagged_out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of out.
    			-- (from ANY)

    feature -- Platform

    	operating_environment: OPERATING_ENVIRONMENT
    			-- Objects available from the operating system
    			-- (from ANY)

    invariant
    		-- from ANY
    	reflexive_equality: standard_is_equal (Current)
    	reflexive_conformance: conforms_to (Current)

    indexing
    	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_GRID_ACTION_SEQUENCES_I