Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "Eiffel Vision Application.%NTo start an Eiffel Vision application: create exactly oneEV_APPLICATION object and call launch after setting up initialwindow(s)" legal: "See notice at end of class." status: "See notice at end of class." keywords: "application, accelerator, event loop" date: "$Date: 2016-09-27 07:50:48 -0800 (Tue, 27 Sep 2016) $" revision: "$Revision: 99192 $" class interface EV_APPLICATION create default_create -- Standard creation procedure. -- (from EV_ANY) require -- from ANY True ensure then -- from EV_ANY is_coupled: implementation /= Void is_initialized: is_initialized default_create_called: default_create_called is_in_default_state: is_in_default_state feature -- Access captured_widget: detachable EV_WIDGET -- Widget currently captured. Void if none. require not_destroyed: not is_destroyed clipboard: EV_CLIPBOARD -- Native platform clipboard access. require not_destroyed: not is_destroyed ensure not_void: Result /= Void bridge_ok: Result.is_equal (implementation.clipboard) contextual_help_accelerator: EV_ACCELERATOR -- Accelerator that enables contextual help mode require not_destroyed: not is_destroyed ensure not_void: Result /= Void bridge_ok: Result.is_equal (implementation.contextual_help_accelerator) data: detachable ANY -- Arbitrary user data may be stored here. -- (from EV_ANY) generating_type: TYPE [detachable EV_APPLICATION] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void 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 help_accelerator: EV_ACCELERATOR -- Accelerator that displays contextual help require not_destroyed: not is_destroyed ensure not_void: Result /= Void bridge_ok: Result.is_equal (implementation.help_accelerator) help_engine: EV_HELP_ENGINE -- Object that handles contextual help display requests require not_destroyed: not is_destroyed ensure not_void: Result /= Void bridge_ok: Result.is_equal (implementation.help_engine) locked_window: detachable EV_WINDOW -- Window currently locked. Void if no window -- is currently locked. -- -- See {EV_WINDOW}.lock_update for more details require not_destroyed: not is_destroyed windows: LINEAR [EV_WINDOW] -- All of the application's windows. require not_destroyed: not is_destroyed ensure not_void: Result /= Void bridge_ok: Result.is_equal (implementation.windows) feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal (other: EV_APPLICATION): 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: EV_APPLICATION): 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 ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b 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 instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal (other: EV_APPLICATION): 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? require not_destroyed: not is_destroyed caps_lock_on: BOOLEAN -- Is caps lock key currently on? require 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? require not_destroyed: not is_destroyed Default_tooltip_delay: INTEGER_32 = 500 -- Default delay in milleseconds for tooltips. focused_widget: detachable EV_WIDGET -- Widget that has keyboard focus. require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.focused_widget is_display_remote: BOOLEAN -- Is application display remote? -- This function is primarily to determine if drawing to the display is optimal. require not_destroyed: not is_destroyed is_launched: BOOLEAN -- Has launch been called? 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? require 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. require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.tooltip_delay transport_in_progress: BOOLEAN -- Is a Pick and Drop transport currently in progress? require not_destroyed: not is_destroyed feature -- Status setting set_tooltip_delay (a_delay: INTEGER_32) -- Assign a_delay to tooltip_delay. require not_destroyed: not is_destroyed a_delay_non_negative: a_delay >= 0 ensure 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: EV_APPLICATION) -- 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: Current ~ other frozen deep_copy (other: EV_APPLICATION) -- 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: EV_APPLICATION -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: EV_APPLICATION) -- 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: EV_APPLICATION -- 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: EV_APPLICATION -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable EV_APPLICATION -- 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) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Basic operation display_help_for_widget (a_widget: EV_WIDGET) -- Display contextual help for a_widget, if any. require 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. require not_destroyed: not is_destroyed launch -- Start the application. -- This begins the event processing loop. require not_destroyed: not is_destroyed not_already_launched: not is_launched ensure 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.) require not_destroyed: not is_destroyed is_launched: is_launched process_events_until_stopped -- Process all events until 'stop_processing' is called. require not_destroyed: not is_destroyed is_launched: is_launched process_graphical_events -- Process any pending paint events. -- Pass control to the GUI toolkit so that it can -- handle any paint events that may be in its queue. require not_destroyed: not is_destroyed is_launched: is_launched sleep (msec: INTEGER_32) -- Wait for msec milliseconds and return. require not_destroyed: not is_destroyed msec_non_negative: msec >= 0 stop_processing --  Exit process_events_until_stopped. require 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 require not_destroyed: not is_destroyed an_accelerator_not_void: an_accelerator /= Void ensure contextual_help_accelerator_assigned: contextual_help_accelerator = an_accelerator set_help_accelerator (an_accelerator: EV_ACCELERATOR) -- Assign an_accelerator to help_accelerator require not_destroyed: not is_destroyed an_accelerator_not_void: an_accelerator /= Void ensure help_accelerator_assigned: help_accelerator = an_accelerator set_help_engine (an_engine: EV_HELP_ENGINE) -- Assign an_engine to help_engine require not_destroyed: not is_destroyed an_engine_not_void: an_engine /= Void ensure help_engine_set: help_engine = an_engine feature -- Event handling add_idle_action (a_idle_action: PROCEDURE) -- Add a_idle_actions to idle_actions if not already present. -- Thread safe require a_idle_action_not_void: a_idle_action /= Void add_idle_action_kamikaze (an_action: separate PROCEDURE) -- Perform an_action one time when the application is next idle. -- Thread safe -- Was declared in EV_APPLICATION as synonym of do_once_on_idle. require not_destroyed: not is_destroyed 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: separate PROCEDURE) -- Perform an_action one time when the application is next idle. -- Thread safe -- Was declared in EV_APPLICATION as synonym of add_idle_action_kamikaze. require 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 file_drop_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, LIST [STRING_32]] -- Actions to be performed when an OS file drop is performed on Current. -- widget is the widget on which the file(s) where dropped on to. -- file_list is a list of the file paths being dropped on to widget. -- In order for file_drop_actions to be called an agent has to be already -- present in the file_drop_actions of widget otherwise a drop is disallowed. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void focus_in_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET] -- Actions to be performed when getting focus. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void focus_out_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET] -- Actions to be performed when losing focus. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void key_press_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, EV_KEY] -- Actions to be performed when a keyboard key is pressed. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void key_press_string_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, READABLE_STRING_GENERAL] -- Actions to be performed when a keyboard press generates a displayable character. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void key_release_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, EV_KEY] -- Actions to be performed when a keyboard key is released. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void mouse_wheel_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, INTEGER_32] -- Actions to be performed when mouse wheel is rotated. -- (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: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, INTEGER_32, INTEGER_32, INTEGER_32] -- Actions to be performed when screen pointer button is pressed. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void pointer_button_release_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, INTEGER_32, INTEGER_32, INTEGER_32] -- Actions to be performed when screen pointer button is released. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void pointer_double_press_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, INTEGER_32, INTEGER_32, INTEGER_32] -- Actions to be performed when screen pointer is double clicked. -- (from EV_APPLICATION_ACTION_SEQUENCES) ensure -- from EV_APPLICATION_ACTION_SEQUENCES not_void: Result /= Void pointer_motion_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, INTEGER_32, INTEGER_32] -- Actions to be performed when screen pointer moves. -- (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) -- Remove a_idle_action from idle_actions. -- Thread safe. require 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: EV_LITE_ACTION_SEQUENCE [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) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void 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 tooltip_delay_not_negative: tooltip_delay >= 0 -- from EV_ANY is_initialized: is_initialized default_create_called: default_create_called is_coupled: default_create_called implies (implementation.interface = Current or (attached {EV_ENVIRONMENT} Current and then attached implementation.interface)) -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2016, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., 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_APPLICATION
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

-- Generated by Eiffel Studio --
For more details: eiffel.org