indexing
	description: "Device independent bitmap which can be created from a file."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"
	note: "Not all variants of the bmp format can be read. If you haveproblems with a certain image please use i.e. MS Paint to convertthe image to the standard bmp format and then try again."

class interface
	WEL_DIB

create 

	make_by_file (file: RAW_FILE)
			-- Create the dib by reading file.
		require
			file_not_void: file /= void
			file_exists: file.exists
			file_opened: file.is_open_read
		ensure
			palette_not_void: palette /= void
			palette_exists: palette.exists
			file_closed: file.is_closed

	make_by_content_pointer (bits_ptr: POINTER; size: INTEGER)
		ensure
			palette_not_void: palette /= void
			palette_exists: palette.exists

feature -- Access

	color_count: INTEGER
			-- How many colors in the dib?
		require
			exists: exists
		ensure
			positive_result: Result >= 0

	height: INTEGER
			-- Dib 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)

	item_bits: POINTER
		require
			exists: exists

	palette: WEL_PALETTE
			-- Dib palette.
			--
			-- You can track the references of palette if you want to
			-- free the GDI object contained in palette more quickly.

	width: INTEGER
			-- Dib width
		require
			exists: exists
		ensure
			positive_result: Result >= 0
	
feature -- Status report

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

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

	dispose
			-- Destroy the inner structure of Current.
			--
			-- This function should be called by the GC when the
			-- object is collected or by the user if Current is
			-- no more usefull.
			-- (from WEL_ANY)
	
feature -- Conversion

	to_integer: INTEGER
			-- Converts item to an integer.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			Result = cwel_pointer_to_integer (item)
	
feature -- Basic operations

	initialize
			-- Fill Current with zeros.
			-- (from WEL_STRUCTURE)
		require -- from WEL_STRUCTURE
			exists: exists

	initialize_with_character (a_character: CHARACTER)
			-- Fill current with a_character.
			-- (from WEL_STRUCTURE)
		require -- from WEL_STRUCTURE
			exists: exists

	memory_copy (source_pointer: POINTER; length: INTEGER)
			-- Copy length bytes from source_pointer to item.
			-- (from WEL_STRUCTURE)
		require -- from WEL_STRUCTURE
			length_small_enough: length <= structure_size
			length_large_enough: length > 0
			exists: exists

	set_pal_color
			-- Transform the dib to be compatible with
			-- Dib_pal_colors mode.
		require
			exists: exists
	
invariant

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class WEL_DIB