indexing
	description: "Contains information that a rich edit control uses to format its output for a particular device."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class interface
	WEL_FORMAT_RANGE

create 

	make
			-- Allocate item
			-- (from WEL_STRUCTURE)
		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

	character_range: WEL_CHARACTER_RANGE
			-- Range of text to format
		ensure
			result_not_void: Result /= void

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

	rect: WEL_RECT
			-- Area to render to.
			-- Units are in TWIPS.
		ensure
			result_not_void: Result /= void

	rect_page: WEL_RECT
			-- Entire area of rendering device.
			-- Units are in TWIPS.
		ensure
			result_not_void: Result /= void
	
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)

	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_character_range (a_character_range: WEL_CHARACTER_RANGE)
			-- Set character_range with a_character_range.
		require
			a_character_range_not_void: a_character_range /= void

	set_dc (a_dc: WEL_DC)
			-- Set the device to render to.
		require
			a_dc_not_void: a_dc /= void

	set_dc_target (a_dc: WEL_DC)
			-- Set the target device to format for.
		require
			a_dc_not_void: a_dc /= void

	set_item (an_item: POINTER)
			-- Set item with an_item
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			item_set: item = an_item

	set_range (min, max: INTEGER)
			-- Set the range with min and max.
		require
			valid_min_max: max >= min
		ensure
			set_min: character_range.minimum = min
			set_max: character_range.maximum = max

	set_rect (a_rect: WEL_RECT)
			-- Set rect with a_rect.
			-- Units are in TWIPS.
		require
			a_rect_not_void: a_rect /= void

	set_rect_page (a_rect: WEL_RECT)
			-- Set rect_page with a_rect.
			-- Units are in TWIPS.
		require
			a_rect_not_void: a_rect /= void
	
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
	
invariant

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

end -- class WEL_FORMAT_RANGE