    indexing
    	description: "Eiffel Vision Simple application.%NBase for root class in a simple application.%NInherit and define prepare."
    	legal: "See notice at end of class."
    	status: "See notice at end of class."
    	keywords: "application, accelerator, event loop"
    	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
    	revision: "$Revision: 56675 $"

    deferred class interface
    	EV_SIMPLE_APPLICATION

    feature -- Access

    	captured_widget: EV_WIDGET
    			-- Widget currently captured. Void if none.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed

    	clipboard: EV_CLIPBOARD
    			-- Native platform clipboard access.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    		ensure -- from EV_APPLICATION
    			not_void: Result /= Void
    			bridge_ok: Result.is_equal (implementation.clipboard)

    	contextual_help_accelerator: EV_ACCELERATOR
    			-- Accelerator that enables contextual help mode
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    		ensure -- from EV_APPLICATION
    			not_void: Result /= Void
    			bridge_ok: Result.is_equal (implementation.contextual_help_accelerator)

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

    	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)

    	help_accelerator: EV_ACCELERATOR
    			-- Accelerator that displays contextual help
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    		ensure -- from EV_APPLICATION
    			not_void: Result /= Void
    			bridge_ok: Result.is_equal (implementation.help_accelerator)

    	help_engine: EV_HELP_ENGINE
    			-- Object that handles contextual help display requests
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    		ensure -- from EV_APPLICATION
    			not_void: Result /= Void
    			bridge_ok: Result.is_equal (implementation.help_engine)

    	locked_window: EV_WINDOW
    			-- Window currently locked. Void if no window
    			-- is currently locked.
    			--
    			-- See `{EV_WINDOW}.lock_update' for more details
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed

    	windows: LINEAR [EV_WINDOW]
    			-- All of the application's windows.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    		ensure -- from EV_APPLICATION
    			not_void: Result /= Void
    			bridge_ok: Result.is_equal (implementation.windows)

    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

    	alt_pressed: BOOLEAN
    			-- Is alt key currently pressed?
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed

    	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

    	ctrl_pressed: BOOLEAN
    			-- Is ctrl key currently pressed?
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed

    	default_tooltip_delay: INTEGER_32 is 500
    			-- Default delay in milleseconds for tooltips.
    			-- (from EV_APPLICATION)

    	focused_widget: EV_WIDGET
    			-- Widget that has keyboard focus.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    		ensure -- from EV_APPLICATION
    			bridge_ok: Result = implementation.focused_widget

    	is_launched: BOOLEAN
    			-- Has launch been called?
    			-- (from EV_APPLICATION)

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

    	shift_pressed: BOOLEAN
    			-- Is shift key currently pressed?
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed

    	tooltip_delay: INTEGER_32
    			-- Time in milliseconds which the pointer must be stationary over
    			-- a widget before a tooltip appears.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    		ensure -- from EV_APPLICATION
    			bridge_ok: Result = implementation.tooltip_delay

    feature -- Status setting

    	set_tooltip_delay (a_delay: INTEGER_32)
    			-- Assign `a_delay' to tooltip_delay.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			a_delay_non_negative: a_delay >= 0
    		ensure -- from EV_APPLICATION
    			assigned: tooltip_delay = a_delay

    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

    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 -- Basic operation

    	display_help_for_widget (a_widget: EV_WIDGET)
    			-- Display contextual help for `a_widget', if any.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			a_widget_not_void: a_widget /= Void

    	enable_contextual_help
    			-- Change mouse cursor to help cursor.
    			-- Capture mouse input.
    			-- Send help context of widget being clicked to help engine for
    			-- processing.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed

    	launch
    			-- Start the application.
    			-- This begins the event processing loop.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			not_already_launched: not is_launched
    		ensure -- from EV_APPLICATION
    			is_launched: is_launched

    	process_events
    			-- Process any pending events.
    			-- Pass control to the underlying native toolkit so that it can
    			-- handle any events that may be in its queue.
    			-- (Should be called from time to time during extended computation.)
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			is_launched: is_launched

    	process_events_until_stopped
    			-- Process all events until 'stop_processing' is called.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			is_launched: is_launched

    	sleep (msec: INTEGER_32)
    			-- Wait for `msec' milliseconds and return.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			msec_non_negative: msec >= 0

    	stop_processing
    			--  Exit process_events_until_stopped.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			is_launched: is_launched

    feature -- Command

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

    feature -- Element Change

    	set_contextual_help_accelerator (an_accelerator: EV_ACCELERATOR)
    			-- Assign `an_accelerator' to contextual_help_accelerator
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			an_accelerator_not_void: an_accelerator /= Void
    		ensure -- from EV_APPLICATION
    			contextual_help_accelerator_assigned: contextual_help_accelerator = an_accelerator

    	set_help_accelerator (an_accelerator: EV_ACCELERATOR)
    			-- Assign `an_accelerator' to help_accelerator
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			an_accelerator_not_void: an_accelerator /= Void
    		ensure -- from EV_APPLICATION
    			help_accelerator_assigned: help_accelerator = an_accelerator

    	set_help_engine (an_engine: EV_HELP_ENGINE)
    			-- Assign `an_engine' to help_engine
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed
    			an_engine_not_void: an_engine /= Void
    		ensure -- from EV_APPLICATION
    			help_engine_set: help_engine = an_engine

    feature -- Event handling

    	add_idle_action (a_idle_action: PROCEDURE [ANY, TUPLE])
    			-- Extend idle_actions with `a_idle_action'.
    			-- Thread safe
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			a_idle_action_not_void: a_idle_action /= Void

    	cancel_actions: EV_PND_ACTION_SEQUENCE
    			-- Actions to be performed when a PND is cancelled.
    			-- A cancel may be initiated in a number of ways depending on the transport
    			-- type, including attempting to drop on a target that does not accept
    			-- transported pebble.
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	destroy_actions: EV_NOTIFY_ACTION_SEQUENCE
    			-- Actions to be performed when destroying current application.
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)

    	do_once_on_idle (an_action: PROCEDURE [ANY, TUPLE])
    			-- Perform `an_action' one time when the application is next idle.
    			-- Thread safe
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			not_destroyed: not is_destroyed

    	drop_actions: EV_PND_ACTION_SEQUENCE
    			-- Actions to be performed when any "drop" occurs.
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	focus_in_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET]]
    			-- Actions to be performed when getting focus with open arguments
    			-- widget: EV_WIDGET
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	focus_out_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET]]
    			-- Actions to be performed when losing focus with open arguments
    			-- widget: EV_WIDGET
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	idle_actions: EV_NOTIFY_ACTION_SEQUENCE
    			-- Actions to be performed when the application is otherwise idle.
    			-- Use of idle_actions is not thread-safe.  For thread-safe idle
    			-- actions handling use 'add_idle_action', remove_idle_action
    			-- or do_once_on_idle in conjunction with EV_THREAD_APPLICATION.
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	key_press_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET, EV_KEY]]
    			-- Actions to be performed when a keyboard key is pressed with open arguments
    			-- widget: EV_WIDGET; key: EV_KEY
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	key_press_string_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET, STRING_GENERAL]]
    			-- Actions to be performed when a keyboard press generates a displayable character with
    			-- open arguments widget: EV_WIDGET; string: STRING_GENERAL
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	key_release_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET, EV_KEY]]
    			-- Actions to be performed when a keyboard key is released with open arguments
    			-- widget: EV_WIDGET; key: EV_KEY
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	mouse_wheel_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET, INTEGER_32]]
    			-- Actions to be performed when mouse wheel is rotated with open arguments
    			-- widget: EV_WIDGET; delta: INTEGER
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	pick_actions: EV_PND_ACTION_SEQUENCE
    			-- Actions to be performed when any "pick" occurs.
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	pnd_motion_actions: EV_PND_MOTION_ACTION_SEQUENCE
    			-- Actions to be performed when screen pointer is moved,
    			-- during a pick and drop. The "pick and drop" argument
    			-- is the current EV_ABSTRACT_PICK_AND_DROPABLE below the
    			-- pointer position, or Void if the drop_actions for this
    			-- item are empty.
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	pointer_button_press_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET, INTEGER_32, INTEGER_32, INTEGER_32]]
    			-- Actions to be performed when screen pointer button is pressed with open arguments
    			-- widget: EV_WIDGET; button, screen_x, screen_y: INTEGER
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	pointer_button_release_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET, INTEGER_32, INTEGER_32, INTEGER_32]]
    			-- Actions to be performed when screen pointer button is released with open arguments
    			-- widget: EV_WIDGET; button, screen_x, screen_y: INTEGER
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	pointer_double_press_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET, INTEGER_32, INTEGER_32, INTEGER_32]]
    			-- Actions to be performed when screen pointer is double clicked with open arguments
    			-- widget: EV_WIDGET; button, screen_x, screen_y: INTEGER
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	pointer_motion_actions: ACTION_SEQUENCE [TUPLE [EV_WIDGET, INTEGER_32, INTEGER_32]]
    			-- Actions to be performed when screen pointer moves with open arguments
    			-- widget: EV_WIDGET; screen_x, screen_y: INTEGER
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	post_launch_actions: EV_NOTIFY_ACTION_SEQUENCE
    			-- Actions to be performed just after application launch.
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	remove_idle_action (a_idle_action: PROCEDURE [ANY, TUPLE])
    			-- Remove `a_idle_action' from idle_actions.
    			-- Thread safe.
    			-- (from EV_APPLICATION)
    		require -- from EV_APPLICATION
    			a_idle_action_not_void: a_idle_action /= Void

    	theme_changed_actions: EV_NOTIFY_ACTION_SEQUENCE
    			-- Actions to be performed when operation system theme changed
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    	uncaught_exception_actions: ACTION_SEQUENCE [TUPLE [EXCEPTION]]
    			-- Actions to be performed when an
    			-- action sequence called via callback
    			-- from the underlying toolkit raises an
    			-- exception that is not caught
    			-- (from EV_APPLICATION_ACTION_SEQUENCES)
    		ensure -- from EV_APPLICATION_ACTION_SEQUENCES
    			not_void: Result /= Void

    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
    		-- from EV_APPLICATION
    	tooltip_delay_not_negative: tooltip_delay >= 0
    	windows_not_void: windows /= 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)

    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_SIMPLE_APPLICATION