indexing
	description: "Defines the style, width and color of a pen."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class interface
	WEL_LOG_PEN

create 

	make (a_style, a_width: INTEGER; a_color: WEL_COLOR_REF)
			-- Make a log pen using a_style, a_width and
			-- a_color.
			-- See class WEL_PS_CONSTANTS for a_style values.
		require
			valid_pen_style_constant: valid_pen_style_constant (a_style)
			positive_width: a_width >= 0
			color_not_void: a_color /= void
		ensure
			set_style: style = a_style
			set_width: width = a_width
			set_color: color.item = a_color.item

	make_by_pen (pen: WEL_PEN)
			-- Make a log pen using the information of pen.
		require
			pen_not_void: pen /= void
			pen_exists: pen.exists

feature -- Access

	color: WEL_COLOR_REF
			-- Pen color
		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)

	style: INTEGER
			-- Pen style
		ensure
			valid_result: valid_pen_style_constant (Result)

	width: INTEGER
			-- Pen width
		ensure
			positive_result: Result >= 0
	
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 report

	valid_pen_style_constant (c: INTEGER): BOOLEAN
			-- Is c a valid pen style constant?
			-- (from WEL_PS_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_color (a_color: WEL_COLOR_REF)
			-- Set color with a_color
		require
			a_color_not_void: a_color /= void
		ensure
			set_color: color.item = a_color.item

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

	set_style (a_style: INTEGER)
			-- Set style with a_style
		require
			valid_pen_style_constant: valid_pen_style_constant (a_style)
		ensure
			set_style: style = a_style

	set_width (a_width: INTEGER)
			-- Set width with a_width
		require
			positive_width: a_width >= 0
		ensure
			set_width: width = a_width
	
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

	color_not_void: color /= void
	positive_width: width >= 0
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class WEL_LOG_PEN