indexing
	description: "EiffelVision file selection dialog."
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-03-22 23:29:03 -0800 (Wed, 22 Mar 2006) $"
	revision: "$Revision: 57641 $"

deferred class interface
	EV_FILE_DIALOG

feature -- Access

	blocking_window: EV_WINDOW
			-- Window `Current' is a transient for.
			-- (from EV_STANDARD_DIALOG)
		require -- from EV_STANDARD_DIALOG
			not_destroyed: not is_destroyed
		ensure -- from EV_STANDARD_DIALOG
			bridge_ok: Result = implementation.blocking_window

	data: ANY
			-- Arbitrary user data may be stored here.
			-- (from EV_ANY)

	file_name: STRING_32
			-- Full name of currently selected file including path.
			-- `empty' if user did not click "OK".
		require
			not_destroyed: not is_destroyed
		ensure
			file_name_not_void: Result /= Void
			bridge_ok: not Result.is_empty implies Result.is_equal (implementation.file_name)

	filters: ARRAYED_LIST [TUPLE [STRING_GENERAL, STRING_GENERAL]]
			-- All filters currently applied to file list.
			-- First STRING represents the filter e.g "*.txt".
			-- Second STRING represents the displayed text
			-- e.g. "Text files (*.txt)".
			-- Multiple filters may be grouped as one
			-- Through seperation by a semicolon e.g.
			-- pass "*.txt;*.rtf;*.doc" as the filter.
		require
			not_destroyed: not is_destroyed
		ensure
			bridge_ok: Result = implementation.filters

	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)

	start_directory: STRING_32
			-- Base directory where browsing will start.
		require
			not_destroyed: not is_destroyed
		ensure
			bridge_ok: Result.is_equal (implementation.start_directory)

	title: STRING_32
			-- Title of `Current' displayed in title bar.
			-- (from EV_STANDARD_DIALOG)
		require -- from EV_STANDARD_DIALOG
			not_destroyed: not is_destroyed
		ensure -- from EV_STANDARD_DIALOG
			bridge_ok: Result.is_equal (implementation.title)
			cloned: Result /= implementation.title
	
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

	file_path: STRING_32
			-- Path of file_name.
			-- is_empty if user did not click "OK".
		require
			not_destroyed: not is_destroyed
		ensure
			file_path_not_void: Result /= Void
			bridge_ok: not Result.is_empty implies Result.is_equal (implementation.file_path)

	file_title: STRING_32
			-- file_name without its path.
			-- is_empty if user did not click "OK".
		require
			not_destroyed: not is_destroyed
		ensure
			file_title_not_void: Result /= Void
			bridge_ok: not Result.is_empty implies Result.is_equal (implementation.file_title)

	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_button: STRING_32
			-- Label of last clicked button.
			-- (from EV_STANDARD_DIALOG)
		require -- from EV_STANDARD_DIALOG
			not_destroyed: not is_destroyed
		ensure -- from EV_STANDARD_DIALOG
			bridge_ok: Result /= Void implies Result.is_equal (implementation.selected_button)

	selected_filter_index: INTEGER_32
			-- One based index of selected filter within filters, or
			-- zero if no filters set.
		require
			not_destroyed: not is_destroyed
		ensure
			result_zero_when_no_filters: filters.is_empty implies Result = 0
			valid_result_when_filters_set: not filters.is_empty implies Result >= 1 and Result <= filters.count
	
feature -- Status setting

	set_height (a_height: INTEGER_32)
			-- Assign `a_height' to height in pixels.
			-- (from EV_POSITIONABLE)
		require -- from EV_POSITIONABLE
			not_destroyed: not is_destroyed
			a_height_positive_or_zero: a_height >= 0
		ensure -- from EV_POSITIONABLE
			height_assigned: height = minimum_height or else height = a_height

	set_position (a_x, a_y: INTEGER_32)
			-- Assign `a_x' to x_position and `a_y' to y_position in pixels.
			-- (from EV_POSITIONABLE)
		require -- from EV_POSITIONABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONABLE
			x_position_assigned: x_position = a_x
			y_position_assigned: y_position = a_y

	set_size (a_width, a_height: INTEGER_32)
			-- Assign `a_width' to width and `a_height' to height in pixels.
			-- (from EV_POSITIONABLE)
		require -- from EV_POSITIONABLE
			not_destroyed: not is_destroyed
			a_width_positive_or_zero: a_width >= 0
			a_height_positive_or_zero: a_height >= 0
		ensure -- from EV_POSITIONABLE
			width_assigned: width = minimum_width or else width = a_width
			height_assigned: height = minimum_height or else height = a_height

	set_title (a_title: STRING_GENERAL)
			-- Assign `a_title' to title.
			-- (from EV_STANDARD_DIALOG)
		require -- from EV_STANDARD_DIALOG
			not_destroyed: not is_destroyed
			a_title_not_void: a_title /= Void
		ensure -- from EV_STANDARD_DIALOG
			assigned: title.is_equal (a_title)
			cloned: title /= a_title

	set_width (a_width: INTEGER_32)
			-- Assign `a_width' to width in pixels.
			-- (from EV_POSITIONABLE)
		require -- from EV_POSITIONABLE
			not_destroyed: not is_destroyed
			a_width_positive_or_zero: a_width >= 0
		ensure -- from EV_POSITIONABLE
			width_assigned: width = minimum_width or else width = a_width

	set_x_position (a_x: INTEGER_32)
			-- Assign `a_x' to x_position in pixels.
			-- (from EV_POSITIONABLE)
		require -- from EV_POSITIONABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONABLE
			x_position_assigned: x_position = a_x

	set_y_position (a_y: INTEGER_32)
			-- Assign `a_y' to y_position in pixels.
			-- (from EV_POSITIONABLE)
		require -- from EV_POSITIONABLE
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONABLE
			y_position_assigned: y_position = a_y

	show_modal_to_window (a_window: EV_WINDOW)
			-- Show and wait until `Current' is closed.
			-- `Current' is shown modal with respect to `a_window'.
			-- (from EV_STANDARD_DIALOG)
		require -- from EV_STANDARD_DIALOG
			not_destroyed: not is_destroyed
			a_window_not_void: a_window /= Void
			dialog_modeless: blocking_window = Void
		ensure -- from EV_STANDARD_DIALOG
			dialog_closed_so_no_blocking_window: not is_destroyed implies blocking_window = Void
	
