    indexing
    	description: "Eiffel Vision tool bar separator. Implementation interface."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
    	revision: "$Revision: 56675 $"

    deferred class interface
    	EV_TOOL_BAR_SEPARATOR_I

    feature -- Access

    	accept_cursor: EV_POINTER_STYLE
    			-- Accept cursor set by user.
    			-- To be displayed when the screen pointer is over a target that accepts
    			-- pebble during pick and drop.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	deny_cursor: EV_POINTER_STYLE
    			-- Deny cursor set by user.
    			-- To be displayed when the screen pointer is not over a valid target.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	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)

    	parent: EV_ITEM_LIST [EV_ITEM]
    			-- Item list containing `Current'.
    			-- (from EV_ITEM_I)

    	parent_imp: EV_ITEM_LIST_I [EV_ITEM]
    			-- The parent of the Current widget
    			-- Can be void.
    			-- (from EV_ITEM_I)

    	pebble: ANY
    			-- Data to be transported by pick and drop mechanism.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	pebble_function: FUNCTION [ANY, TUPLE, ANY]
    			-- Returns data to be transported by pick and drop mechanism.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	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_I)

    	pebble_x_position: INTEGER_32
    			-- Initial x position for pick and drop relative to `Current'.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	pebble_y_position: INTEGER_32
    			-- Initial y position for pick and drop relative to `Current'.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	pixmap: EV_PIXMAP
    			-- Image displayed on `Current'.
    			-- (from EV_PIXMAPABLE_I)

    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

    	is_transport_enabled: BOOLEAN
    			-- Is the transport mechanism enabled?
    			-- (from EV_PICK_AND_DROPABLE_I)

    	mode_is_drag_and_drop: BOOLEAN
    			-- Is the transport mechanism drag and drop?
    			-- (from EV_PICK_AND_DROPABLE_I)

    	mode_is_pick_and_drop: BOOLEAN
    			-- Is the transport mechanism pick and drop?
    			-- (from EV_PICK_AND_DROPABLE_I)

    	mode_is_target_menu: BOOLEAN
    			-- Is the transport mechanism target menu?
    			-- (from EV_PICK_AND_DROPABLE_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

    	disable_pebble_positioning
    			-- Assign `False' to pebble_positioning_enabled.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	disable_transport
    			-- Deactivate pick/drag and drop mechanism.
    			-- (from EV_PICK_AND_DROPABLE_I)
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			is_transport_disabled: not is_transport_enabled

    	enable_pebble_positioning
    			-- Assign `True' to pebble_positioning_enabled.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	enable_transport
    			-- Activate pick/drag and drop mechanism.
    			-- (from EV_PICK_AND_DROPABLE_I)
    		require -- from EV_PICK_AND_DROPABLE_I
    			pebble_not_void: pebble /= Void or pebble_function /= Void
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			is_transport_enabled: interface.implementation.is_transport_enabled

    	remove_pebble
    			-- Remove pebble.
    			-- (from EV_PICK_AND_DROPABLE_I)
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			pebble_removed: pebble = Void and pebble_function = Void
    			is_transport_disabled: not is_transport_enabled

    	set_accept_cursor (a_cursor: like accept_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_I)

    	set_deny_cursor (a_cursor: like deny_cursor)
    			-- Set `a_cursor' to be displayed when the screen pointer is over a
    			-- target that doesn't accept pebble during pick and drop.
    			-- (from EV_PICK_AND_DROPABLE_I)

    	set_drag_and_drop_mode
    			-- Set transport mechanism to drag and drop,
    			-- (from EV_PICK_AND_DROPABLE_I)
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			mode_is_drag_and_drop: mode_is_drag_and_drop

    	set_pebble (a_pebble: like pebble)
    			-- Assign `a_pebble' to pebble.
    			-- (from EV_PICK_AND_DROPABLE_I)
    		require -- from EV_PICK_AND_DROPABLE_I
    			a_pebble_not_void: a_pebble /= Void
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			pebble_assigned: interface.implementation.pebble = a_pebble
    			is_transport_enabled: interface.implementation.is_transport_enabled

    	set_pebble_function (a_function: FUNCTION [ANY, TUPLE, ANY])
    			-- Assign `a_function' to pebble_function.
    			-- (from EV_PICK_AND_DROPABLE_I)
    		require -- from EV_PICK_AND_DROPABLE_I
    			a_function_not_void: a_function /= Void
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			pebble_function_assigned: interface.implementation.pebble_function = a_function
    			is_transport_enabled: interface.implementation.is_transport_enabled

    	set_pebble_position (a_x, a_y: INTEGER_32)
    			-- Set the initial position for pick and drop relative to `Current'.
    			-- (from EV_PICK_AND_DROPABLE_I)
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			pick_x_assigned: pick_x = a_x
    			pick_y_assigned: pick_y = a_y

    	set_pick_and_drop_mode
    			-- Set transport mechanism to pick and drop,
    			-- (from EV_PICK_AND_DROPABLE_I)
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			mode_is_pick_and_drop: mode_is_pick_and_drop

    	set_target_menu_mode
    			-- Set transport mechanism to target_menu.
    			-- (from EV_PICK_AND_DROPABLE_I)
    		ensure -- from EV_PICK_AND_DROPABLE_I
    			mode_is_target_menu: mode_is_target_menu

    feature -- Element change

    	pixmap_equal_to (a_pixmap: EV_PIXMAP): BOOLEAN
    			-- Is `a_pixmap' equal to pixmap?
    			-- (from EV_PIXMAPABLE_I)

    	remove_pixmap
    			-- Make pixmap `Void'.
    			-- (from EV_PIXMAPABLE_I)
    		ensure -- from EV_PIXMAPABLE_I
    			pixmap_removed: pixmap = Void

    	set_pixmap (a_pixmap: EV_PIXMAP)
    			-- Assign `a_pixmap' to pixmap.
    			-- (from EV_PIXMAPABLE_I)
    		require -- from EV_PIXMAPABLE_I
    			pixmap_not_void: a_pixmap /= Void

    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 -- Access EV_DRAGABLE_SOURCE.

    	dockable_dialog_target: EV_DOCKABLE_DIALOG
    			-- A dockable dialog that will be created as
    			-- necessary. This is not a local, to avoid it
    			-- being garbage collected.
    			-- (from EV_SHARED_TRANSPORT_I)

    	global_drag_targets: ARRAYED_LIST [INTEGER_32]
    			-- Shortcut to EV_APPLICATION.pnd_targets.
    			-- (from EV_SHARED_TRANSPORT_I)

    	insert_label: EV_CELL
    			-- Label used to indicate where `Current' will be placed in target.
    			-- (from EV_SHARED_TRANSPORT_I)
    		ensure -- from EV_SHARED_TRANSPORT_I
    			result_not_void: Result /= Void

    	insert_label_imp: EV_CELL_I
    			-- Once access to implementation of Insert_label.
    			-- (from EV_SHARED_TRANSPORT_I)
    		ensure -- from EV_SHARED_TRANSPORT_I
    			Result /= Void

    	insert_sep: EV_TOOL_BAR_SEPARATOR
    			-- Once access to a separator used to indicate the insertion position
    			-- when moving tool bar items.
    			-- (from EV_SHARED_TRANSPORT_I)

    	insert_sep_imp: EV_TOOL_BAR_SEPARATOR_I
    			-- Once access to implementation of Insert_sep.
    			-- (from EV_SHARED_TRANSPORT_I)
    		ensure -- from EV_SHARED_TRANSPORT_I
    			Result /= Void

    	internal_screen: EV_SCREEN
    			-- Once access to an EV_SCREEN.
    			-- (from EV_SHARED_TRANSPORT_I)

    	original_x_offset: INTEGER_16
    			-- Original x_offset and original_y_offset of transport
    			-- realtive to widget. Only used for dragable transports.
    			-- (from EV_SHARED_TRANSPORT_I)

    	original_y_offset: INTEGER_16
    			-- Original x_offset and original_y_offset of transport
    			-- realtive to widget. Only used for dragable transports.
    			-- (from EV_SHARED_TRANSPORT_I)

    	originating_source: EV_DOCKABLE_SOURCE_I
    			-- Dragable source that originated the transport of `source_being_dragged'.
    			-- (from EV_SHARED_TRANSPORT_I)

    	remove_insert_label
    			-- Remove Insert_label from its current parent.
    			-- We must handle a special case for cells. If the parent is a cell,
    			-- then we remove the cell from its parent, and then restore it.
    			-- Otherwise, when the label, removed, the cell keeps it size, and cells
    			-- are normally used with `real_target' when the cell must
    			-- not be visible.
    			-- (from EV_SHARED_TRANSPORT_I)
    		ensure -- from EV_SHARED_TRANSPORT_I
    			not_parented: insert_label.parent = Void

    	remove_insert_sep
    			-- Ensure `inset_sep' is not parented.
    			-- (from EV_SHARED_TRANSPORT_I)
    		ensure -- from EV_SHARED_TRANSPORT_I
    			not_parented: insert_sep.parent = Void

    	source_being_docked: EV_DOCKABLE_SOURCE_I
    			-- Dragable source currently being transported. May be a
    			-- WIDGET_IMP or an EV_TOOL_BAR_BUTTON_IMP.
    			-- (from EV_SHARED_TRANSPORT_I)

    feature -- Access EV_PICK_AND_DROPABLE.

    	default_accept_cursor: EV_POINTER_STYLE
    			-- Used in lieu of a user defined accept_cursor.
    			-- (from EV_SHARED_TRANSPORT_I)

    	default_deny_cursor: EV_POINTER_STYLE
    			-- Used in lieu of a user defined deny_cursor.
    			-- (from EV_SHARED_TRANSPORT_I)

    	default_pixmaps: EV_STOCK_PIXMAPS
    			-- Default pixmaps
    			-- (from EV_SHARED_TRANSPORT_I)

    	global_pnd_targets: HASH_TABLE [INTEGER_32, INTEGER_32]
    			-- Shortcut to EV_APPLICATION.pnd_targets.
    			-- (from EV_SHARED_TRANSPORT_I)

    	rubber_band_is_drawn: BOOLEAN
    			-- Is a rubber band line currently on the screen?
    			-- (from EV_SHARED_TRANSPORT_I)

    feature -- Access common.

    	pointer_x: INTEGER_16
    			-- (from EV_SHARED_TRANSPORT_I)

    	pointer_y: INTEGER_16
    			-- (from EV_SHARED_TRANSPORT_I)

    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_I)
    		ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I
    			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_I)
    		ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I
    			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_I)
    		ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I
    			not_void: Result /= Void

    	pick_ended_actions: EV_PND_FINISHED_ACTION_SEQUENCE
    			-- Actions to be performed when a transport from `Current' ends.
    			-- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I)
    		ensure -- from EV_PICK_AND_DROPABLE_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_ITEM_ACTION_SEQUENCES_I)
    		ensure -- from EV_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_ITEM_ACTION_SEQUENCES_I)
    		ensure -- from EV_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_ITEM_ACTION_SEQUENCES_I)
    		ensure -- from EV_ITEM_ACTION_SEQUENCES_I
    			not_void: Result /= 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 EV_PICK_AND_DROPABLE_I
    	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
    	pebble_function_takes_two_integer_open_operands: pebble_function /= Void implies pebble_function.valid_operands ([1, 1])

    		-- from EV_ANY_I
    	interface_coupled: is_usable implies interface /= Void and then interface.implementation = Current
    	base_make_called: base_make_called

    		-- 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_TOOL_BAR_SEPARATOR_I