indexing
	description: "Contains information about character formatting in a rich edit control."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class interface
	WEL_CHARACTER_FORMAT

create 

	make
			-- Make a char format structure.

	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

	char_set: INTEGER
			-- Character set value. Can be one of the values
			-- specified for the char_set function of the
			-- WEL_LOG_FONT structure.

	effects: INTEGER
			-- Character effects.
			-- See class WEL_CFE_CONSTANTS for values.

	face_name: STRING
			-- Font face name
		ensure
			result_not_void: Result /= void

	height: INTEGER
			-- Character height

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

	mask: INTEGER
			-- Valid information or attributes to set.
			-- See class WEL_CFM_CONSTANTS for values.
			-- This attribut is automatically set by the
			-- features set_*.

	max_face_name_length: INTEGER
			-- Maximum face name length

	offset: INTEGER
			-- Character offset from the baseline. If the value
			-- is positive, the character is a superscript; if it
			-- is negative, the character is a subscript.

	pitch_and_family: INTEGER
			-- Font pitch and family. This value is the same as
			-- pitch_and_family of the WEL_LOG_FONT structure.

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

	has_effects (an_effects: INTEGER): BOOLEAN
			-- Is an_effects set in effects?
			-- See class WEL_CFE_CONSTANTS for an_effects values.

	has_mask (a_mask: INTEGER): BOOLEAN
			-- Is a_mask set in mask?
			-- See class WEL_CFM_CONSTANTS for a_mask values.

	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

	add_effects (an_effects: INTEGER)
			-- Add an_effects to effects.
			-- See class WEL_CFE_CONSTANTS for a_mask values.
		ensure
			has_effects: has_effects (an_effects)

	add_mask (a_mask: INTEGER)
			-- Add a_mask to mask.
			-- See class WEL_CFM_CONSTANTS for a_mask values.
		ensure
			has_mask: has_mask (a_mask)

	remove_effects (an_effects: INTEGER)
			-- Remove an_effects from effects.
			-- See class WEL_CFE_CONSTANTS for a_mask values.
		ensure
			has_not_effects: not has_effects (an_effects)

	remove_mask (a_mask: INTEGER)
			-- Remove a_mask from mask.
			-- See class WEL_CFM_CONSTANTS for a_mask values.
		ensure
			has_not_mask: not has_mask (a_mask)

	set_all_masks
			-- Set mask with all possible values.

	set_bold
			-- Set bold characters.

	set_char_set (a_char_set: INTEGER)
			-- Set char_set with a_char_set.
		ensure
			char_set_set: char_set = a_char_set

	set_default_format
			-- Set Current to default formatting.

	set_effects (an_effects: INTEGER)
			-- Set effects with an_effects.
			-- See class WEL_CFE_CONSTANTS for a_mask values.
		ensure
			effects_set: effects = an_effects

	set_face_name (a_face_name: STRING)
			-- Set face_name with a_face_name.
		require
			a_face_name_not_void: a_face_name /= void
			valid_count: a_face_name.count <= max_face_name_length
		ensure
			face_name_set: face_name.is_equal (a_face_name)

	set_height (a_height: INTEGER)
			-- Set height with a_height (height specified in points).
		ensure
			height_set: height = a_height * 20

	set_italic
			-- Set italic characters.

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

	set_mask (a_mask: INTEGER)
			-- Set mask with a_mask.
			-- See class WEL_CFM_CONSTANTS for a_mask values.
		ensure
			mask_set: mask = a_mask

	set_offset (an_offset: INTEGER)
			-- Set offset with an_offset.
		ensure
			offset_set: offset = an_offset

	set_pitch_and_family (a_pitch_and_family: INTEGER)
			-- Set pitch_and_family with a_pitch_and_family.
		ensure
			pitch_and_family_set: pitch_and_family = a_pitch_and_family

	set_protected
			-- Set protected characters.

	set_strike_out
			-- Set strike out characters.

	set_text_color (a_color: WEL_COLOR_REF)
			-- Set text_color with a_text_color.
		ensure
			text_color_set: text_color.item = a_color.item

	set_underline
			-- Set underline characters.

	unset_bold
			-- Unset bold characters.

	unset_italic
			-- Unset italic characters.

	unset_protected
			-- Unset protected characters.

	unset_strike_out
			-- Unset strike out characters.

	unset_underline
			-- Unset underline characters.
	
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_CHARACTER_FORMAT