    indexing
    	description: "Contains information about character formatting in a rich edit control."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	date: "$Date: 2006-03-22 23:29:03 -0800 (Wed, 22 Mar 2006) $"
    	revision: "$Revision: 57641 $"

    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_32
    			-- Character set value. Can be one of the values
    			-- specified for the char_set function of the
    			-- WEL_LOG_FONT structure.

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

    	face_name: STRING_32
    			-- Font face name
    		ensure
    			result_not_void: Result /= Void

    	generating_type: STRING_8
    			-- Name of current object's generating type
    			-- (type of which it is a direct instance)
    			-- (from ANY)

    	generator: STRING_8
    			-- Name of current object's generating class
    			-- (base class of the type of which it is a direct instance)
    			-- (from ANY)

    	height_in_pixels: INTEGER_32
    			-- Character height in pixels

    	height_in_points: INTEGER_32
    			-- Character height in points.

    	height_in_twips: INTEGER_32
    			-- Character height in twips.

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

    	log_font: WEL_LOG_FONT
    			-- Log font representing `Current'.
    		ensure
    			result_not_void: Result /= Void

    	mask: INTEGER_32
    			-- 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_32
    			-- Maximum face name length

    	offset: INTEGER_32
    			-- 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_32
    			-- 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_32
    			-- Size to allocate (in bytes)
    		ensure -- from WEL_STRUCTURE
    			positive_result: Result > 0

    feature -- Comparison

    	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void
    			-- or attached to isomorphic object structures?
    			-- (from ANY)
    		ensure -- from ANY
    			shallow_implies_deep: standard_equal (some, other) implies Result
    			both_or_none_void: (some = Void) implies (Result = (other = Void))
    			same_type: (Result and (some /= Void)) implies some.same_type (other)
    			symmetric: Result implies deep_equal (other, some)

    	frozen equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void or attached
    			-- to objects considered equal?
    			-- (from ANY)
    		ensure -- from ANY
    			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

    	frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void or attached to
    			-- field-by-field identical objects of the same type?
    			-- Always uses default object comparison criterion.
    			-- (from ANY)
    		ensure -- from ANY
    			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

    	frozen standard_is_equal (other: like Current): BOOLEAN
    			-- Is `other' attached to an object of the same type
    			-- as current object, and field-by-field identical to it?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			same_type: Result implies same_type (other)
    			symmetric: Result implies other.standard_is_equal (Current)

    feature -- Status report

    	conforms_to (other: ANY): BOOLEAN
    			-- Does type of current object conform to type
    			-- of `other' (as per Eiffel: The Language, chapter 13)?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void

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

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

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

    	same_type (other: ANY): BOOLEAN
    			-- Is type of current object identical to type of `other'?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			definition: Result = (conforms_to (other) and other.conforms_to (Current))

    	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_32)
    			-- 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_32)
    			-- 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_32)
    			-- 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_32)
    			-- 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_32)
    			-- 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_32)
    			-- 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_GENERAL)
    			-- 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_in_pixels (a_height: INTEGER_32)
    			-- Set height_in_pixels to `a_height' in pixels.
    		ensure
    			height_set: height_in_pixels = a_height

    	set_height_in_points (a_height: INTEGER_32)
    			-- Set height_in_points to `a_height' in points.
    		ensure
    			height_set: height_in_points = a_height

    	set_height_in_twips (a_height: INTEGER_32)
    			-- Set height_in_twips to `a_height' twips.
    		ensure
    			height_set: height_in_twips = a_height

    	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_32)
    			-- 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_32)
    			-- Set offset with `an_offset'.
    		ensure
    			offset_set: offset = an_offset

    	set_pitch_and_family (a_pitch_and_family: INTEGER_32)
    			-- 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 -- Duplication

    	frozen deep_copy (other: like Current)
    			-- Effect equivalent to that of:
    			--		copy (`other' . deep_twin)
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			deep_equal: deep_equal (Current, other)

    	frozen deep_twin: like Current
    			-- New object structure recursively duplicated from Current.
    			-- (from ANY)
    		ensure -- from ANY
    			deep_equal: deep_equal (Current, Result)

    	frozen standard_copy (other: like Current)
    			-- Copy every field of `other' onto corresponding field
    			-- of current object.
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    			type_identity: same_type (other)
    		ensure -- from ANY
    			is_standard_equal: standard_is_equal (other)

    	frozen standard_twin: like Current
    			-- New object field-by-field identical to `other'.
    			-- Always uses default copying semantics.
    			-- (from ANY)
    		ensure -- from ANY
    			standard_twin_not_void: Result /= Void
    			equal: standard_equal (Result, Current)

    	frozen twin: like Current
    			-- New object equal to `Current'
    			-- twin calls copy; to change copying/twining semantics, redefine copy.
    			-- (from ANY)
    		ensure -- from ANY
    			twin_not_void: Result /= Void
    			is_equal: Result.is_equal (Current)

    feature -- Basic operations

    	copy (other: like Current)
    			-- Update current object using fields of object attached
    			-- to `other', so as to yield equal objects.
    			-- (from WEL_STRUCTURE)
    		require -- from ANY
    			other_not_void: other /= Void
    			type_identity: same_type (other)
    		ensure -- from ANY
    			is_equal: is_equal (other)

    	frozen default: like Current
    			-- Default value of object's type
    			-- (from ANY)

    	frozen default_pointer: POINTER
    			-- Default value of type `POINTER'
    			-- (Avoid the need to write `p'.default for
    			-- some `p' of type `POINTER'.)
    			-- (from ANY)

    	default_rescue
    			-- Process exception for routines with no Rescue clause.
    			-- (Default: do nothing.)
    			-- (from ANY)

    	frozen do_nothing
    			-- Execute a null action.
    			-- (from ANY)

    	initialize
    			-- Fill Current with zeros.
    			-- (from WEL_STRUCTURE)
    		require -- from WEL_STRUCTURE
    			exists: exists

    	initialize_with_character (a_character: CHARACTER_8)
    			-- Fill current with `a_character'.
    			-- (from WEL_STRUCTURE)
    		require -- from WEL_STRUCTURE
    			exists: exists

    	is_equal (other: like Current): BOOLEAN
    			-- Is `other' attached to an object considered
    			-- equal to current object?
    			-- (from WEL_STRUCTURE)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			symmetric: Result implies other.is_equal (Current)
    			consistent: standard_is_equal (other) implies Result

    	memory_copy (source_pointer: POINTER; length: INTEGER_32)
    			-- 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

    feature -- Output

    	io: STD_FILES
    			-- Handle to standard file setup
    			-- (from ANY)

    	out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of tagged_out.
    			-- (from ANY)

    	print (some: ANY)
    			-- Write terse external representation of `some'
    			-- on standard output.
    			-- (from ANY)

    	frozen tagged_out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of out.
    			-- (from ANY)

    feature -- Platform

    	operating_environment: OPERATING_ENVIRONMENT
    			-- Objects available from the operating system
    			-- (from ANY)

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

    indexing
    	copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
    	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
    	source: "[
    		Eiffel Software
    		356 Storke Road, Goleta, CA 93117 USA
    		Telephone 805-685-1006, Fax 805-685-6869
    		Website http://www.eiffel.com
    		Customer support http://support.eiffel.com
    	]"

    end -- class WEL_CHARACTER_FORMAT