indexing
	description: "Object brush which can be selected into a DC."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class interface
	WEL_BRUSH

create 

	make_by_sys_color (sys_color: INTEGER)
			-- Make a brush using the system color sys_color.
			-- See class WEL_COLOR_CONSTANTS for sys_color value.
			-- Use only this creation routine for a WNDCLASS brush.
		ensure
			shared: shared
			item_not_void: item /= default_pointer

	make_solid (a_color: WEL_COLOR_REF)
			-- Make a brush that has the solid a_color
		require
			a_color_not_void: a_color /= void
		ensure
			color_set: exists implies color.item = a_color.item
			item_not_void: item /= default_pointer

	make_hatch (a_hatch: INTEGER; a_color: WEL_COLOR_REF)
			-- Make a brush that has the
			-- hatch_style pattern and a_color
			-- See class WEL_HS_CONSTANTS for a_hatch
		require
			a_color_not_void: a_color /= void
		ensure
			hatch_set: exists implies hatch = a_hatch
			color_set: exists implies color.item = a_color.item
			item_not_void: item /= default_pointer

	make_by_pattern (bitmap: WEL_BITMAP)
			-- Make a brush with the specified bitmap pattern.
		require
			bitmap_not_void: bitmap /= void
			bitmap_exists: bitmap.exists
		ensure
			item_not_void: item /= default_pointer

	make_indirect (a_log_brush: WEL_LOG_BRUSH)
			-- Make a brush using a_log_brush
		require
			a_log_brush_not_void: a_log_brush /= void
		ensure
			item_not_void: item /= default_pointer

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

feature -- Access

	color: WEL_COLOR_REF
			-- Brush color
		require
			exists: exists
		ensure
			result_not_void: Result /= void

	gdi_objects_count: INTEGER
			-- 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)

	hatch: INTEGER
			-- Brush hatch
		require
			exists: exists

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

	log_brush: WEL_LOG_BRUSH
			-- Log brush structure associated to Current
		require
			exists: exists
		ensure
			result_not_void: Result /= void

	style: INTEGER
			-- Brush style
		require
			exists: exists
	
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

	delete
			-- Destroy the inner structure of Current.
			--
			-- Call this function 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 the inner structure of Current.
			--
			-- This function is called by the GC when the
			-- object is collected, the developer should
			-- use delete.
			-- (from WEL_REFERENCE_TRACKABLE)
	
feature -- Conversion

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

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

	references_count: INTEGER
			-- Number of object referring this object.
			-- (from WEL_REFERENCE_TRACKABLE)
	
feature -- Status Setting

	decrement_reference
			-- Decrement the number of references to this object.
			--
			-- When the number of references reach zero,
			-- delete is called if the 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 the number of references to this object.
			-- (from WEL_REFERENCE_TRACKABLE)
		require -- from WEL_REFERENCE_TRACKABLE
			exists: exists
			tracking_references_started: reference_tracked

	object_id: INTEGER
			-- Runtime Id of Current.
			-- (from WEL_REFERENCE_TRACKABLE)
	
invariant

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

end -- class WEL_BRUSH