Automatic generation produced by ISE Eiffel
note description: "[ Eiffel Vision application. Implementation interface. See `{EV_APPLICATION}`. ]" legal: "See notice at end of class." status: "See notice at end of class." keywords: "application" date: "$Date: 2021-11-08 05:33:29 -0900 (Mon, 08 Nov 2021) $" revision: "$Revision: 105926 $" deferred class interface EV_APPLICATION_I feature -- Initialization make -- Create pick and drop target list. -- Set F1 as default help key. -- Create default help engine. ensure -- from EV_ANY_I is_initialized: get_state_flag (Is_initialized_flag) old_make (an_interface: attached like interface) -- Create underlying native toolkit objects. -- Every descendant should exactly one a creation procedure `make`. -- Must call base_make. require -- from EV_ANY_I an_interface_not_void: an_interface /= Void ensure -- from EV_ANY_I interface_assigned: interface = an_interface base_make_called: base_make_called feature -- Access alt_pressed: BOOLEAN -- Is alt key currently pressed? C_memory: INTEGER_32 = 2 -- Code for the C memory managed -- by the garbage collector -- (from MEM_CONST) caps_lock_on: BOOLEAN -- Is the Caps Lock key currently on? captured_widget: detachable EV_WIDGET -- Widget currently captured. Void if none. Check_instruction: INTEGER_32 = 7 -- Exception code for violated check -- (from EXCEP_CONST) Class_invariant: INTEGER_32 = 6 -- Exception code for violated class invariant -- (from EXCEP_CONST) clipboard: EV_CLIPBOARD -- Native platform clipboard access. Com_exception: INTEGER_32 = 28 -- Exception code for a COM error. -- (from EXCEP_CONST) contextual_help_accelerator: EV_ACCELERATOR -- Accelerator that enables contextual help mode Create_on_deferred: INTEGER_32 = 17 -- Create on deferred -- (from EXCEP_CONST) ctrl_pressed: BOOLEAN -- Is ctrl key currently pressed? Developer_exception: INTEGER_32 = 24 -- Exception code for developer exception -- (from EXCEP_CONST) Dollar_applied_to_melted_feature: INTEGER_32 = 26 -- $ applied to melted feature -- (from EXCEP_CONST) Eiffel_memory: INTEGER_32 = 1 -- Code for the Eiffel memory managed -- by the garbage collector -- (from MEM_CONST) Eiffel_runtime_fatal_error: INTEGER_32 = 25 -- Eiffel run-time fatal error -- (from EXCEP_CONST) Eiffel_runtime_panic: INTEGER_32 = 13 -- Eiffel run-time panic -- (from EXCEP_CONST) Exception_in_signal_handler: INTEGER_32 = 20 -- Exception in signal handler -- (from EXCEP_CONST) Exception_manager: EXCEPTION_MANAGER -- Exception manager -- (from EXCEPTION_MANAGER_FACTORY) ensure -- from EXCEPTION_MANAGER_FACTORY instance_free: class exception_manager_not_void: Result /= Void External_exception: INTEGER_32 = 18 -- Exception code for operating system error -- which does not set the errno variable -- (Unix-specific) -- (from EXCEP_CONST) Floating_point_exception: INTEGER_32 = 5 -- Exception code for floating point exception -- (from EXCEP_CONST) Full_collector: INTEGER_32 = 0 -- Statistics for full collections -- (from MEM_CONST) generating_type: TYPE [detachable EV_APPLICATION_I] -- 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 help_engine: EV_HELP_ENGINE -- Object that handle contextual help display requests Incorrect_inspect_value: INTEGER_32 = 9 -- Exception code for inspect value which is not one -- of the inspect constants, if there is no Else_part -- (from EXCEP_CONST) Incremental_collector: INTEGER_32 = 1 -- Statistics for incremental collections -- (from MEM_CONST) invoke_garbage_collection_when_inactive: BOOLEAN -- Should garbage collection be invoked when application is inactive. Io_exception: INTEGER_32 = 21 -- Exception code for I/O error -- (from EXCEP_CONST) is_display_remote: BOOLEAN -- Is application display remote? -- This function is primarily to determine if drawing to the display is optimal. locked_window: detachable EV_WINDOW -- Window currently locked. Void if no window -- is currently locked. -- -- See `{EV_WINDOW}.lock_update` for more details Loop_invariant: INTEGER_32 = 11 -- Exception code for violated loop invariant -- (from EXCEP_CONST) Loop_variant: INTEGER_32 = 10 -- Exception code for non-decreased loop variant -- (from EXCEP_CONST) No_more_memory: INTEGER_32 = 2 -- Exception code for failed memory allocation -- (from EXCEP_CONST) Number_of_codes: INTEGER_32 = 31 -- How many codes are there to represent exceptions? -- (from EXCEP_CONST) Old_exception: INTEGER_32 = 30 -- Old exception code. -- (from EXCEP_CONST) Operating_system_exception: INTEGER_32 = 22 -- Exception code for operating system error -- which sets the errno variable -- (Unix-specific) -- (from EXCEP_CONST) Out_of_memory: INTEGER_32 = 15 -- Out of memory (cannot be ignored) -- (from EXCEP_CONST) pick_and_drop_source: detachable EV_PICK_AND_DROPABLE_I -- The current pick and drop source. pnd_targets: HASH_TABLE [INTEGER_32, INTEGER_32] -- Global list of pick and drop target object ids. Postcondition: INTEGER_32 = 4 -- Exception code for violated postcondition -- (from EXCEP_CONST) Precondition: INTEGER_32 = 3 -- Exception code for violated precondition -- (from EXCEP_CONST) Rescue_exception: INTEGER_32 = 14 -- Exception code for exception in rescue clause -- (from EXCEP_CONST) Resumption_failed: INTEGER_32 = 16 -- Resumption failed (retry did not succeed) -- (from EXCEP_CONST) Retrieve_exception: INTEGER_32 = 23 -- Exception code for retrieval error -- may be raised by retrieved in IO_MEDIUM. -- (from EXCEP_CONST) Routine_failure: INTEGER_32 = 8 -- Exception code for failed routine -- (from EXCEP_CONST) Runtime_check_exception: INTEGER_32 = 29 -- Exception code for runtime check being violated. -- (from EXCEP_CONST) Runtime_io_exception: INTEGER_32 = 27 -- Exception code for I/O error raised by runtime functions -- such as store/retrieve, file access... -- (from EXCEP_CONST) Serialization_exception: INTEGER_32 = 31 -- Serialization exception code. -- (from EXCEP_CONST) shift_pressed: BOOLEAN -- Is shift key currently pressed? Signal_exception: INTEGER_32 = 12 -- Exception code for operating system signal -- (from EXCEP_CONST) Total_memory: INTEGER_32 = 0 -- Code for all the memory managed -- by the garbage collector -- (from MEM_CONST) transport_in_progress: BOOLEAN -- Is a Pick and Drop transport currently in progress? valid_code (c: INTEGER_32): BOOLEAN -- Is c a valid code to represent some kind of exceptions? -- (from EXCEP_CONST) Void_assigned_to_expanded: INTEGER_32 = 19 -- Exception code for assignment of void value -- to expanded entity -- (from EXCEP_CONST) Void_call_target: INTEGER_32 = 1 -- Exception code for feature applied to void reference -- (from EXCEP_CONST) windows: LINEAR [EV_WINDOW] -- Global list of windows. feature -- Measurement gc_statistics (collector_type: INTEGER_32): GC_INFO -- Garbage collection information for collector_type. -- (from MEMORY) require -- from MEMORY type_ok: collector_type = Full_collector or collector_type = Incremental_collector ensure -- from MEMORY instance_free: class memory_statistics (memory_type: INTEGER_32): MEM_INFO -- Memory usage information for memory_type -- (from MEMORY) require -- from MEMORY type_ok: memory_type = Total_memory or memory_type = Eiffel_memory or memory_type = C_memory ensure -- from MEMORY instance_free: class 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 alias "≡≡≡" (other: EV_APPLICATION_I): 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_I): 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 alias "≜" (other: EV_APPLICATION_I): 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 assertion_violation: BOOLEAN -- Is last exception originally due to a violated -- assertion or non-decreasing variant? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class chunk_size: INTEGER_32 -- Minimal size of a memory chunk. The run-time always -- allocates a multiple of this size. -- If the environment variable EIF_MEMORY_CHUNK -- is defined, it is set to the closest reasonable -- value from it. -- (from MEMORY) ensure -- from MEMORY instance_free: class class_name: detachable STRING_8 -- Name of the class that includes the recipient -- of original form of last exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class coalesce_period: INTEGER_32 -- Period of full coalesce (in number of collections) -- If the environment variable EIF_FULL_COALESCE_PERIOD -- is defined, it is set to the closest reasonable -- value from it. -- If null, no full coalescing is launched. -- (from MEMORY) ensure -- from MEMORY instance_free: class collecting: BOOLEAN -- Is garbage collection enabled? -- (from MEMORY) ensure -- from MEMORY instance_free: class collection_period: INTEGER_32 -- Period of full collection. -- If the environment variable EIF_FULL_COLLECTION_PERIOD -- is defined, it is set to the closest reasonable -- value from it. -- If null, no full collection is launched. -- (from MEMORY) ensure -- from MEMORY instance_free: class 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 developer_exception_name: detachable STRING_8 -- Name of last developer-raised exception -- (from EXCEPTIONS) require -- from EXCEPTIONS applicable: is_developer_exception ensure -- from EXCEPTIONS instance_free: class exception: INTEGER_32 -- Code of last exception that occurred -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class exception_trace: detachable STRING_8 -- String representation of the exception trace -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class focused_widget: detachable EV_WIDGET -- Widget with keyboard focus generation_object_limit: INTEGER_32 -- Maximum size of object in generational scavenge zone. -- If the environment variable EIF_GS_LIMIT -- is defined, it is set to the closest reasonable -- value from it. -- (from MEMORY) ensure -- from MEMORY instance_free: class is_destroyed: BOOLEAN -- Is Current no longer usable? -- (from EV_ANY_I) is_developer_exception: BOOLEAN -- Is the last exception originally due to -- a developer exception? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class is_developer_exception_of_name (name: detachable STRING_8): BOOLEAN -- Is the last exception originally due to a developer -- exception of name name? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class is_signal: BOOLEAN -- Is last exception originally due to an external -- event (operating system signal)? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class is_system_exception: BOOLEAN -- Is last exception originally due to an -- external event (operating system error)? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class largest_coalesced_block: INTEGER_32 -- Size of largest coalesced block since last call to -- largest_coalesced; 0 if none. -- (from MEMORY) ensure -- from MEMORY instance_free: class max_mem: INTEGER_32 -- Maximum amount of bytes the run-time can allocate. -- (from MEMORY) ensure -- from MEMORY instance_free: class meaning (except: INTEGER_32): detachable STRING_8 -- A message in English describing what except is -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class memory_count_map: HASH_TABLE [INTEGER_32, INTEGER_32] -- Number of instances per dynamic type present in system. -- Same as `memory_map` except that no references on the objects themselves -- is kept. -- (from MEMORY) ensure -- from MEMORY instance_free: class memory_map: HASH_TABLE [ARRAYED_LIST [ANY], INTEGER_32] -- Retrieves all object in system as a table indexed by dynamic type -- where elements are all instances of a given data type. -- (from MEMORY) ensure -- from MEMORY instance_free: class memory_threshold: INTEGER_32 -- Minimum amount of bytes to be allocated before -- starting an automatic garbage collection. -- (from MEMORY) ensure -- from MEMORY instance_free: class objects_instance_of (an_object: ANY): SPECIAL [ANY] -- Objects that have same dynamic type as an_object. -- (from MEMORY) ensure -- from MEMORY instance_free: class objects_instance_of_type (a_type_id: INTEGER_32): SPECIAL [ANY] -- Objects that have same dynamic type as an_object. -- (from MEMORY) ensure -- from MEMORY instance_free: class original_class_name: detachable STRING_8 -- Name of the class that includes the recipient -- of original form of last exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class original_exception: INTEGER_32 -- Original code of last exception that triggered -- current exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class original_recipient_name: detachable STRING_8 -- Name of the routine whose execution was -- interrupted by original form of last exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class original_tag_name: detachable STRING_8 -- Assertion tag for original form of last -- assertion violation. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class recipient_name: detachable STRING_8 -- Name of the routine whose execution was -- interrupted by last exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class referers (an_object: ANY): SPECIAL [ANY] -- Objects that refer to an_object. -- (from MEMORY) ensure -- from MEMORY instance_free: class 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)) scavenge_zone_size: INTEGER_32 -- Size of generational scavenge zone. -- If the environment variable EIF_MEMORY_SCAVENGE -- is defined, it is set to the closest reasonable -- value from it. -- (from MEMORY) ensure -- from MEMORY instance_free: class tag_name: detachable STRING_8 -- Tag of last violated assertion clause -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class tenure: INTEGER_32 -- Maximum age of object before being considered -- as old (old objects are not scanned during -- partial collection). -- If the environment variable EIF_TENURE_MAX -- is defined, it is set to the closest reasonable -- value from it. -- (from MEMORY) ensure -- from MEMORY instance_free: class tooltip_delay: INTEGER_32 -- Time in milliseconds before tooltips pop up. feature -- Status setting allocate_compact -- Enter memory mode: will try to compact memory -- before requesting more from the operating system. -- (from MEMORY) ensure -- from MEMORY instance_free: class allocate_fast -- Enter speed mode: will optimize speed of memory -- allocation rather than memory usage. -- (from MEMORY) ensure -- from MEMORY instance_free: class allocate_tiny -- Enter tiny mode: will enter memory mode -- after having freed as much memory as possible. -- (from MEMORY) ensure -- from MEMORY instance_free: class catch (code: INTEGER_32) -- Make sure that any exception of code code will be -- caught. This is the default. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class collection_off -- Disable garbage collection. -- (from MEMORY) ensure -- from MEMORY instance_free: class collection_on -- Enable garbage collection. -- (from MEMORY) ensure -- from MEMORY instance_free: class die (code: INTEGER_32) -- Terminate execution with exit status code, -- without triggering an exception. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS False instance_free: class disable_time_accounting -- Disable GC time accounting (default). -- (from MEMORY) ensure -- from MEMORY instance_free: class enable_time_accounting -- Enable GC time accouting, accessible in `gc_statistics`. -- (from MEMORY) ensure -- from MEMORY instance_free: class execute_without_collection (a_action: PROCEDURE) -- Execute a_action with the garbage collector disabled. -- If a_action modifies the status of `collecting`, we restore -- it no matter what at the end. -- (from MEMORY) require -- from MEMORY a_action_not_void: a_action /= Void ensure -- from MEMORY instance_free: class collection_status_preserved: collecting = old collecting ignore (code: INTEGER_32) -- Make sure that any exception of code code will be -- ignored. This is not the default. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class message_on_failure -- Print an exception history table -- in case of failure. -- This is the default. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class no_message_on_failure -- Do not print an exception history table -- in case of failure. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class raise (name: detachable READABLE_STRING_GENERAL) -- Raise a developer exception of name name. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class raise_retrieval_exception (name: detachable READABLE_STRING_GENERAL) -- Raise a retrieval exception of name name. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class set_coalesce_period (value: INTEGER_32) -- Set `coalesce_period`. Every value collection, -- the Garbage Collector will coalesce -- the whole memory. -- (from MEMORY) require -- from MEMORY positive_value: value >= 0 ensure -- from MEMORY instance_free: class set_collection_period (value: INTEGER_32) -- Set `collection_period`. Every value collection, -- the Garbage collector will perform a collection -- on the whole memory (full collection), otherwise -- a simple partial collection is done. -- (from MEMORY) require -- from MEMORY positive_value: value >= 0 ensure -- from MEMORY instance_free: class set_max_mem (value: INTEGER_32) -- Set the maximum amount of memory the run-time can allocate. -- (from MEMORY) require -- from MEMORY positive_value: value > 0 ensure -- from MEMORY instance_free: class set_memory_threshold (value: INTEGER_32) -- Set a new `memory_threshold` in bytes. Whenever the memory -- allocated for Eiffel reaches this value, an automatic -- collection is performed. -- (from MEMORY) require -- from MEMORY positive_value: value > 0 ensure -- from MEMORY instance_free: class set_tooltip_delay (a_delay: INTEGER_32) -- Set `tooltip_delay` to a_delay. require a_delay_non_negative: a_delay >= 0 ensure assigned: tooltip_delay = a_delay feature -- Removal collect -- Force a partial collection cycle if garbage -- collection is enabled; do nothing otherwise. -- (from MEMORY) ensure -- from MEMORY instance_free: class dispose -- Action to be executed just before garbage collection -- reclaims an object. -- Default version does nothing; redefine in descendants -- to perform specific dispose actions. Those actions -- should only take care of freeing external resources; -- they should not perform remote calls on other objects -- since these may also be dead and reclaimed. -- (from MEMORY) free (object: ANY) -- Free object, by-passing garbage collection. -- Erratic behavior will result if the object is still -- referenced. -- (from MEMORY) ensure -- from MEMORY instance_free: class full_coalesce -- Coalesce the whole memory: merge adjacent free -- blocks to reduce fragmentation. Useful, when -- a lot of memory is allocated with garbage collector off. -- (from MEMORY) ensure -- from MEMORY instance_free: class full_collect -- Force a full collection cycle if garbage -- collection is enabled; do nothing otherwise. -- (from MEMORY) ensure -- from MEMORY instance_free: class feature -- Duplication copy (other: EV_APPLICATION_I) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from 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_I) -- 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_I -- 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_I) -- 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_I -- 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_I -- 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_I -- 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 -- Implementation attached_interface: attached like interface -- Attached version of `interface`. -- (from EV_ANY_I) require -- from EV_ANY_I interface_attached: interface /= Void call_post_launch_actions -- Call the post launch actions. exception_dialog: detachable EV_DIALOG -- Dialog used for showing uncaught exceptions. interface: detachable EV_APPLICATION note option: stable new_exception: EXCEPTION -- New exception object representating the last exception caught in Current ensure new_exception_not_void: Result /= Void on_exception_action (an_exception: EXCEPTION) -- Call exception actions. require an_exception_not_void: an_exception /= Void raise_default_exception_dialog (a_empty_dialog: EV_DIALOG; an_exception: EXCEPTION) -- Raise the exception dialog require a_empty_dialog_valid: a_empty_dialog /= Void and then not a_empty_dialog.is_destroyed Show_exception_dialog: BOOLEAN = True -- Should the exception dialog be shown by default? uncaught_exception_actions_called: BOOLEAN -- Are the uncaught_exceptions_actions currently being called? -- This is used to prevent infinite looping should an exception be raised as part of calling `uncaught_exception_actions`. feature 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void feature -- Basic operation add_idle_action (a_idle_action: PROCEDURE) -- Extend `idle_actions` with a_idle_action. -- Thread safe require a_idle_action_not_void: a_idle_action /= Void display_help_for_widget (a_widget: EV_WIDGET) -- Display contextual help for a_widget, if any. require a_widget_not_void: a_widget /= Void enable_contextual_help -- Change mouse cursor to help cursor -- Capture mouse input -- Send help context of widget under mouse cursor when left mouse button is pressed to help engine. -- Cancel contextual help mode when right mouse button is pressed. idle_lock -- Lock the Idle Actions Mutex. idle_unlock -- Unlock the Idle Actions Mutex. kamikaze_lock -- Lock the Kamikaze Actions Mutex. kamikaze_unlock -- Unlock the Kamikaze Actions Mutex. process_events -- Process any pending events. process_events_until_stopped -- Process all events until 'stop_processing' is called. 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. 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 sleep (msec: INTEGER_32) -- Wait for msec milliseconds and return. require msec_non_negative: msec >= 0 stop_processing -- Exit `process_events_until_stopped`. try_idle_lock: BOOLEAN -- Attempt to lock the Idle Actions Mutex. True if successful. try_kamikaze_lock: BOOLEAN -- Attempt to lock the Kamikaze Actions Mutex. True if successful. feature -- Element Change set_captured_widget (a_captured_widget: detachable EV_WIDGET) -- Set `captured_widget` to the widget that has the current capture 'a_capture_widget'. ensure captured_widget_set: captured_widget = a_captured_widget set_contextual_help_accelerator (an_accelerator: EV_ACCELERATOR) -- Assign an_accelerator to `contextual_help_accelerator` require an_accelerator_not_void: an_accelerator /= Void ensure contextual_help_accelerator_assigned: contextual_help_accelerator = an_accelerator contextual_help_accelerator_complete: attached contextual_help_handler_procedure and then contextual_help_accelerator.actions.has (contextual_help_handler_procedure) set_help_accelerator (an_accelerator: EV_ACCELERATOR) -- Assign an_accelerator to `help_accelerator` require an_accelerator_not_void: an_accelerator /= Void ensure help_accelerator_assigned: help_accelerator = an_accelerator help_accelerator_complete: attached help_handler_procedure and then help_accelerator.actions.has (help_handler_procedure) set_help_engine (an_engine: EV_HELP_ENGINE) -- Assign an_engine to `help_engine` require an_engine_not_void: an_engine /= Void ensure help_engine_set: help_engine = an_engine set_invoke_garbage_collection_when_inactive (a_enabled: BOOLEAN) -- Set `invoke_garbage_collection_when_inactive` to a_enabled. set_locked_window (a_window: detachable EV_WINDOW) -- Set `locked_window` to a_window. -- -- See `{EV_WINDOW}.lock_update` for more details feature -- Event handling accelerator_actions (an_accelerator: EV_ACCELERATOR): EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when an_accelerator key sequence is -- pressed. ensure not_void: Result /= Void cancel_actions: EV_PND_ACTION_SEQUENCE -- Actions to be performed when a PND is cancelled -- (from EV_APPLICATION_ACTION_SEQUENCES_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void destroy_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when current application is destroying. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) drop_actions: EV_PND_ACTION_SEQUENCE -- Actions to be performed when any "drop" occurs. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void idle_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when the application is otherwise idle. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) kamikaze_actions: ARRAYED_LIST [separate PROCEDURE] -- Actions to be performed once when the application is otherwise idle. -- Allows for separate agents coming from other processors that may want to be called when the application is idle -- via 'do_once_on_idle'. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void key_press_string_actions: EV_LITE_ACTION_SEQUENCE [EV_WIDGET, STRING_32] -- Actions to be performed when a keyboard press generates a displayable character. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void pick_actions: EV_PND_ACTION_SEQUENCE -- Actions to be performed when any "pick" occurs. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void post_launch_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed just after application launch. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void system_color_change_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when screen color depth changed. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void theme_changed_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when operating system theme changed. -- (from EV_APPLICATION_ACTION_SEQUENCES_I) 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_I) ensure -- from EV_APPLICATION_ACTION_SEQUENCES_I not_void: Result /= Void feature -- Events action_sequence_call_counter: NATURAL_32 -- Counter used in post-conditions to determine if any actions sequences have been -- called as a result of the routine the post-condition is applied to. actions_are_callable: BOOLEAN -- May actions be called do_once_on_idle (an_action: separate PROCEDURE) -- Perform an_action one time only on idle. increase_action_sequence_call_counter -- Increase `action_sequence_call_counter` by one. 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 invariant -- from EV_ANY_I interface_coupled: is_usable implies interface /= Void and then attached_interface.implementation = Current base_make_called: is_usable implies base_make_called -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2021, 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_I -- Generated by Eiffel Studio --
For more details: eiffel.org