indexing
	description: "EiffelVision pixmap. Common attributes betweenall different EV_PIXMAP Windows implementation"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

deferred class interface
	EV_PIXMAP_IMP_STATE

feature -- Access

	blue: INTEGER_32
			-- Intensity value for the blue component
			-- (from WEL_COLOR_REF)

	cursor: WEL_CURSOR
			-- Current pixmap in HCURSOR format. Void if none.

	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)

	get_bitmap: WEL_BITMAP
			-- Current bitmap used.
			--
			-- The number of references if incremented when calling
			-- this feature, call `WEL_BITMAP.decrement_reference'
		ensure
			result_not_void: Result /= Void

	get_mask_bitmap: WEL_BITMAP
			-- Monochrome bitmap used as mask.
			--
			-- The number of references if incremented when calling
			-- this feature, call `WEL_BITMAP.decrement_reference'
		require
			mask_in_use: has_mask
		ensure
			result_not_void: Result /= Void

	green: INTEGER_32
			-- Intensity value for the green component
			-- (from WEL_COLOR_REF)

	has_mask: BOOLEAN
			-- Has the current pixmap a mask?
		ensure
			has_mask_implies_mask_bitmap_not_void: Result implies get_mask_bitmap /= Void

	icon: WEL_ICON
			-- Current pixmap in HICON format. Void if none.

	item: INTEGER_32
			-- The Current color.
			-- (from WEL_COLOR_REF)

	palette: WEL_PALETTE
			-- Current palette used. Void if none.

	red: INTEGER_32
			-- Intensity value for the red component
			-- (from WEL_COLOR_REF)
	
