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

class interface
	WEL_PARAGRAPH_FORMAT

create 

	make
			-- Make a paragraph 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

	alignment: INTEGER
			-- Alignment type.
			-- See class WEL_PFA_CONSTANTS for values.

	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_PFM_CONSTANTS for values.
			-- This attribut is automatically set by the
			-- features set_*.

	numbering: INTEGER
			-- Numbering type

	offset: INTEGER
			-- Indentation of the second line and subsequent
			-- lines, relative to the starting indentation. The
			-- first line is indented if this member is negative,
			-- or outdented is this member is positive.

	right_indent: INTEGER
			-- Size of the right indentation, relative to the right
			-- margin

	start_indent: INTEGER
			-- Indentation of the first line in the paragraph

	tabulations: ARRAY [INTEGER]
			-- Contains tab stops
		ensure
			result_not_void: Result /= void
	
feature -- Measurement

	max_tab_stops: INTEGER

	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_mask (a_mask: INTEGER): BOOLEAN
			-- Is a_mask set in mask?
			-- See class WEL_PFM_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_mask (a_mask: INTEGER)
			-- Add a_mask to mask.
			-- See class WEL_PFM_CONSTANTS for a_mask values.
		ensure
			has_mask: has_mask (a_mask)

	bullet_numbering
			-- Add bullets.
		ensure
			bullet_numbering: numbering = pfn_bullet

	no_numbering
			-- Remove any numbering.
		ensure
			no_numbering: numbering = 0

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

	set_alignment (an_alignment: INTEGER)
			-- Set alignment with an_alignment.
			-- See class WEL_PFA_CONSTANTS for values.
		ensure
			alignment_set: alignment = an_alignment

	set_center_alignment
			-- Paragraphs are centered.
		ensure
			alignment_set: alignment = pfa_center

	set_default_tabulation
			-- Set the default tabulation.

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

	set_left_alignment
			-- Paragraphs are aligned with the left margin.
		ensure
			alignment_set: alignment = pfa_left

	set_mask (a_mask: INTEGER)
			-- Set mask with a_mask.
			-- See class WEL_PFM_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_right_alignment
			-- Paragraphs are aligned with the right margin.
		ensure
			alignment_set: alignment = pfa_right

	set_right_indent (a_right_indent: INTEGER)
			-- Set right_indent with a_right_indent.
		ensure
			right_indent_set: right_indent = a_right_indent

	set_start_indent (a_start_indent: INTEGER)
			-- Set start_indent with a_start_indent.
		ensure
			start_indent_set: start_indent = a_start_indent

	set_tabulation (tab: INTEGER)
			-- Set a tab stop at every tab.

	set_tabulations (tabs: ARRAY [INTEGER])
			-- Set tabulation stops using the values of tabs.
		require
			tabs_not_void: tabs /= void
			tabs_count: tabs.count <= max_tab_stops
		ensure
			tabulations_set: tabulations.is_equal (tabs)
	
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_PARAGRAPH_FORMAT