indexing
	description: "Base class for all items that may be held in EV_ITEM_LISTs."
	status: "See notice at end of class."
	keywords: "item"
	date: "$Date$"
	revision: "$Revision$"

deferred class interface
	EV_ITEM

feature -- Initialization

	frozen default_create
			-- Standard creation procedure.
			-- (from EV_ANY)
		ensure then -- from EV_ANY
			is_coupled: implementation /= void
			is_initialized: is_initialized
			default_create_called_set: default_create_called
			is_in_default_state: is_in_default_state
	
feature -- Access

	accept_cursor: EV_CURSOR
			-- Result is cursor displayed when the screen pointer is over a
			-- target that accepts pebble during pick and drop.
			-- (from EV_PICK_AND_DROPABLE)
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.accept_cursor

	data: ANY
			-- Arbitrary user data may be stored here.
			-- (from EV_ANY)

	deny_cursor: EV_CURSOR
			-- Result is cursor displayed when the screen pointer is over a
			-- target that does not accept pebble during pick and drop.
			-- (from EV_PICK_AND_DROPABLE)
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.deny_cursor

	frozen id_object (an_id: INTEGER): IDENTIFIED
			-- Object associated with an_id (void if no such object)
			-- (from IDENTIFIED)
		ensure -- from IDENTIFIED
			consistent: Result = void or else Result.object_id = an_id

	frozen object_id: INTEGER
			-- Unique for current object in any given session
			-- (from IDENTIFIED)
		ensure -- from IDENTIFIED
			valid_id: id_object (Result) = Current

	parent: EV_ITEM_LIST [EV_ITEM]
			-- Item list containing Current.
		require -- from EV_CONTAINABLE
			not_destroyed: not is_destroyed
		ensure then
			bridge_ok: Result = implementation.parent

	pebble: ANY
			-- Data to be transported by pick and drop mechanism.
			-- (from EV_PICK_AND_DROPABLE)
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.pebble

	pebble_function: FUNCTION [ANY, TUPLE, ANY]
			-- Returns data to be transported by pick and drop mechanism.
			-- (from EV_PICK_AND_DROPABLE)
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.pebble_function

	pebble_positioning_enabled: BOOLEAN
			-- If True then pick and drop start coordinates are
			-- pebble_x_position, pebble_y_position.
			-- If False then pick and drop start coordinates are
			-- the pointer coordinates.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.pebble_positioning_enabled

	pebble_x_position: INTEGER
			-- Initial x position for pick and drop relative to Current.
			-- (from EV_PICK_AND_DROPABLE)
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.pebble_x_position

	pebble_y_position: INTEGER
			-- Initial y position for pick and drop relative to Current.
			-- (from EV_PICK_AND_DROPABLE)
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.pebble_y_position

	pixmap: EV_PIXMAP
			-- Image displayed on Current.
			-- (from EV_PIXMAPABLE)
		require -- from EV_PIXMAPABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_PIXMAPABLE
			bridge_ok: (Result = void and implementation.pixmap = void) or Result.is_equal (implementation.pixmap)

	target_name: STRING
			-- Optional textual name describing Current pick and drop hole.
			-- (from EV_ABSTRACT_PICK_AND_DROPABLE)
	
feature -- Status report

	mode_is_drag_and_drop: BOOLEAN
			-- Is the user interface mode drag and drop?
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.mode_is_drag_and_drop

	mode_is_pick_and_drop: BOOLEAN
			-- Is the user interface mode pick and drop?
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.mode_is_pick_and_drop

	mode_is_target_menu: BOOLEAN
			-- Is the user interface mode a pop-up menu of targets?
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure then -- from EV_PICK_AND_DROPABLE
			bridge_ok: Result = implementation.mode_is_target_menu
	
