note description: "Every events that can happend on a GAME_WINDOW" author: "Louis Marchand" date: "Wed, 01 Apr 2015 19:04:20 +0000" revision: "2.0" deferred class interface GAME_WINDOW_EVENTS feature -- Access clear -- Remove all events. ensure -- from GAME_EVENTS running_unchanged: is_running = old is_running close_request_actions: ACTION_SEQUENCE [NATURAL_32] -- When the Window manager request that Current be closed. require window_events_enabled: events_controller.is_window_event_enable events_controller: GAME_EVENTS_CONTROLLER -- Manage every internal events -- (from GAME_EVENTS) expose_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current is exposed and should be redraw. require window_events_enabled: events_controller.is_window_event_enable generating_type: TYPE [detachable GAME_WINDOW_EVENTS] -- 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 has_error: BOOLEAN -- Is the library has generate an error -- (from GAME_ERROR_MANAGER) hide_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current is hide. require window_events_enabled: events_controller.is_window_event_enable is_running: BOOLEAN assign set_is_running -- Is Current active -- (from GAME_EVENTS) key_pressed_actions: ACTION_SEQUENCE [NATURAL_32, GAME_KEY_EVENT] -- When a key (represented by key_state) has been pressed. require key_released_events_enabled: events_controller.is_key_pressed_event_enable key_released_actions: ACTION_SEQUENCE [NATURAL_32, GAME_KEY_EVENT] -- When a key (represented by key_state) has been released. require key_released_events_enabled: events_controller.is_key_released_event_enable keyboard_focus_gain_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current has gain keyboard focus. require window_events_enabled: events_controller.is_window_event_enable keyboard_focus_lost_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current has lost keyboard focus. require window_events_enabled: events_controller.is_window_event_enable last_error: READABLE_STRING_GENERAL -- The last error generate by the library -- (from GAME_SDL_ANY) maximize_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current has been maximized. require window_events_enabled: events_controller.is_window_event_enable minimize_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current has been minimized. require window_events_enabled: events_controller.is_window_event_enable mouse_button_pressed_actions: ACTION_SEQUENCE [NATURAL_32, GAME_MOUSE_BUTTON_PRESS_EVENT, NATURAL_8] -- When a mouse represented by mouse_state has been pressed for the nb_clicks times require mouse_button_pressed_events_enabled: events_controller.is_mouse_button_pressed_event_enable mouse_button_released_actions: ACTION_SEQUENCE [NATURAL_32, GAME_MOUSE_BUTTON_RELEASE_EVENT, NATURAL_8] -- When a mouse represented by mouse_state has been released for the nb_clicks times require mouse_button_released_events_enabled: events_controller.is_mouse_button_released_event_enable mouse_enter_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current has gained mouse focus. require window_events_enabled: events_controller.is_window_event_enable mouse_leave_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current has lost mouse focus. require window_events_enabled: events_controller.is_window_event_enable mouse_motion_actions: ACTION_SEQUENCE [NATURAL_32, GAME_MOUSE_MOTION_EVENT, INTEGER_32, INTEGER_32] -- When a mouse represented by mouse_state has been moved in Current. -- The difference between the old position and the new (delta_x,delta_y) require mouse_motion_events_enabled: events_controller.is_mouse_motion_event_enable mouse_wheel_move_actions: ACTION_SEQUENCE [NATURAL_32, GAME_MOUSE_EVENT, INTEGER_32, INTEGER_32] -- When the wheel of a mouse represented by mouse_state has been moved. -- The difference between the old wheel position and the new one is (delta_x,delta_y) -- When delta_x is positive, the wheel has been move up, and when negative, it has been moved down -- When delta_y is positive, the wheel has been move right, and when negative, it has been moved left require mouse_wheel_move_events_enabled: events_controller.is_mouse_wheel_event_enable move_actions: ACTION_SEQUENCE [NATURAL_32, INTEGER_32, INTEGER_32] -- When Current has been moved to (x,y). require window_events_enabled: events_controller.is_window_event_enable resize_actions: ACTION_SEQUENCE [NATURAL_32, INTEGER_32, INTEGER_32] -- When Current has been resized by the user (external to the game library) -- to widthxheight. Always precceded by a size_change_actions events. -- Note: This event is not trigger by the GAME_WINDOW.set_size or GAME_WINDOW.set_full_screen -- Routines require window_events_enabled: events_controller.is_window_event_enable restore_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current has been restored to normal size and position. require window_events_enabled: events_controller.is_window_event_enable run -- Put Current active. require -- from GAME_EVENTS run_not_already_running: not is_running ensure -- from GAME_EVENTS is_running: is_running set_is_running (a_value: BOOLEAN) -- Assign to is_running the value of a_value -- (from GAME_EVENTS) ensure -- from GAME_EVENTS is_assign: is_running ~ a_value show_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current is show. require window_events_enabled: events_controller.is_window_event_enable size_change_actions: ACTION_SEQUENCE [NATURAL_32] -- When Current has been resized. -- Note: Trigger when a user resize the window (external to the game library) or when a -- call to the GAME_WINDOW.set_size or GAME_WINDOW.set_full_screen routines has -- been use. require window_events_enabled: events_controller.is_window_event_enable stop -- Put Current innactive. require -- from GAME_EVENTS stop_is_running: is_running ensure -- from GAME_EVENTS is_stopped: not is_running text_editing_actions: ACTION_SEQUENCE [NATURAL_32, STRING_32, INTEGER_32, INTEGER_32] -- When a text has been edited in Current. text_input_actions: ACTION_SEQUENCE [NATURAL_32, STRING_32] -- When a new text has been entered in Current. 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: GAME_WINDOW_EVENTS): 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: GAME_WINDOW_EVENTS): 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: GAME_WINDOW_EVENTS): 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 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 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)) feature -- Duplication copy (other: GAME_WINDOW_EVENTS) -- 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: GAME_WINDOW_EVENTS) -- 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: GAME_WINDOW_EVENTS -- 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: GAME_WINDOW_EVENTS) -- 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: GAME_WINDOW_EVENTS -- 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: GAME_WINDOW_EVENTS -- 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 GAME_WINDOW_EVENTS -- 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 -- 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 ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class GAME_WINDOW_EVENTS
Generated by ISE EiffelStudio