feature -- Measurement

	height: INTEGER_32
			-- Height of the pixmap in pixels.

	width: INTEGER_32
			-- Width of the pixmap in pixels.
	
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

	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 {ANY} -- Status report

	valid_color_constant (c: INTEGER_32): BOOLEAN
			-- Is `c' a valid color constant?
			-- (from WEL_COLOR_CONSTANTS)
	
feature -- Element change

	set_blue (a_blue: INTEGER_32)
			-- Set blue with `a_blue'
			-- (from WEL_COLOR_REF)
		require -- from WEL_COLOR_REF
			valid_blue_inf: a_blue >= 0
			valid_blue_sup: a_blue <= 255
		ensure -- from WEL_COLOR_REF
			blue_set: blue = a_blue

	set_color (color: INTEGER_32)
			-- Set item with `color'.
			-- (from WEL_COLOR_REF)
		ensure -- from WEL_COLOR_REF
			color_set: item = color

	set_green (a_green: INTEGER_32)
			-- Set green with `a_green'
			-- (from WEL_COLOR_REF)
		require -- from WEL_COLOR_REF
			valid_green_inf: a_green >= 0
			valid_green_sup: a_green <= 255
		ensure -- from WEL_COLOR_REF
			green_set: green = a_green

	set_red (a_red: INTEGER_32)
			-- Set red with `a_red'
			-- (from WEL_COLOR_REF)
		require -- from WEL_COLOR_REF
			valid_red_inf: a_red >= 0
			valid_red_sup: a_red <= 255
		ensure -- from WEL_COLOR_REF
			red_set: red = a_red

	set_rgb (a_red, a_green, a_blue: INTEGER_32)
			-- Set red, green, blue with
			-- `a_red', `a_green', `a_blue'
			-- (from WEL_COLOR_REF)
		require -- from WEL_COLOR_REF
			valid_red_inf: a_red >= 0
			valid_red_sup: a_red <= 255
			valid_green_inf: a_green >= 0
			valid_green_sup: a_green <= 255
			valid_blue_inf: a_blue >= 0
			valid_blue_sup: a_blue <= 255
		ensure -- from WEL_COLOR_REF
			red_set: red = a_red
			green_set: green = a_green
			blue_set: blue = a_blue
	
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 -- 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

	create_conforming_pick_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Create a conforming_pick action sequence.
			-- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_IMP)

	create_drop_actions: EV_PND_ACTION_SEQUENCE
			-- Create a drop action sequence.
			-- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_IMP)

	create_expose_actions: EV_GEOMETRY_ACTION_SEQUENCE
			-- Create a expose action sequence.
			-- (from EV_PIXMAP_ACTION_SEQUENCES_IMP)

	create_focus_in_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Create a focus_in action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_focus_out_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Create a focus_out action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_key_press_actions: EV_KEY_ACTION_SEQUENCE
			-- Create a key_press action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_key_press_string_actions: EV_KEY_STRING_ACTION_SEQUENCE
			-- Create a key_press_string action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_key_release_actions: EV_KEY_ACTION_SEQUENCE
			-- Create a key_release action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_mouse_wheel_actions: EV_INTEGER_ACTION_SEQUENCE
			-- Create a mouse_wheel action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_pick_actions: EV_PND_START_ACTION_SEQUENCE
			-- Create a pick action sequence.
			-- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_IMP)

	create_pick_ended_actions: EV_PND_FINISHED_ACTION_SEQUENCE
			-- Create a pick ended action sequence.
			-- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_IMP)

	create_pointer_button_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE
			-- Create a pointer_button_press action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_pointer_button_release_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE
			-- Create a pointer_button_release action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_pointer_double_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE
			-- Create a pointer_double_press action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_pointer_enter_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Create a pointer_enter action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_pointer_leave_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Create a pointer_leave action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_pointer_motion_actions: EV_POINTER_MOTION_ACTION_SEQUENCE
			-- Create a pointer_motion action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	create_resize_actions: EV_GEOMETRY_ACTION_SEQUENCE
			-- Create a resize action sequence.
			-- (from EV_WIDGET_ACTION_SEQUENCES_IMP)

	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

	expose_actions: EV_GEOMETRY_ACTION_SEQUENCE
			-- Actions to be performed when an area needs to be redrawn.
			-- (from EV_PIXMAP_ACTION_SEQUENCES_I)
		ensure -- from EV_PIXMAP_ACTION_SEQUENCES_I
			not_void: Result /= Void

	file_drop_actions: ACTION_SEQUENCE [TUPLE [LIST [STRING_32]]]
			-- Actions to be performed when an OS file drop occurs on `Current'.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	focus_in_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Actions to be performed when keyboard focus is gained.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	focus_out_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Actions to be performed when keyboard focus is lost.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	key_press_actions: EV_KEY_ACTION_SEQUENCE
			-- Actions to be performed when a keyboard key is pressed.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	key_press_string_actions: EV_KEY_STRING_ACTION_SEQUENCE
			-- Actions to be performed when a keyboard press generates a displayable character.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	key_release_actions: EV_KEY_ACTION_SEQUENCE
			-- Actions to be performed when a keyboard key is released.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	mouse_wheel_actions: EV_INTEGER_ACTION_SEQUENCE
			-- Actions to be performed when mouse wheel is rotated.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_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_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	pointer_button_release_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE
			-- Actions to be performed when screen pointer button is released.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_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_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	pointer_enter_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Actions to be performed when screen pointer enters widget.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	pointer_leave_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Actions to be performed when screen pointer leaves widget.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_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_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void

	resize_actions: EV_GEOMETRY_ACTION_SEQUENCE
			-- Actions to be performed when size changes.
			-- (from EV_WIDGET_ACTION_SEQUENCES_I)
		ensure -- from EV_WIDGET_ACTION_SEQUENCES_I
			not_void: Result /= Void
	
feature -- Misc.

	build_cursor: WEL_CURSOR
			-- Build a WEL_CURSOR from `bitmap' and `mask_bitmap'.
		ensure
			result_not_void: Result /= Void

	build_icon: WEL_ICON
			-- Build a WEL_ICON from `bitmap' and `mask_bitmap'.
		ensure
			result_not_void: Result /= Void

	gdi_compact
			-- Spare GDI resource by freeing icons, cursors, ... that
			-- can be reloaded from file.

	raw_image_data: EV_RAW_IMAGE_DATA
			-- RGBA representation of `Current'.
	
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 -- Saving

	save_to_named_file (a_format: EV_GRAPHICAL_FORMAT; a_filename: FILE_NAME)
			-- Save `Current' to `a_filename' in `a_format' format.
		require
			a_format_not_void: a_format /= Void
			a_filename_not_void: a_filename /= Void
			a_filename_valid: a_filename.is_valid
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

		-- from WEL_COLOR_REF
	valid_red_inf: red >= 0
	valid_red_sup: red <= 255
	valid_green_inf: green >= 0
	valid_green_sup: green <= 255
	valid_blue_inf: blue >= 0
	valid_blue_sup: blue <= 255

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_PIXMAP_IMP_STATE