indexing
	description: "Standard dialog box to open a file."
	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
	WEL_OPEN_FILE_DIALOG

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

feature -- Access

	file_extension_offset: INTEGER_32
			-- 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_32
			-- 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_32
			-- 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_32
			-- 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_32
			-- 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_32
			-- Dialog box creation flags.
			-- Can be a combination of the values defined in
			-- class WEL_OFN_CONSTANTS.
			-- (from WEL_FILE_DIALOG)

	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)

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

	max_file_name_length: INTEGER_32 is 1024
			-- Maximum file name length
			-- (from WEL_FILE_DIALOG)

	multiple_file_names: LIST [STRING_32]
			-- return the full path name of all selected files.
			-- (from WEL_FILE_DIALOG)
		require -- from WEL_FILE_DIALOG
			multiple_files_flag_set: has_flag ({WEL_OFN_CONSTANTS}.ofn_allowmultiselect)
		ensure -- from WEL_FILE_DIALOG
			result_not_void: Result /= Void

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

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

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

	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_32)
			-- 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_32)
			-- 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_GENERAL)
			-- 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_empty

	set_file_name (a_file_name: STRING_GENERAL)
			-- 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_GENERAL])
			-- 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_32)
			-- 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_32)
			-- 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_GENERAL)
			-- 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_GENERAL)
			-- 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 -- 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

	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

	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)

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

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