    indexing
    	description: "Windows implementation of dockable source."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	date: "$Date: 2006-07-13 17:55:37 -0700 (Thu, 13 Jul 2006) $"
    	revision: "$Revision: 61322 $"

    deferred class interface
    	EV_DOCKABLE_SOURCE_IMP

    feature -- Access

    	awaiting_movement: BOOLEAN
    			-- Are we currently awaiting the movement threshold to
    			-- be reached for as drag and drop or dockable move?
    			-- (from EV_SHARED_TRANSPORT_IMP)

    	drag_and_drop_starting_movement: INTEGER_32 is 3
    			-- Pointer movement in pixels required to start a drag and drop.
    			-- (from EV_SHARED_TRANSPORT_IMP)

    	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)

    	is_dock_executing: BOOLEAN
    			-- Is `Current' in the process of a dockable transport?
    			-- (from EV_DOCKABLE_SOURCE_I)

    	is_dockable: BOOLEAN
    			-- Is `Current' dockable?
    			-- (from EV_DOCKABLE_SOURCE_I)

    	is_external_docking_enabled: BOOLEAN
    			-- Is `Current' able to be docked into an EV_DOCKABLE_DIALOG
    			-- When there is no valid EV_DRAGABLE_TARGET upon completion
    			-- of the transport?
    			-- (from EV_DOCKABLE_SOURCE_I)

    	is_external_docking_relative: BOOLEAN
    			-- Will dockable dialog displayed when `Current' is docked externally
    			-- be displayed relative to parent window of `Current'?
    			-- Otherwise displayed as a standard window.
    			-- (from EV_DOCKABLE_SOURCE_I)

    	not_external_docking_enabled: BOOLEAN
    			-- Attribute used for `is_externally_dockable'. We must implement
    			-- `is_externally_dockable' this way as we have no easy solution to
    			-- assign `True' to `is_externally_dockable'.
    			-- (from EV_DOCKABLE_SOURCE_I)

    	not_is_external_docking_relative: BOOLEAN
    			-- Will dockable dialog displayed when `Current' is docked externally
    			-- be displayed relative to parent window of `Current'?
    			-- Otherwise displayed as a standard window.
    			-- Internal reversed value of is_external_docking_relative as we cannot
    			-- easily initialize a BOOLE to True in this case.
    			-- (from EV_DOCKABLE_SOURCE_I)

    	original_parent_position: INTEGER_32
    			-- Original position in parent. Required
    			-- to restore widget later.
    			-- (from EV_DOCKABLE_SOURCE_I)

    	original_pressure: REAL_64
    			-- Hold the values passed to start transport so when a transport
    			-- actually starts, with real_start_transport,these can be passed
    			-- as arguments.
    			-- (from EV_SHARED_TRANSPORT_IMP)

    	original_x: INTEGER_32
    			-- (from EV_SHARED_TRANSPORT_IMP)

    	original_x_tilt: REAL_64
    			-- Hold the values passed to start transport so when a transport
    			-- actually starts, with real_start_transport,these can be passed
    			-- as arguments.
    			-- (from EV_SHARED_TRANSPORT_IMP)

    	original_y: INTEGER_32
    			-- (from EV_SHARED_TRANSPORT_IMP)

    	original_y_tilt: REAL_64
    			-- Hold the values passed to start transport so when a transport
    			-- actually starts, with real_start_transport,these can be passed
    			-- as arguments.
    			-- (from EV_SHARED_TRANSPORT_IMP)

    	real_source: EV_DOCKABLE_SOURCE
    			-- `Result' is EV_DOCKABLE_SOURCE which should be
    			-- dragged when docking begins on `Current'.
    			-- (from EV_DOCKABLE_SOURCE_I)

    	widget_imp_at_pointer_position: EV_WIDGET_IMP
    			-- `Result' is implementation of widget at current
    			-- pointer position or Void if none.
    			-- (from EV_SHARED_TRANSPORT_IMP)
    		require -- from  EV_DOCKABLE_SOURCE_I
    			True

    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

    	closest_dockable_target: EV_DOCKABLE_TARGET
    			-- `Result' is first dockable target that is_dockable found by recursively
    			-- searching up through the parenting structure from the widget
    			-- currently underneath the pointer position.
    			-- `Result' will be `Void' if a dockable target is not found.
    			-- (from EV_DOCKABLE_SOURCE_I)
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			result_is_dockable: Result /= Void implies Result.is_docking_enabled

    	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

    	get_next_target (a_widget: EV_WIDGET): EV_DOCKABLE_TARGET
    			-- `Result' is next dockable target that is is_dockable found by
    			-- recursively seraching up the parenting structure from `current_target'.
    			-- `Result' will be `Void' if none.
    			-- (from EV_DOCKABLE_SOURCE_I)
    		require -- from EV_DOCKABLE_SOURCE_I
    			a_widget_not_void: a_widget /= Void
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			result_is_dockable: Result /= Void implies Result.is_docking_enabled

    	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

    	check_dragable_release (a_x, a_y: INTEGER_32)
    			-- End transport if in drag and drop.

    	disable_dockable
    			-- Ensure `Current' is not dockable
    			-- (from EV_DOCKABLE_SOURCE_I)
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			not_is_dockable: not is_dockable

    	disable_external_docking
    			-- Forbid `Current' to be docked into an EV_DOCKABLE_DIALOG
    			-- When there is no valid EV_DRAGABLE_TARGET upon completion
    			-- of the transport?
    			-- (from EV_DOCKABLE_SOURCE_I)
    		require -- from EV_DOCKABLE_SOURCE_I
    			is_dockable: is_dockable
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			not_externally_dockable: not is_external_docking_enabled

    	disable_external_docking_relative
    			-- Assign `False' to is_external_docking_relative, ensuring that
    			-- a dockable dialog displayed when `Current' is docked externally
    			-- is displayed as a standard window.
    			-- (from EV_DOCKABLE_SOURCE_I)
    		require -- from EV_DOCKABLE_SOURCE_I
    			external_docking_enabled: is_external_docking_enabled
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			external_docking_not_relative: not is_external_docking_relative

    	dragable_motion (a_x, a_y, a_screen_x, a_screen_y: INTEGER_32)
    			-- If in drag/pick and drop then update.

    	dragable_press (a_x, a_y, a_button, a_screen_x, a_screen_y: INTEGER_32)
    			-- Process `a_button' to start/stop the drag/pick and
    			-- drop mechanism.

    	enable_dockable
    			-- Allow `Current' to be dockable
    			-- (from EV_DOCKABLE_SOURCE_I)
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			is_dockable: is_dockable

    	enable_external_docking
    			-- Allow `Current' to be docked into an EV_DOCKABLE_DIALOG
    			-- When there is no valid EV_DRAGABLE_TARGET upon completion
    			-- of the transport?
    			-- (from EV_DOCKABLE_SOURCE_I)
    		require -- from EV_DOCKABLE_SOURCE_I
    			is_dockable: is_dockable
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			is_externally_dockable: is_external_docking_enabled

    	enable_external_docking_relative
    			-- Assign `True' to is_external_docking_relative, ensuring that
    			-- a dockable dialog displayed when `Current' is docked externally
    			-- is displayed relative to the top level window.
    			-- (from EV_DOCKABLE_SOURCE_I)
    		require -- from EV_DOCKABLE_SOURCE_I
    			external_docking_enabled: is_external_docking_enabled
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			external_docking_not_relative: is_external_docking_relative

    	release_capture
    			-- Release a capture on `Current'.

    	remove_real_source
    			-- Ensure real_source is `Void'.
    			-- (from EV_DOCKABLE_SOURCE_I)
    		require -- from EV_DOCKABLE_SOURCE_I
    			is_dockable: is_dockable
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			real_source_void: real_source = Void

    	set_capture
    			-- Start a capture on `Current'.

    	set_real_source (dockable_source: EV_DOCKABLE_SOURCE)
    			-- Set `dockable_source' to be the widget moved when a
    			-- drag begins on `Current'.
    			-- (from EV_DOCKABLE_SOURCE_I)
    		require -- from EV_DOCKABLE_SOURCE_I
    			is_dockable: is_dockable
    			dockable_source_not_void: dockable_source /= Void
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			real_source_assigned: real_source = dockable_source

    	wel_has_capture: BOOLEAN
    			-- Is a WEL capture currently set on `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

    	close_dockable_dialog (dockable_dialog: EV_DOCKABLE_DIALOG)
    			-- Close request received by `dockable_dialog' so
    			-- restore widget contained back to its original position
    			-- in its old parent if possible.
    			-- We must fire `dock_ended' actions.
    			-- (from EV_DOCKABLE_SOURCE_I)
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			dockable_dialog_destroyed: dockable_dialog.is_destroyed

    	complete_dock
    			-- Complete a dock from source_being_docked.
    			-- (from EV_DOCKABLE_SOURCE_I)
    		require -- from EV_DOCKABLE_SOURCE_I
    			source_being_docked: source_being_docked /= Void
    		ensure -- from EV_DOCKABLE_SOURCE_I
    			not_dock_executing: not is_dock_executing
    			insert_separator_not_parented: insert_sep.parent = Void
    			insert_label_not_parented: insert_label.parent = Void

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

    	drag_cursor: EV_POINTER_STYLE
    			-- Cursor used when `Current' is being transported.
    			-- (from EV_DOCKABLE_SOURCE_I)

    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)
    		require -- from  EV_SHARED_TRANSPORT_IMP
    			True

    	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

    	dock_ended_actions: EV_NOTIFY_ACTION_SEQUENCE
    			-- Actions to be performed after a dock completes from `Current'.
    			-- Either to a dockable target or a dockable dialog.
    			-- (from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES_I)
    		ensure -- from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES_I
    			not_void: Result /= Void

    	dock_started_actions: EV_NOTIFY_ACTION_SEQUENCE
    			-- Actions to be performed when `pebble' is picked up.
    			-- (from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES_I)
    		ensure -- from EV_DOCKABLE_SOURCE_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_DOCKABLE_SOURCE_I
    	widget_or_item_source: not (widget_source_being_docked /= Void and item_source_being_docked /= Void)
    	dock_executing: is_dock_executing implies widget_source_being_docked /= Void or item_source_being_docked /= Void

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