feature -- Status setting

	disable_pebble_positioning
			-- Assign False to pebble_positioning_enabled.
			-- The pick and drop will start at the pointer position.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_PICK_AND_DROPABLE
			pebble_positioning_updated: not pebble_positioning_enabled

	enable_pebble_positioning
			-- Assign True to pebble_positioning_enabled.
			-- Use pebble_x_position and pebble_y_position as the initial coordinates
			-- for the pick and drop in pixels relative to Current.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_PICK_AND_DROPABLE
			pebble_positioning_updated: pebble_positioning_enabled

	remove_pebble
			-- Make pebble Void and pebble_function `Void,
			-- Removing transport.
			-- (from EV_PICK_AND_DROPABLE)
		ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE
			pebble_removed: pebble = void and pebble_function = void

	set_accept_cursor (a_cursor: EV_CURSOR)
			-- Set a_cursor to be displayed when the screen pointer is over a
			-- target that accepts pebble during pick and drop.
			-- (from EV_PICK_AND_DROPABLE)
		ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE
			accept_cursor_assigned: accept_cursor.is_equal (a_cursor)

	set_deny_cursor (a_cursor: EV_CURSOR)
			-- Set a_cursor to be displayed when the screen pointer is not
			-- over a valid target.
			-- (from EV_PICK_AND_DROPABLE)
		ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE
			deny_cursor_assigned: deny_cursor.is_equal (a_cursor)

	set_drag_and_drop_mode
			-- Set user interface mode to drag and drop.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_PICK_AND_DROPABLE
			drag_and_drop_set: mode_is_drag_and_drop

	set_pebble (a_pebble: like pebble)
			-- Assign a_pebble to pebble.
			-- Overrides set_pebble_function.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_ABSTRACT_PICK_AND_DROPABLE
			a_pebble_not_void: a_pebble /= void
		ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE
			pebble_assigned: pebble = a_pebble

	set_pebble_function (a_function: FUNCTION [ANY, TUPLE, ANY])
			-- Set a_function to compute pebble.
			-- It will be called once each time a pick occurs, the result
			-- will be assigned to pebble for the duration of transport.
			-- When a pick occurs, the pick position in widget coordinates,
			-- <<x, y>> in pixels, is passed.
			-- To handle this data use a_function of type
			-- FUNCTION [ANY, TUPLE [INTEGER, INTEGER], ANY] and return the
			-- pebble as a function of x and y.
			-- Overrides set_pebble.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_ABSTRACT_PICK_AND_DROPABLE
			a_function_not_void: a_function /= void
			a_function_takes_two_integer_open_operands: a_function.valid_operands ([1, 1])
		ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE
			pebble_function_assigned: pebble_function = a_function

	set_pebble_position (a_x, a_y: INTEGER)
			-- Set the initial position for pick and drop
			-- Coordinates are in pixels and are relative to position of Current.
			-- Pebble_positioning_enabled must be True for the position to be used,
			-- use enable_pebble_positioning.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_PICK_AND_DROPABLE
			pebble_position_assigned: pebble_x_position = a_x and pebble_y_position = a_y

	set_pick_and_drop_mode
			-- Set user interface mode to pick and drop.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_PICK_AND_DROPABLE
			pick_and_drop_set: mode_is_pick_and_drop

	set_target_menu_mode
			-- Set user interface mode to pop-up menu of targets.
			-- (from EV_PICK_AND_DROPABLE)
		require -- from EV_PICK_AND_DROPABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_PICK_AND_DROPABLE
			target_menu_mode_set: mode_is_target_menu

	set_target_name (a_name: STRING)
			-- Assign a_name to target_name.
			-- (from EV_ABSTRACT_PICK_AND_DROPABLE)
		require -- from EV_ABSTRACT_PICK_AND_DROPABLE
			a_name_not_void: a_name /= void
		ensure -- from EV_ABSTRACT_PICK_AND_DROPABLE
			target_name_assigned: a_name /= target_name and a_name.is_equal (target_name)
	
feature -- Element change

	remove_pixmap
			-- Make pixmap Void.
			-- (from EV_PIXMAPABLE)
		require -- from EV_PIXMAPABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_PIXMAPABLE
			pixmap_removed: pixmap = void

	set_data (some_data: like data)
			-- Assign some_data to data.
			-- (from EV_ANY)
		require -- from EV_ANY
			not_destroyed: not is_destroyed
		ensure -- from EV_ANY
			data_assigned: data = some_data

	set_pixmap (a_pixmap: EV_PIXMAP)
			-- Assign a_pixmap to pixmap.
			-- (from EV_PIXMAPABLE)
		require -- from EV_PIXMAPABLE
			not_destroyed: not is_destroyed
			pixmap_not_void: a_pixmap /= void
		ensure -- from EV_PIXMAPABLE
			pixmap_assigned: a_pixmap.is_equal (pixmap) and pixmap /= a_pixmap
	
feature -- Duplication

	copy (other: like Current)
			-- Update current object using fields of object attached
			-- to other, so as to yield equal objects.
			-- (from EV_ANY)
		require -- from ANY
			other_not_void: other /= void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)
	
feature -- Command

	destroy
			-- Destroy underlying native toolkit object.
			-- Render Current unusable.
			-- (from EV_ANY)
		ensure -- from EV_ANY
			is_destroyed: is_destroyed
	
feature -- Event handling

	conforming_pick_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Actions to be performed when a pebble that fits here is picked.
			-- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES)
		ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
			not_void: Result /= void

	drop_actions: EV_PND_ACTION_SEQUENCE
			-- Actions to be performed when a pebble is dropped here.
			-- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES)
		ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
			not_void: Result /= void

	pick_actions: EV_PND_START_ACTION_SEQUENCE
			-- Actions to be performed when pebble is picked up.
			-- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES)
		ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
			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_ITEM_ACTION_SEQUENCES)
		ensure -- from EV_ITEM_ACTION_SEQUENCES
			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_ITEM_ACTION_SEQUENCES)
		ensure -- from EV_ITEM_ACTION_SEQUENCES
			not_void: Result /= void

	pointer_motion_actions: EV_POINTER_MOTION_ACTION_SEQUENCE
			-- Actions to be performed when screen pointer moves.
			-- (from EV_ITEM_ACTION_SEQUENCES)
		ensure -- from EV_ITEM_ACTION_SEQUENCES
			not_void: Result /= void
	
feature -- Status Report

	is_destroyed: BOOLEAN
			-- Is Current no longer usable?
			-- (from EV_ANY)
		ensure -- from EV_ANY
			bridge_ok: Result = implementation.is_destroyed
	
invariant

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)
		-- from EV_PICK_AND_DROPABLE
	user_interface_modes_mutually_exclusive: mode_is_pick_and_drop.to_integer + mode_is_drag_and_drop.to_integer + mode_is_target_menu.to_integer = 1
		-- from EV_ANY
	is_initialized: is_initialized
	is_coupled: implementation /= void and then implementation.interface = Current
	default_create_called: default_create_called

end -- class EV_ITEM