indexing
	description: "Used for defining a clip region in EV_DRAWABLE"
	author: ""
	date: "$Date: 2006-10-03 16:32:04 -0700 (Tue, 03 Oct 2006) $"
	revision: "$Revision: 64098 $"

class interface
	EV_REGION

create 
	default_create
			-- Standard creation procedure.
			-- (from EV_ANY)
		require -- from  ANY
			True
		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

	make_with_rectangle (a_rectangle: EV_RECTANGLE)
			-- Create region with area set to `a_rectangle'.
		require
			a_rect_not_void: a_rectangle /= Void

convert
	make_with_rectangle ({EV_RECTANGLE})

feature -- Access

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

	exclusive_or (a_region: EV_REGION): EV_REGION
			-- Exclusive or `a_region' with `Current'.
			-- Was declared in EV_REGION as synonym of infix "xor".
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	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)

	intersect (a_region: EV_REGION): EV_REGION
			-- Intersection of `a_region' with `Current' .
			-- Was declared in EV_REGION as synonym of infix "and" and infix "&".
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	subtract (a_region: EV_REGION): EV_REGION
			-- `a_region' subtracted from `Current'.
			-- Was declared in EV_REGION as synonym of infix "-".
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	union (a_region: EV_REGION): EV_REGION
			-- Union of `a_region' with `Current'.
			-- Was declared in EV_REGION as synonym of infix "or" and infix "|".
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	infix "&" (a_region: EV_REGION): EV_REGION
			-- Intersection of `a_region' with `Current' .
			-- Was declared in EV_REGION as synonym of intersect and infix "and".
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	infix "-" (a_region: EV_REGION): EV_REGION
			-- `a_region' subtracted from `Current'.
			-- Was declared in EV_REGION as synonym of subtract.
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	infix "and" (a_region: EV_REGION): EV_REGION
			-- Intersection of `a_region' with `Current' .
			-- Was declared in EV_REGION as synonym of intersect and infix "&".
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	infix "or" (a_region: EV_REGION): EV_REGION
			-- Union of `a_region' with `Current'.
			-- Was declared in EV_REGION as synonym of union and infix "|".
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	infix "xor" (a_region: EV_REGION): EV_REGION
			-- Exclusive or `a_region' with `Current'.
			-- Was declared in EV_REGION as synonym of exclusive_or.
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void

	infix "|" (a_region: EV_REGION): EV_REGION
			-- Union of `a_region' with `Current'.
			-- Was declared in EV_REGION as synonym of union and infix "or".
		require
			a_region_valid: a_region /= Void and then not a_region.is_destroyed
			not_is_destroyed: not is_destroyed
		ensure
			result_not_void: Result /= Void
	
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
			-- Does `other' have the same appearance as `Current'.
		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 -- Element change

	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
	
feature -- Duplication

	copy (other: like Current)
			-- Update `Current' to have same appearance as `other'.
			-- (So as to satisfy is_equal.)
		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 -- Command

	destroy
			-- Destroy underlying native toolkit object.
			-- Render `Current' unusable.
			-- (from EV_ANY)
		ensure -- from EV_ANY
			is_destroyed: is_destroyed
	
feature -- Element Change

	offset (a_horizontal_offset, a_vertical_offset: INTEGER_32)
			-- Move `Current' a `a_horizontal_offset' horizontally and `a_vertical_offset' vertically.
		require
			not_is_destroyed: not is_destroyed

	set_rectangle (a_rectangle: EV_RECTANGLE)
			-- Set region to area `a_rectangle'.
		require
			a_rect_not_void: a_rectangle /= Void
			not_is_destroyed: not is_destroyed
	
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)
	
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 EV_ANY
	is_initialized: is_initialized
	is_coupled: implementation /= Void and then implementation.interface = Current
	default_create_called: default_create_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_REGION