    indexing
    	description: "Objects that hold the current formatting applied while loading a RTF file."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	author: ""
    	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
    	revision: "$Revision: 56675 $"

    class interface
    	RTF_FORMAT_I

    create
    	default_create
    			-- Create `Current'

    feature -- Access

    	alignment: INTEGER_32
    			-- Alignment of text.

    	boolean_out (a_boolean: BOOLEAN): STRING_8
    			--

    	bottom_spacing: INTEGER_32
    			-- Bottom spacing

    	character_format: INTEGER_32
    			-- Current character format index.

    	character_format_out: STRING_8
    			-- Result is representation of character format attributes of `Current'.
    			-- Paragraph and formats need to be buffered independently, hence a
    			-- seperate out fetaure for each of these set of attributes.

    	color_set: BOOLEAN
    			-- Has text_color been explicitly set and does not correspond to auto?

    	false_constant: STRING_8 is "F"

    	font_height: INTEGER_32
    			-- Height of font used by format.

    	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)

    	highlight_color: INTEGER_32
    			-- Highlighting applied to text.

    	highlight_set: BOOLEAN
    			-- Has highlight_color been explicitly set and does not correspond to auto?

    	is_bold: BOOLEAN
    			-- Is format bold?

    	is_italic: BOOLEAN
    			-- Is format italic?

    	is_striked_out: BOOLEAN
    			-- Is format striken out?

    	is_underlined: BOOLEAN
    			-- Is format underlined?

    	left_margin: INTEGER_32
    			-- Left margin

    	paragraph_format_out: STRING_8
    			-- Result is representation of paragraph format attributes of `Current'.
    			-- Paragraph and formats need to be buffered independently, hence a
    			-- seperate out fetaure for each of these set of attributes.

    	reset_paragraph
    			-- Ensure all paragraph formatting attributes are reset to
    			-- default values.
    		ensure
    			alignment = alignment_left
    			left_margin = 0
    			right_margin = 0
    			top_spacing = 0
    			bottom_spacing = 0

    	right_margin: INTEGER_32
    			-- Right margin

    	text_color: INTEGER_32
    			-- Text color of format

    	top_spacing: INTEGER_32
    			-- Top spacing

    	true_constant: STRING_8 is "T"

    	vertical_offset: INTEGER_32
    			-- Vertical offset in pixels.

    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))

    	is_equal (other: like Current): BOOLEAN
    			-- Is `other' attached to an object considered
    			-- equal to current object?
    			-- (from ANY)
    		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

    	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

    	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))

    feature -- Element change

    	set_alignment (an_alignment: INTEGER_32)
    			-- Set alignment to `an_alignment'.
    		require
    			valid_alignment: valid_alignment (an_alignment)
    		ensure
    			alignment_set: alignment = an_alignment

    	set_bold (a_is_bold: BOOLEAN)
    			-- Set is_bold to `a_is_bold'.
    		ensure
    			is_bold_assigned: is_bold = a_is_bold

    	set_bottom_spacing (a_bottom_spacing: INTEGER_32)
    			-- Set bottom_spacing to `a_bottom_spacing'.
    		require
    			a_bottom_spacing_non_negative: a_bottom_spacing >= 0
    		ensure
    			bottom_spacing_assigned: bottom_spacing = a_bottom_spacing

    	set_character_format (a_character_format: INTEGER_32)
    			-- Set character_format to `a_character_format'.
    		require
    			a_character_format_non_negative: a_character_format >= 0
    		ensure
    			character_format_assigned: character_format = a_character_format

    	set_font_height (a_font_height: INTEGER_32)
    			-- Set font_height to `a_font_height'.
    		require
    			a_font_height_positive: a_font_height > 0
    		ensure
    			font_height_assigned: font_height = a_font_height

    	set_highlight_color (a_highlight_color: INTEGER_32)
    			-- Set highlight_color to `a_highlight_color'.
    		require
    			a_highlight_color_non_negative: a_highlight_color >= 0
    		ensure
    			highlight_color_assigned: highlight_color = a_highlight_color

    	set_italic (an_is_italic: BOOLEAN)
    			-- Set is_italic to `an_is_italic'.
    		ensure
    			is_italic_assigned: is_italic = an_is_italic

    	set_left_margin (a_left_margin: INTEGER_32)
    			-- Set left_margin to `a_left_margin'.
    		require
    			a_left_margin_non_negative: a_left_margin >= 0
    		ensure
    			left_margin_assigned: left_margin = a_left_margin

    	set_right_margin (a_right_margin: INTEGER_32)
    			-- Set right_margin to `a_right_margin'.
    		require
    			a_right_margin_non_negative: a_right_margin >= 0
    		ensure
    			right_margin_assigned: right_margin = a_right_margin

    	set_striked_out (an_is_striked_out: BOOLEAN)
    			-- Set is_striked_out to `an_is_striked_out'.
    		ensure
    			is_striked_out_assigned: is_striked_out = an_is_striked_out

    	set_text_color (a_text_color: INTEGER_32)
    			-- Set text_color to `a_text_color'.
    		require
    			a_text_color_non_negative: a_text_color >= 0
    		ensure
    			text_color_assigned: text_color = a_text_color

    	set_top_spacing (a_top_spacing: INTEGER_32)
    			-- Set top_spacing to `a_top_spacing'.
    		require
    			a_top_spacing_non_negative: a_top_spacing >= 0
    		ensure
    			top_spacing_assigned: top_spacing = a_top_spacing

    	set_underlined (an_is_underlined: BOOLEAN)
    			-- Set is_underlined to `an_is_underlined'.
    		ensure
    			is_underlined: is_underlined = an_is_underlined

    	set_vertical_offset (an_offset: INTEGER_32)
    			-- Set vertical_offset to `an_offset'.
    		ensure
    			offset_set: vertical_offset = an_offset

    feature -- Duplication

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

    	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

    	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)

    feature -- Constants

    	alignment_center: INTEGER_32 is 2
    			-- Aligned center.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    	alignment_justified: INTEGER_32 is 4
    			-- Justified.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    	alignment_left: INTEGER_32 is 1
    			-- Aligned left.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    	alignment_right: INTEGER_32 is 3
    			-- Aligned right.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    feature -- Contract support

    	valid_alignment (an_alignment: INTEGER_32): BOOLEAN
    			-- Is `an_alignment' a valid alignment?
    			-- (from EV_PARAGRAPH_CONSTANTS)

    	valid_paragraph_flag (a_flag: INTEGER_32): BOOLEAN
    			-- Is `a_flag' a valid paragraph flag?
    			-- Used by EV_PARAGRAPH_FORMAT_RANGE_INFORMATION.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    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 -- Paragraph flags.

    	alignment_constant: INTEGER_32 is 1
    			-- Alignment is applicable.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    	bottom_spacing_constant: INTEGER_32 is 16
    			-- Bottom spacing is applicable.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    	left_margin_constant: INTEGER_32 is 2
    			-- Left margin is applicable.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    	right_margin_constant: INTEGER_32 is 4
    			-- Right margin is applicable.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    	top_spacing_constant: INTEGER_32 is 8
    			-- Top spacing is applicable.
    			-- (from EV_PARAGRAPH_CONSTANTS)

    feature -- Platform

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

    invariant
    	character_format_non_negative: character_format >= 0
    	font_height_non_negative: font_height >= 0
    	text_color_non_negative: text_color >= 0
    	highlight_color_non_negative: highlight_color >= 0
    	left_margin_non_negative: left_margin >= 0
    	right_margin_non_negative: right_margin >= 0
    	top_spacing_non_negative: top_spacing >= 0
    	bottom_spacing_non_negative: bottom_spacing >= 0

    		-- 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 RTF_FORMAT_I