indexing
	description: "Windows Bitmap, which can be loaded from a resource or created from an existing DIB."
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-06-30 12:39:06 -0700 (Fri, 30 Jun 2006) $"
	revision: "$Revision: 60884 $"

class interface
	WEL_BITMAP

create 
	make_by_id (id: INTEGER_32)
			-- Load the resource by an `id'
		require -- from WEL_RESOURCE
			valid_id: id > 0
		ensure -- from WEL_RESOURCE
			not_shared: not shared

	make_by_name (name: STRING_GENERAL)
			-- Load the resource by a `name'
		require -- from WEL_RESOURCE
			name_not_void: name /= Void
			name_not_empty: not name.is_empty
		ensure -- from WEL_RESOURCE
			not_shared: not shared

	make_by_dib (a_dc: WEL_DC; dib: WEL_DIB; mode: INTEGER_32)
			-- Create a WEL_BITMAP from a `dib' in the `a_dc'
			-- using `mode'. See class `WEL_DIB_COLORS_CONSTANTS'
			-- for `mode' values.
		require
			a_dc_not_void: a_dc /= Void
			a_dc_exists: a_dc.exists
			dib_not_void: dib /= Void
			valid_mode: valid_dib_colors_constant (mode)
		ensure
			bitmap_created: item /= item.default

	make_compatible (a_dc: WEL_DC; a_width, a_height: INTEGER_32)
			-- Initialize current bitmap to be compatible
			-- with `a_dc' and with `a_width' as width,
			-- `a_height' as height.
		require
			a_dc_not_void: a_dc /= Void
			a_dc_exists: a_dc.exists
			positive_width: a_width >= 0
			positive_height: a_height >= 0

	make_direct (a_width, a_height, a_planes, a_bits_per_pixel: INTEGER_32; a_data: STRING_8)
			-- Make a bitmap of dimension `a_width' x `a_height' that has `a_planes' number
			-- of color planes and `a_bits_per_pixel' (number of bits to identify color).
			-- `a_data' contains color data array.
		require
			positive_width: a_width >= 0
			positive_height: a_height >= 0
			positive_planes: a_planes >= 0
			positive_bits_per_pixel: a_bits_per_pixel >= 0
			data_not_void: a_data /= Void
			data_count_big_enough: a_data.count >= 2 * (a_width * a_height * a_bits_per_pixel * a_planes) // 8

	make_indirect (a_log_bitmap: WEL_LOG_BITMAP)
			-- Make a bitmap using `a_log_bitmap'.
		require
			a_log_bitmap_not_void: a_log_bitmap /= Void

	make_by_pointer (a_pointer: POINTER)
			-- Set item with `a_pointer'.
			-- Since item is shared, it does not need
			-- to be freed.
			-- Caution: `a_pointer' must be a pointer
			-- coming from Windows.
			-- (from WEL_GDI_ANY)
		require -- from  WEL_ANY
			True
		ensure -- from WEL_ANY
			item_set: item = a_pointer
			shared: shared

	make_by_bitmap (a_bitmap: WEL_BITMAP)
			-- Create a WEL_BITMAP from another WEL_BITMAP. The
			-- bitmap is copied by value

	make_dib (a_header_info: WEL_BITMAP_INFO_HEADER)
			-- Create a DIB bitmap section.
		require
			a_header_info_not_void: a_header_info /= Void
			a_header_info_exist: a_header_info.exists
		ensure
			bitmap_created: item /= default_pointer
			ppv_bits_assigned: ppv_bits /= default_pointer

