indexing
	description: "MDI frame window containing a MDI client window."
	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 $"

class interface
	WEL_MDI_FRAME_WINDOW


create 
	make_top (a_name: STRING_GENERAL; a_menu: WEL_MENU; first_child: INTEGER_32)
			-- Make a MDI frame window named `a_name' using
			-- `a_menu' as the application's Window menu.
			-- `first_child' specifies the child window identifier
			-- of the first MDI child window created. Windows
			-- increments the identifier for each additional
			-- MDI child window the application creates. These
			-- identifiers are used in `on_command_control_id' when
			-- a child window is chosen from the Window menu; they
			-- should not conflict with any other command
			-- identifiers.
		require
			a_name_not_void: a_name /= Void
			a_menu_not_void: a_menu /= Void
			a_menu_exists: a_menu.exists
		ensure
			parent_set: parent = Void
			exists: exists
			name_set: text.is_equal (a_name)
			client_window_not_void: client_window /= Void
			client_window_exists: client_window.exists

feature -- Access

	children: LIST [WEL_WINDOW]
			-- Construct a linear representation of children.
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
		ensure -- from WEL_COMPOSITE_WINDOW
			result_not_void: Result /= Void

	client_window: WEL_MDI_CLIENT_WINDOW
			-- MDI client window which contains child windows

	commands: WEL_COMMAND_MANAGER
			-- Command manager associated to the current window.
			-- (from WEL_WINDOW)

	default_processing: BOOLEAN
			-- (from WEL_RETURN_VALUE)

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generating_type_not_void: Result /= Void
			generating_type_not_empty: not Result.is_empty

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty

	has_return_value: BOOLEAN
			-- Should the window procedure return a value?
			-- (from WEL_RETURN_VALUE)

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

	menu: WEL_MENU
			-- Associated menu
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			has_menu: has_menu
		ensure -- from WEL_COMPOSITE_WINDOW
			result_not_void: Result /= Void

	message_return_value: POINTER
			-- Return value of the window procedure.
			-- (from WEL_RETURN_VALUE)
		require -- from WEL_RETURN_VALUE
			has_return_value: has_return_value

	parent: WEL_WINDOW
			-- Parent window
			-- (from WEL_WINDOW)

	scroller: WEL_SCROLLER
			-- Scroller object for processing scroll messages.
			-- (from WEL_COMPOSITE_WINDOW)

	system_menu: WEL_MENU
			-- Associated system menu
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			has_system_menu: has_system_menu
		ensure -- from WEL_COMPOSITE_WINDOW
			result_not_void: Result /= Void
	
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 (other /= Void and then 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 is_deep_equal (other: WEL_MDI_FRAME_WINDOW): BOOLEAN
			-- Are `Current' and `other' attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			shallow_implies_deep: standard_is_equal (other) implies Result
			same_type: Result implies same_type (other)
			symmetric: Result implies other.is_deep_equal (Current)

	is_equal (other: WEL_MDI_FRAME_WINDOW): 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: WEL_MDI_FRAME_WINDOW): 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

	absolute_x: INTEGER_32
			-- Absolute x position
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			Result = window_rect.x

	absolute_y: INTEGER_32
			-- Absolute y position
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			Result = window_rect.y

	active_window: WEL_MDI_CHILD_WINDOW
			-- Window currently active
		require
			exists: exists
			client_window_not_void: client_window /= Void
			client_window_exists: client_window.exists
			has_active_window: has_active_window

	background_brush: WEL_BRUSH
			-- Current window background color used to refresh the window when
			-- requested by the WM_ERASEBKGND windows message.
			-- By default there is no background
			-- (from WEL_WINDOW)
		ensure -- from WEL_WINDOW
			new_object: Result /= Void implies Result /= background_brush

	captured_window: WEL_WINDOW
			-- Current window which has been captured.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
			window_captured: window_captured

	child_window_from_point (point: WEL_POINT): POINTER
			-- `Result' is pointer to child window as position `point'.
			-- Only checks children and their children and returns a child even
			-- if over a HTTRANSPARENT area of the child. Corresponds to
			-- the ChildWindowFromPoint Windows API call.
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			point_not_void: point /= Void

	client_rect: WEL_RECT
			-- Client rectangle
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			result_not_void: Result /= Void

	closeable: BOOLEAN
			-- Can the user close the window?
			-- Yes by default.
			-- (from WEL_COMPOSITE_WINDOW)

	command (message: INTEGER_32): WEL_COMMAND
			-- Command associated to `message'
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			positive_message: message >= 0
			command_exists: command_exists (message)
		ensure -- from WEL_WINDOW
			result_not_void: Result /= Void

	command_argument (message: INTEGER_32): ANY
			-- Command argument associated to `message'
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			positive_message: message >= 0
			command_exists: command_exists (message)

	command_exists (message: INTEGER_32): BOOLEAN
			-- Does a command associated to `message' exist?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			positive_message: message >= 0

	commands_enabled: BOOLEAN
			-- Is the commands execution enabled?
			-- (from WEL_WINDOW)

	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

	enabled: BOOLEAN
			-- Is the window enabled for mouse and keyboard input?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	ex_style: INTEGER_32
			-- Window ex_style
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	exists: BOOLEAN
			-- Does the item exist?
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			Result = (item /= default_pointer)

	focused_window: WEL_WINDOW
			-- Current window which has the focus.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	has_active_window: BOOLEAN
			-- Is a window currently active?
		require
			exists: exists
			client_window_not_void: client_window /= Void
			client_window_exists: client_window.exists

	has_capture: BOOLEAN
			-- Does this window have the capture?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	has_focus: BOOLEAN
			-- Does this window have the focus?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	has_heavy_capture: BOOLEAN
			-- Does this window have the heavy capture?
			-- (from WEL_WINDOW)

	has_horizontal_scroll_bar: BOOLEAN
			-- Does this window have a horizontal scroll bar?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	has_menu: BOOLEAN
			-- Does the window have a menu?
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists

	has_system_menu: BOOLEAN
			-- Does the window have a system menu?
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists

	has_vertical_scroll_bar: BOOLEAN
			-- Does this window have a vertical scroll bar?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	heavy_capture_activated: BOOLEAN
			-- Is the heavy capture currently running?
			-- (i.e. is there a window in the current program
			-- with has_heavy_capture to True?)
			-- (from WEL_WINDOW)

	height: INTEGER_32
			-- Window height
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	horizontal_position: INTEGER_32
			-- Current position of the horizontal scroll box
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_exists: scroller /= Void
		ensure -- from WEL_COMPOSITE_WINDOW
			result_small_enough: Result <= maximal_horizontal_position
			result_large_enough: Result >= minimal_horizontal_position

	is_inside: BOOLEAN
			-- Is the current window inside another window?
			-- (from WEL_WINDOW)

	maximal_height: INTEGER_32
			-- Maximal height allowed for the window
			-- (from WEL_WINDOW)
		ensure -- from WEL_WINDOW
			result_large_enough: Result >= minimal_height

	maximal_horizontal_position: INTEGER_32
			-- Maxium position of the horizontal scroll box
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_exists: scroller /= Void
		ensure -- from WEL_COMPOSITE_WINDOW
			result_large_enough: Result >= minimal_horizontal_position

	maximal_vertical_position: INTEGER_32
			-- Maxium position of the vertical scroll box
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_exists: scroller /= Void
		ensure -- from WEL_COMPOSITE_WINDOW
			result_large_enough: Result >= minimal_vertical_position

	maximal_width: INTEGER_32
			-- Maximal width allowed for the window
			-- (from WEL_WINDOW)
		ensure -- from WEL_WINDOW
			result_large_enough: Result >= minimal_width

	maximized: BOOLEAN
			-- Is the window maximized?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	minimal_height: INTEGER_32
			-- Minimal height allowed for the window
			-- (from WEL_COMPOSITE_WINDOW)
		ensure -- from WEL_WINDOW
			positive_result: Result >= 0
			result_small_enough: Result <= maximal_height

	minimal_horizontal_position: INTEGER_32
			-- Minimum position of the horizontal scroll box
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_exists: scroller /= Void
		ensure -- from WEL_COMPOSITE_WINDOW
			result_small_enough: Result <= maximal_horizontal_position

	minimal_vertical_position: INTEGER_32
			-- Minimum position of the vertical scroll box
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_exists: scroller /= Void
		ensure -- from WEL_COMPOSITE_WINDOW
			result_small_enough: Result <= maximal_vertical_position

	minimal_width: INTEGER_32
			-- Minimal width allowed for the window
			-- (from WEL_COMPOSITE_WINDOW)
		ensure -- from WEL_WINDOW
			positive_result: Result >= 0
			result_small_enough: Result <= maximal_width

	minimized: BOOLEAN
			-- Is the window minimized?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	placement: WEL_WINDOW_PLACEMENT
			-- Window placement information
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			result_not_void: Result /= 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))

	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)

	shown: BOOLEAN
			-- Is the window shown?
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	style: INTEGER_32
			-- Window style
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	text: STRING_32
			-- Window text
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			result_not_void: Result /= Void

	text_length: INTEGER_32
			-- Text length
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			positive_result: Result >= 0

	valid_hwnd_constant (c: POINTER): BOOLEAN
			-- Is `c' a valid hwnd constant?
			-- (from WEL_HWND_CONSTANTS)

	vertical_position: INTEGER_32
			-- Current position of the vertical scroll box
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_exists: scroller /= Void
		ensure -- from WEL_COMPOSITE_WINDOW
			result_small_enough: Result <= maximal_vertical_position
			result_large_enough: Result >= minimal_vertical_position

	width: INTEGER_32
			-- Window width
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	window_captured: BOOLEAN
			-- Has a window been captured?
			-- (from WEL_WINDOW)

	window_rect: WEL_RECT
			-- Window rectangle (absolute position)
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			result_not_void: Result /= Void

	x: INTEGER_32
			-- Window x position
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			parent = Void implies Result = absolute_x

	y: INTEGER_32
			-- Window y position
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			parent = Void implies Result = absolute_y
	
