indexing
	description: "[
		Small pop-up window that displays a single line of
		descriptive text giving the purpose of tools.
		
		Note: The common controls dll (WEL_COMMON_CONTROLS_DLL) needs to
		be loaded to use this control.
	]"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-11-14 09:30:31 -0800 (Tue, 14 Nov 2006) $"
	revision: "$Revision: 65047 $"

class interface
	WEL_TOOLTIP


create 
	make (a_parent: WEL_WINDOW; an_id: INTEGER_32)
			-- Create a tooltip control with `a_parent' as parent
			-- and `an_id' as id.
		require
			a_parent_not_void: a_parent /= Void
		ensure
			exists: exists
			parent_set: parent = a_parent
			id_set: id = an_id

	make_by_id (a_parent: WEL_DIALOG; an_id: INTEGER_32)
			-- Make a control identified by `an_id' with `a_parent'
			-- as parent.
			-- (from WEL_CONTROL)
		require -- from WEL_CONTROL
			a_parent_not_void: a_parent /= Void
			positive_id: an_id > 0
		ensure -- from WEL_CONTROL
			parent_set: parent = a_parent
			id_set: id = an_id

	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

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

	default_processing: BOOLEAN
			-- (from WEL_RETURN_VALUE)

	font: WEL_FONT
			-- Font with which the control is drawing its text.
			-- (from WEL_CONTROL)
		require -- from WEL_CONTROL
			exists: exists
		ensure -- from WEL_CONTROL
			result_not_void: Result /= Void

	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)

	i_th_tool_info (index: INTEGER_32): WEL_TOOL_INFO
			-- Tool info structure at the zero-based `index'
		require
			exists: exists
			index_large_enough: index >= 0
			index_small_enough: index < count
		ensure
			result_not_void: Result /= Void

	id: INTEGER_32
			-- Control id
			-- (from WEL_CONTROL)

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

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

	autopop_delay_time: INTEGER_32
			-- Length of time (in milliseconds) before the
			-- tooltip window is hidden if the cursor remains
			-- stationary in the tool's bounding rectangle after
			-- the tooltip window has appeared.
		require
			exists: exists
		ensure
			positive_result: Result >= 0

	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

	background_color: WEL_COLOR_REF
			-- Background color used for the tooltip.
		require
			exists: exists
		ensure
			result_not_void: Result /= Void

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

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

	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

	count: INTEGER_32
			-- Count of tools
		require
			exists: exists
		ensure
			positive_result: Result >= 0

	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_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_system_font: BOOLEAN
			-- Does the control use the system font?
			-- (from WEL_CONTROL)
		require -- from WEL_CONTROL
			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

	initial_delay_time: INTEGER_32
			-- Length of time (in milliseconds) that the
			-- cursor must remain stationary within the bounding
			-- rectangle of a tool before the tooltip window is
			-- displayed.
		require
			exists: exists
		ensure
			positive_result: Result >= 0

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

	max_tip_width: INTEGER_32
			-- Maximum width that tooltip window will be displayed.
			-- -1 if set_max_tip_width has not been called.
		require
			exists
		ensure
			result_valid: Result >= -1

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

	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
			-- Zero by default.
			-- (from WEL_WINDOW)
		ensure -- from WEL_WINDOW
			positive_result: Result >= 0
			result_small_enough: Result <= maximal_height

	minimal_width: INTEGER_32
			-- Minimal width allowed for the window
			-- Zero by default.
			-- (from WEL_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

	reshow_delay_time: INTEGER_32
			-- Length of the delay (in milliseconds) before
			-- subsequent tooltip windows are displayed when the
			-- cursor is moved from one tool to another.
		require
			exists: exists
		ensure
			positive_result: Result >= 0

	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_color: WEL_COLOR_REF
			-- Color used for the text of the tooltip.
		require
			exists: exists
		ensure
			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)

	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

	activate
			-- Activate the tooltip control.
		require
			exists: exists

	deactivate
			-- Deactivate the tooltip control.
		require
			exists: exists

	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

	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_automatic_delay_time (delay: INTEGER_32)
			-- Set automatically the initial, reshow, and
			-- autopopup durations based on the value of
			-- `delay' (in milliseconds).
		require
			exists: exists
			positive_delay: delay >= 0

	set_autopop_delay_time (delay: INTEGER_32)
			-- Set the length of time (in milliseconds) before the
			-- tooltip window is hidden if the cursor remains
			-- stationary in the tool's bounding rectangle after
			-- the tooltip window has appeared.
		require
			exists: exists
			positive_delay: delay >= 0

	set_background_color (a_color: WEL_COLOR_REF)
			-- Background color used for the tooltip.
		require
			exists: exists
			color_not_void: a_color /= Void
		ensure
			color_set: background_color.red = a_color.red and then background_color.green = a_color.green and then background_color.blue = a_color.blue

	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_initial_delay_time (delay: INTEGER_32)
			-- Set the length of time (in milliseconds) that the
			-- cursor must remain stationary within the bounding
			-- rectangle of a tool before the tooltip window is
			-- displayed.
		require
			exists: exists
			positive_delay: delay >= 0

	set_max_tip_width (a_width: INTEGER_32)
			-- Set the maximum width for the tooltip window. If this
			-- is set, then the text will be word wrapped to this width,
			-- and newline characters will be processed.
		require
			exists: exists
			poisitive_width: a_width >= 0

	set_reshow_delay_time (delay: INTEGER_32)
			-- Set the length of the delay (in milliseconds) before
			-- subsequent tooltip windows are displayed when the
			-- cursor is moved from one tool to another.
		require
			exists: exists
			positive_delay: delay >= 0

	set_shared
			-- Set shared to True.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			shared: shared

	set_style (a_style: INTEGER_32)
			-- Set style with `a_style'.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	set_text_color (a_color: WEL_COLOR_REF)
			-- Color used for the text of the tooltip.
		require
			exists: exists
			color_not_void: a_color /= Void
		ensure
			color_set: text_color.red = a_color.red and then text_color.green = a_color.green and then text_color.blue = a_color.blue

	set_unshared
			-- Set shared to False.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			unshared: not shared

	show
			-- Show the window
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	update_cached_style (new_ex_style, old_ex_style: INTEGER_32)
			-- Update Window cache buffer for Window style.
			-- (from WEL_WINDOW)
	
feature -- Element change

	disable_redraw
			-- Disable redrawing of `Current' until next call to enable_redraw.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	enable_redraw
			-- Ensure `Current' is redrawn as required.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists

	has_system_window_locked: BOOLEAN
			-- Is there any window locked ?
			-- (from WEL_WINDOW)

	lock_window_update
			-- Disables drawing in the current window. A locked window cannot be moved.
			-- Only one window can be locked at a time. To unlock a window locked with
			-- lock_window_update , call 'unlock_window_update'.
			-- (from WEL_WINDOW)
		require -- from WEL_WINDOW
			exists: exists
		ensure -- from WEL_WINDOW
			has_system_window_locked

	set_font (a_font: WEL_FONT)
			-- Set font with `a_font'.
			-- (from WEL_CONTROL)
		require -- from WEL_CONTROL
			exists: exists
			a_font_not_void: a_font /= Void
			a_font_exists: a_font.exists
		ensure -- from WEL_CONTROL
			font_set: not has_system_font implies font.