feature -- Access

	gdi_objects_count: INTEGER_32
			-- Number of GDI object currently allocated by the
			-- program.
			--
			-- Note: debug option "WEL_GDI_COUNT" should be enabled, otherwise
			-- this function will return zero.
			-- (from WEL_GDI_ANY)

	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)

	height: INTEGER_32
			-- Bitmap height
		require
			exists: exists
		ensure
			positive_result: Result >= 0

	item: POINTER
			-- Generic Windows handle or structure pointer.
			-- Can be a HWND, HICON, RECT *, WNDCLASS *, etc...
			-- (from WEL_ANY)

	log_bitmap: WEL_LOG_BITMAP
			-- Log bitmap structure associated to `Current'
		require
			exists: exists
		ensure
			result_not_void: Result /= Void

	ppv_bits: POINTER
			-- If Current if Created by make_dib, this is the pointer to the location of the DIB bit values.
			-- Otherwise it's void.

	width: INTEGER_32
			-- Bitmap width
		require
			exists: exists
		ensure
			positive_result: Result >= 0
	
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

	exists: BOOLEAN
			-- Does the item exist?
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			Result = (item /= default_pointer)

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

	shared: BOOLEAN
			-- Is item shared by another object?
			-- If False (by default), item will
			-- be destroyed by destroy_item.
			-- If True, item will not be destroyed.
			-- (from WEL_ANY)
	
feature {ANY} -- Status report

	valid_dib_colors_constant (c: INTEGER_32): BOOLEAN
			-- Is `c' a valid dib colors constant?
			-- (from WEL_DIB_COLORS_CONSTANTS)
	
feature -- Status setting

	set_shared
			-- Set shared to True.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			shared: shared

	set_unshared
			-- Set shared to False.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			unshared: not shared
	
feature -- Element change

	set_item (an_item: POINTER)
			-- Set item with `an_item'
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			item_set: item = an_item
	
feature -- Removal

	delete
			-- Destroy inner structure of `Current'.
			-- To be called when Current is no more needed
			-- (from WEL_REFERENCE_TRACKABLE)
		require -- from WEL_REFERENCE_TRACKABLE
			reference_not_tracked: not reference_tracked
		ensure -- from WEL_REFERENCE_TRACKABLE
			destroyed: not shared implies not exists

	dispose
			-- Destroy inner structure of `Current'.
			-- (from WEL_REFERENCE_TRACKABLE)
		require -- from  DISPOSABLE
			True
		ensure then -- from WEL_REFERENCE_TRACKABLE
			internal_object_id_freed: internal_object_id = 0
	
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)

	set_di_bits (a_dc: WEL_DC; start_line, length: INTEGER_32; dib: WEL_DIB; mode: INTEGER_32)
			-- Set the bits of the current bitmap to the values
			-- given in `dib', starting at line `start_line'
			-- during `length' lines, using `mode'.
			-- See class WEL_DIB_COLORS_CONSTANTS for `mode' values.
		require
			exists: exists
			a_dc_not_void: a_dc /= Void
			a_dc_exists: a_dc.exists
			dib_not_void: dib /= Void
			valid_mode: valid_dib_colors_constant (mode)
	
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

	reference_tracked: BOOLEAN
			-- Are number references of `Current' tracked?
			-- (from WEL_REFERENCE_TRACKABLE)

	references_count: INTEGER_32
			-- Number of object referring to current object.
			-- (from WEL_REFERENCE_TRACKABLE)
	
feature -- Status Setting

	decrement_reference
			-- Decrement number of references to current object.
			-- When number of references reaches zero, 
			-- delete is called if object is not protected.
			-- (from WEL_REFERENCE_TRACKABLE)
		require -- from WEL_REFERENCE_TRACKABLE
			exists: exists
			tracking_references_started: reference_tracked

	enable_reference_tracking
			-- Set `references_tracked' to True.
			-- (from WEL_REFERENCE_TRACKABLE)
		require -- from WEL_REFERENCE_TRACKABLE
			exists: exists
			tracking_reference_not_started: not reference_tracked

	increment_reference
			-- Increment number of references to current object.
			-- (from WEL_REFERENCE_TRACKABLE)
		require -- from WEL_REFERENCE_TRACKABLE
			exists: exists
			tracking_references_started: reference_tracked

	object_id: INTEGER_32
			-- Runtime Id of `Current'.
			-- (from WEL_REFERENCE_TRACKABLE)
	
invariant
		-- 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 WEL_BITMAP