feature -- Status setting

	disable
			-- Disable mouse and keyboard input
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			disabled: not enabled

	disable_commands
			-- Disable commands execution.
			-- (from WEL_WINDOW)
		ensure -- from WEL_WINDOW
			commands_disabled: not commands_enabled

	disable_default_processing
			-- Disable default window processing.
			-- The standard window procedure will not be called for
			-- each messages received by the window and then the
			-- normal behavior will not occur.
			-- (from WEL_WINDOW)
		ensure -- from WEL_WINDOW
			default_processing_disabled: not default_processing

	disable_drag_accept_files
			-- Disallow `Current' from being a file drag and drop target.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists

	enable
			-- Enable mouse and keyboard input.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			enabled: enabled

	enable_commands
			-- Enable commands execution.
			-- (from WEL_WINDOW)
		ensure -- from WEL_WINDOW
			commands_enabled: commands_enabled

	enable_default_processing
			-- Enable default window processing.
			-- The standard window procedure will be called for
			-- each messages received by the window and then the
			-- normal behavior will occur.
			-- (from WEL_WINDOW)
		ensure -- from WEL_WINDOW
			default_processing_enabled: default_processing

	enable_drag_accept_files
			-- Allow `Current' to be a file drag and drop target.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists

	hide
			-- Hide the window
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			hidden: not shown

	horizontal_update (inc, position: INTEGER_32)
			-- Update the window and the horizontal scroll box with
			-- `inc' and `position'.
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_not_void: scroller /= Void
			position_small_enough: scroller.valid_maximal_horizontal_position (position)
			position_large_enough: position >= minimal_horizontal_position
		ensure -- from WEL_COMPOSITE_WINDOW
			horizontal_position_set: horizontal_position = position

	maximize
			-- Maximize the window
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			maximized: maximized

	minimize
			-- Minimize the window and display its icon
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			minimized: minimized

	release_capture
			-- Release the mouse capture after a call
			-- to set_capture.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
			has_capture: has_capture
		ensure -- from WEL_WINDOW
			not_has_capture: not has_capture

	release_heavy_capture
			-- Release the mouse capture after a call
			-- to set_heavy_capture.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
			has_heavy_capture: has_heavy_capture
			heavy_capture_activated: heavy_capture_activated
		ensure -- from WEL_WINDOW
			heavy_capture_set: not has_heavy_capture
			heavy_capture_deactivated: not heavy_capture_activated

	restore
			-- Restore the window to its
			-- original size and position after
			-- minimize or maximize
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	set_capture
			-- Set the mouse capture to the `Current' window.
			-- Once the window has captured the mouse, all
			-- mouse input is directed to this window, regardless
			-- of whether the cursor is over that window. Only
			-- one window can have the mouse capture at a time.
			--
			-- Works only for windows in the same thread as your
			-- application.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
			has_not_capture: not has_capture
			has_not_heavy_capture: not has_heavy_capture
		ensure -- from WEL_WINDOW
			has_capture: has_capture

	set_ex_style (an_ex_style: INTEGER_32)
			-- Set `an_ex_style' with ex_style.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	set_focus
			-- Set the focus to `Current'
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	set_heavy_capture
			-- Set the mouse capture to the `Current' window.
			-- Once the window has captured the mouse, all
			-- mouse input is directed to this window, regardless
			-- of whether the cursor is over that window. Only
			-- one window can have the mouse capture at a time.
			--
			-- Works for ALL windows.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
			has_not_heavy_capture: not has_heavy_capture
			heavy_capture_deactivated: not heavy_capture_activated
		ensure -- from WEL_WINDOW
			heavy_capture_set: has_heavy_capture implies heavy_capture_activated

	set_horizontal_position (position: INTEGER_32)
			-- Set horizontal_position with `position'.
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_exists: scroller /= Void
			position_small_enough: scroller.valid_maximal_horizontal_position (position)
			position_large_enough: position >= minimal_horizontal_position
		ensure -- from WEL_COMPOSITE_WINDOW
			horizontal_position_set: horizontal_position = position

	set_horizontal_range (minimum, maximum: INTEGER_32)
			-- Set minimal_horizontal_position and
			-- maximal_horizontal_position with `minimum' and
			-- `maximum'.
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			scroller_exists: scroller /= Void
			consistent_range: minimum <= maximum
		ensure -- from WEL_COMPOSITE_WINDOW
			minimal_horizontal_position_set: minimal_horizontal_position = minimum
			maximal_horizontal_position_set: maximal_horizontal_position = maximum

	set_icon (a_small_icon: WEL_ICON; a_big_icon: WEL_ICON)
			-- Set the small (16x16) and the normal (32x32) icon for this window.
			--
			-- Note: Set `a_small_icon' to Void to remove the small icon and
			--       `a_big_icon' to Void to remove the big icon.
			-- (from WEL_COMPOSITE_WINDOW)

	set_menu (a_menu: WEL_MENU)
			-- Set menu with `a_menu'.
			-- (from WEL_COMPOSITE_WINDOW)
		require -- from WEL_COMPOSITE_WINDOW
			exists: exists
			a_menu_not_void: a_menu /= Void
			a_menu_exists: a_menu.exists
		ensure -- from WEL_COMPOSITE_WINDOW