feature -- Element change

	set_data (some_data: like data)
			-- Assign `some_data' to data.
			-- (from EV_ANY)
		require -- from EV_ANY
			not_destroyed: not is_destroyed
		ensure -- from EV_ANY
			data_assigned: data = some_data

	set_file_name (a_name: STRING_GENERAL)
			-- Make `a_name' the selected file.
		require
			not_destroyed: not is_destroyed
			a_name_not_void: a_name /= Void
			valid_file_name: valid_file_name (a_name)
		ensure
			assigned: not file_name.is_empty implies file_name.is_equal (a_name)

	set_start_directory (a_path: STRING_GENERAL)
			-- Make `a_path' the base directory.
		require
			not_destroyed: not is_destroyed
			a_path_not_void: a_path /= Void
		ensure
			assigned: start_directory.is_equal (a_path)
	
feature -- Duplication

	copy (other: like Current)
			-- Update current object using fields of object attached
			-- to `other', so as to yield equal objects.
			-- (from EV_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 -- Command

	destroy
			-- Destroy underlying native toolkit object.
			-- Render `Current' unusable.
			-- (from EV_ANY)
		ensure -- from EV_ANY
			is_destroyed: is_destroyed
	
feature -- Contract Support

	valid_file_name (a_name: STRING_GENERAL): BOOLEAN
			-- Is `a_name' a valid file_name on the current platform?
			-- Certain characters are not permissible and this is dependent
			-- on the current platform. The following characters are not permitted,
			-- and this list may not be exhaustive:
			-- Windows - " * < > ? |
			-- Linux - *
		require
			not_destroyed: not is_destroyed

	valid_file_title (a_title: STRING_GENERAL): BOOLEAN
			-- Is `a_title' a valid file title on the current platform?
			-- The following characters are not permitted,
			-- and this list may not be exhaustive:
			-- Windows - " * / : < > ? \ |
			-- Linux - *
		require
			not_destroyed: not is_destroyed
	
feature -- Event handling

	cancel_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Actions to be performed when user cancels.
			-- (from EV_STANDARD_DIALOG_ACTION_SEQUENCES)
		ensure -- from EV_STANDARD_DIALOG_ACTION_SEQUENCES
			not_void: Result /= Void

	ok_actions: EV_NOTIFY_ACTION_SEQUENCE
			-- Actions to be performed when user clicks OK.
			-- Note: This is renamed in some descendents
			-- i.e. in EV_PRINT_DIALOG it is renamed to print_actions
			-- and is performed when the user clicks "print".
			-- (from EV_STANDARD_DIALOG_ACTION_SEQUENCES)
		ensure -- from EV_STANDARD_DIALOG_ACTION_SEQUENCES
			not_void: Result /= Void
	
feature -- Measurement 

	height: INTEGER_32
			-- Vertical size in pixels.
			-- Same as minimum_height when not displayed.
			-- (from EV_POSITIONED)
		require -- from EV_POSITIONED
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONED
			bridge_ok: Result = implementation.height

	minimum_height: INTEGER_32
			-- Lower bound on height in pixels.
			-- (from EV_POSITIONED)
		require -- from EV_POSITIONED
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONED
			bridge_ok: Result = implementation.minimum_height
			positive_or_zero: Result >= 0

	minimum_width: INTEGER_32
			-- Lower bound on width in pixels.
			-- (from EV_POSITIONED)
		require -- from EV_POSITIONED
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONED
			bridge_ok: Result = implementation.minimum_width
			positive_or_zero: Result >= 0

	width: INTEGER_32
			-- Horizontal size in pixels.
			-- Same as minimum_width when not displayed.
			-- (from EV_POSITIONED)
		require -- from EV_POSITIONED
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONED
			bridge_ok: Result = implementation.width

	x_position: INTEGER_32
			-- Horizontal offset relative to parent x_position in pixels.
			-- (from EV_POSITIONED)
		require -- from EV_POSITIONED
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONED
			bridge_ok: Result = implementation.x_position

	y_position: INTEGER_32
			-- Vertical offset relative to parent y_position in pixels.
			-- (from EV_POSITIONED)
		require -- from EV_POSITIONED
			not_destroyed: not is_destroyed
		ensure -- from EV_POSITIONED
			bridge_ok: Result = implementation.y_position
	
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)
	
feature -- Status Report

	is_destroyed: BOOLEAN
			-- Is `Current' no longer usable?
			-- (from EV_ANY)
		ensure -- from EV_ANY
			bridge_ok: Result = implementation.is_destroyed
	
invariant
	filters_not_void: filters /= Void
	start_directory_not_void: start_directory /= Void
	file_name_not_void_implies_path_and_title_not_void: file_name /= Void implies (file_title /= Void and then file_path /= Void)
	valid_file_name: file_name /= Void implies valid_file_name (file_name)
	valid_file_title: file_title /= Void implies valid_file_title (file_title)

		-- from EV_STANDARD_DIALOG
	title_not_void: is_usable implies title /= Void

		-- from EV_ANY
	is_initialized: is_initialized
	is_coupled: implementation /= Void and then implementation.interface = Current
	default_create_called: default_create_called

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

		-- from EV_POSITIONED
	width_not_negative: is_usable implies width >= 0
	height_not_negative: is_usable implies height >= 0
	minimum_width_not_negative: is_usable implies minimum_width >= 0
	minimum_height_not_negative: is_usable implies minimum_height >= 0

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_FILE_DIALOG