indexing
	description: "This class represents a structure that containsinformation used to set the size and position ofa WEL_HEADER_CONTROL"
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class interface
	WEL_HD_LAYOUT

create 

	make
		ensure -- from WEL_STRUCTURE
			not_shared: not shared

	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_ANY)
		ensure -- from WEL_ANY
			item_set: item = a_pointer
			shared: shared

feature -- Access

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

	rectangle: WEL_RECT
			-- Contains the coordinates of a rectangle that the header control is to occupy
		require
			exists: exists

	window_pos: WEL_WINDOW_POS
			-- Object that receives information about the appropriate size
			-- and position of the header control.
		require
			exists: exists
	
feature -- Measurement

	structure_size: INTEGER
			-- Size to allocate (in bytes)
		ensure -- from WEL_STRUCTURE
			positive_result: Result > 0
	
feature -- Status report

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

	flag_set (flags, mask: INTEGER): BOOLEAN
			-- Is mask set in flags?
			-- (from WEL_BIT_OPERATIONS)

	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

	set_rectangle (a_rect: WEL_RECT)
			-- Contains the coordinates of a rectangle that the header control is to occupy
		require
			exists: exists
			rect_exists: a_rect.exists

	set_window_pos (value: WEL_WINDOW_POS)
			-- Filled usually by Windows
		require
			exists: exists
			window_pos_exists: value.exists
	
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

	clear_flag (flags, mask: INTEGER): INTEGER
			-- Clear the mask in flags
			-- (from WEL_BIT_OPERATIONS)
		ensure -- from WEL_BIT_OPERATIONS
			flag_unset: not flag_set (Result, mask)

	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_flag (flags, mask: INTEGER): INTEGER
			-- Set the mask in flags
			-- (from WEL_BIT_OPERATIONS)
		ensure -- from WEL_BIT_OPERATIONS
			flag_set: flag_set (Result, mask)
	
invariant

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

end -- class WEL_HD_LAYOUT