indexing

	description: "Source of the drag and drop."
	legal: "See notice at end of class."
	status: "See notice at end of class.";
	date: "$Date$";
	revision: "$Revision $"

deferred class DRAG_SOURCE 

feature -- Properties

	source: WIDGET is
			-- Source of the stone: widget which triggers the 
			-- transport and yields the stone when
			-- clicked on with the right mouse button.
		deferred
		end;

	transportable: BOOLEAN is
			-- May current stone be transported.
			-- If transportable_stone is not Void then by default
			-- it is transported. May be redefined in descendants
			-- to reflect a given state of the application
		do
			Result := transported_stone /= Void
		ensure
			has_stone: Result implies transported_stone /= Void
		end;

	want_initial_position: BOOLEAN is
			-- Use `initial_coord' to define initial drawing point?
			-- (Otherwize, the absolute coordinates are used)
		do
			Result := True
		end;

	initial_coord: COORD_XY is
			-- Initial x starting point.
			-- By default it is in the middle of the widget.
		require
			want_initial_position: want_initial_position
		local
			x1, y1: INTEGER
		do
			x1 := source.real_x + source.width // 2;
			y1 := source.real_y + source.height // 2;
			create Result;
			Result.set (x1, y1)
		end;

feature -- Update

	update_before_transport (but_data: BUTTON_DATA) is
			-- Update Current stone and related information
			-- before transport using button data `but_data'.
			-- Do nothing by default.
		require
			valid_but_data: but_data /= Void
		do
		end;

	update_after_transport (but_data: BUTTON_DATA) is
			-- Update Current stone and related information
			-- after it has been dropped (and processed) or 
			-- has been aborted.
			-- (Do nothing by default).
		require
			valid_but_data: but_data /= Void
		do
		end;

feature -- Stone properties

	transported_stone: STONE is
			-- Stone associated with Current
		deferred
		end;

feature {NONE} -- Transport

	initialize_transport is
			-- Initialize the mechanism through which
			-- the current stone may be dragged and
			-- dropped.
		require
			valid_source: source /= Void
		do	
			source.set_action ("<Btn3Down>", transport_command, Current);
		end;
	
	transport_command: TRANSPORT is
			-- Command which takes care of the 
			-- the transport.
		once
			create Result
		end;

indexing
	copyright:	"Copyright (c) 1984-2006, Eiffel Software"
	license:	"GPL version 2 (see http://www.eiffel.com/licensing/gpl.txt)"
	licensing_options:	"http://www.eiffel.com/licensing"
	copying: "[
			This file is part of Eiffel Software's Eiffel Development Environment.
			
			Eiffel Software's Eiffel Development Environment is free
			software; you can redistribute it and/or modify it under
			the terms of the GNU General Public License as published
			by the Free Software Foundation, version 2 of the License
			(available at the URL listed under "license" above).
			
			Eiffel Software's Eiffel Development Environment is
			distributed in the hope that it will be useful,	but
			WITHOUT ANY WARRANTY; without even the implied warranty
			of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
			See the	GNU General Public License for more details.
			
			You should have received a copy of the GNU General Public
			License along with Eiffel Software's Eiffel Development
			Environment; if not, write to the Free Software Foundation,
			Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
		]"
	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 DRAG_SOURCE