indexing
	description: "Standard dialog box to open a file."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class interface
	WEL_OPEN_FILE_DIALOG

create 

	make
			-- Make and setup the structure
			-- (from WEL_FILE_DIALOG)

feature -- Access

	file_extension_offset: INTEGER
			-- Specifies the offset from the beginning of the path
			-- to the file name extension in the string file_name.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			selected: selected
		ensure -- from WEL_FILE_DIALOG
			result_greater_than_or_equal_to_one: Result >= 1

	file_name: STRING
			-- File name selected (including path).
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			selected: selected
		ensure -- from WEL_FILE_DIALOG
			result_not_void: Result /= void

	file_name_offset: INTEGER
			-- Specifies the offset from the beginning of the path
			-- to the file name in the string file_name.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			selected: selected
		ensure -- from WEL_FILE_DIALOG
			result_greater_than_or_equal_to_one: Result >= 1

	file_title: STRING
			-- Title of the selected file (without path).
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			selected: selected
		ensure -- from WEL_FILE_DIALOG
			result_not_void: Result /= void

	filter_index: INTEGER
			-- Index of the selected filter
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			selected: selected
		ensure -- from WEL_FILE_DIALOG
			positive_result: Result >= 0

	flags: INTEGER
			-- Dialog box creation flags.
			-- Can be a combination of the values defined in
			-- class WEL_OFN_CONSTANTS.
			-- (from WEL_FILE_DIALOG)

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

	Max_file_name_length: INTEGER is 1024
			-- Maximum file name length
			-- (from WEL_FILE_DIALOG)

	multiple_file_names: LINKED_LIST [STRING]
			-- return the full path name of all selected files.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			multiple_files_flag_set: has_flag (ofn_allowmultiselect)
		ensure -- from WEL_FILE_DIALOG
			result_not_void: Result /= void

	title: STRING
			-- Title of the current dialog
			-- (from WEL_FILE_DIALOG)
		ensure -- from WEL_FILE_DIALOG
			result_not_void: Result /= void
	
feature -- Measurement

	structure_size: INTEGER
			-- Size to allocate (in bytes)
			-- (from WEL_FILE_DIALOG)
		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_flag (a_flags: INTEGER): BOOLEAN
			-- Is a_flags set in flags?
			-- See class WEL_OFN_CONSTANTS for a_flags values.
			-- (from WEL_FILE_DIALOG)

	selected: BOOLEAN
			-- Has the user selected something (file, color, etc.)?
			-- If True, the Ok button has been chosen. If False,
			-- the Cancel button has been chosen.
			-- (from WEL_STANDARD_DIALOG)

	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_flag (a_flags: INTEGER)
			-- Add a_flags to flags.
			-- See class WEL_OFN_CONSTANTS for a_flags values.
			-- (from WEL_FILE_DIALOG)
		ensure -- from WEL_FILE_DIALOG
			has_flag: has_flag (a_flags)

	remove_flag (a_flags: INTEGER)
			-- Remove a_flags from flags.
			-- See class WEL_OFN_CONSTANTS for a_flags values.
			-- (from WEL_FILE_DIALOG)
		ensure -- from WEL_FILE_DIALOG
			has_not_flag: not has_flag (a_flags)

	set_default_extension (extension: STRING)
			-- Set the default extension with extension.
			-- This extension will be automatically added to the
			-- file name if the user fails to type an extension.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			extension_not_void: extension /= void

	set_default_title
			-- Set the title bar with the default value ("Save As"
			-- or "Open")
			-- (from WEL_FILE_DIALOG)
		ensure -- from WEL_FILE_DIALOG
			default_title_set: title.is_equal ("")

	set_file_name (a_file_name: STRING)
			-- Set file_name with a_file and initialize
			-- the file name edit control.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			a_file_name_not_void: a_file_name /= void
			a_file_name_count_ok: a_file_name.count <= max_file_name_length
		ensure -- from WEL_FILE_DIALOG
			file_name_set: file_name.is_equal (a_file_name)

	set_filter (filter_names, filter_patterns: ARRAY [STRING])
			-- Set the file type combo box.
			-- filter_names is an array of string containing
			-- the filter names and filter_patterns is an
			-- array of string containing the filter patterns.
			-- Example:
			--	filter_names = <<"Text file", "All file">>
			--	filter_patterns = <<"*.txt", "*.*">>
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			filter_names_not_void: filter_names /= void
			filter_patterns_not_void: filter_patterns /= void
			same_count: filter_names.count = filter_patterns.count
			no_void_name: not filter_names.has (void)
			no_void_pattern: not filter_patterns.has (void)

	set_filter_index (a_filter_index: INTEGER)
			-- Set filter_index with a_filter_index.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			positive_filter_index: a_filter_index >= 0
		ensure -- from WEL_FILE_DIALOG
			filter_index_set: filter_index = a_filter_index

	set_flags (a_flags: INTEGER)
			-- Set flags with a_flags.
			-- See class WEL_OFN_CONSTANTS for a_flags values.
			-- (from WEL_FILE_DIALOG)
		ensure -- from WEL_FILE_DIALOG
			flags_set: flags = a_flags

	set_initial_directory (directory: STRING)
			-- Set the initial directory with directory.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			directory_not_void: directory /= void

	set_initial_directory_as_current
			-- Set the initial directory as the current one.
			-- (from WEL_FILE_DIALOG)

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

	set_title (a_title: STRING)
			-- Set title with a_title and use this string to
			-- display the title.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			a_title_not_void: a_title /= void
		ensure -- from WEL_FILE_DIALOG
			title_set: title.is_equal (a_title)
	
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

	activate (a_parent: WEL_COMPOSITE_WINDOW)
			-- Activate the dialog box (modal mode) with
			-- a_parent as owner.
		require -- from WEL_STANDARD_DIALOG
			a_parent_not_void: a_parent /= void
			a_parent_exists: a_parent.exists

	structure_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)
		-- from WEL_FILE_DIALOG
	str_file_name_not_void: str_file_name /= void
	str_file_name_exists: str_file_name.exists
	str_file_title_not_void: str_file_title /= void
	str_file_title_exists: str_file_title.exists
	str_title_not_void: str_title /= void
	str_title_exists: str_title.exists

end -- class WEL_OPEN_FILE_DIALOG