indexing
	description: "[
		Objects that provide information for a range of lines in an EV_RICH_TEXT.
		Depending on the query applied to `Current', the values of all attributes are used in different
		fashions, sometimes to indicate which fields of an EV_PARAGRAPH_FORMAT are valid, or have a particular
		property. The applicable features in EV_RICH_TEXT which use `Current' provide full descriptions.
	]"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
	revision: "$Revision: 56675 $"

class interface
	EV_PARAGRAPH_FORMAT_RANGE_INFORMATION

create 
	make_with_flags (flags: INTEGER_32)
			-- Create `Current' and apply `flags' to set attributes.
			-- Valid flags are the corresponding flags from EV_PARAGRAPH_CONSTANTS.
			-- Combine these in `flags' to set multiple attrbutes, e.g. to set the
			-- left and right margins as applicable peform:
			-- "make_with_flags (feature {EV_PARAGRAPH_CONSTANTS}.left_margin | feature {EV_PARAGRAPH_CONSTANTS}.right_margin)"
		require
			valid_paragraph_flag: valid_paragraph_flag (flags)
		ensure
			attributes_set: alignment = (flags | {EV_PARAGRAPH_CONSTANTS}.alignment = flags) and left_margin = (flags | {EV_PARAGRAPH_CONSTANTS}.left_margin = flags) and right_margin = (flags | {EV_PARAGRAPH_CONSTANTS}.right_margin = flags) and top_spacing = (flags | {EV_PARAGRAPH_CONSTANTS}.top_spacing = flags) and bottom_spacing = (flags | {EV_PARAGRAPH_CONSTANTS}.bottom_spacing = flags)

feature -- Access

	alignment: BOOLEAN
			-- Is alignment of paragraph applicable?

	bottom_spacing: BOOLEAN
			-- Is bottom spacing of paragraph applicable?

	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)

	left_margin: BOOLEAN
			-- Is left margin of paragraph applicable?

	right_margin: BOOLEAN
			-- Is right margin of paragraph applicable?

	top_spacing: BOOLEAN
			-- Is top spacing of paragraph applicable?
	
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 -- 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 {ANY} -- 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 -- Creation

	make_with_flags (flags: INTEGER_32)
			-- Create `Current' and apply `flags' to set attributes.
			-- Valid flags are the corresponding flags from EV_PARAGRAPH_CONSTANTS.
			-- Combine these in `flags' to set multiple attrbutes, e.g. to set the
			-- left and right margins as applicable peform:
			-- "make_with_flags (feature {EV_PARAGRAPH_CONSTANTS}.left_margin | feature {EV_PARAGRAPH_CONSTANTS}.right_margin)"
		require
			valid_paragraph_flag: valid_paragraph_flag (flags)
		ensure
			attributes_set: alignment = (flags | {EV_PARAGRAPH_CONSTANTS}.alignment = flags) and left_margin = (flags | {EV_PARAGRAPH_CONSTANTS}.left_margin = flags) and right_margin = (flags | {EV_PARAGRAPH_CONSTANTS}.right_margin = flags) and top_spacing = (flags | {EV_PARAGRAPH_CONSTANTS}.top_spacing = flags) and bottom_spacing = (flags | {EV_PARAGRAPH_CONSTANTS}.bottom_spacing = flags)
	
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 EV_PARAGRAPH_FORMAT_RANGE_INFORMATION