note description: "[ Encapsulates the release of a mouse button ]" author: "Louis Marchand and obnosim" date: "Sun Feb 04, 2018" revision: "2.0" todo: "Drop GAME_MOUSE_BUTTON_RELEASED_STATE entirely and inherit GAME_MOUSE_BUTTON_EVENT directly" class interface GAME_MOUSE_BUTTON_RELEASE_EVENT create make (a_mouse_id, a_state: NATURAL_32; a_x, a_y: INTEGER_32) -- Initialization for Current. -- (from GAME_MOUSE_EVENT_COMMON) feature -- Access generating_type: TYPE [detachable GAME_MOUSE_BUTTON_RELEASE_EVENT] -- 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 id: NATURAL_32 -- Unique identifier of the mouse represented by Current -- (from GAME_MOUSE_EVENT) is_left_button: BOOLEAN -- Is the left button of the mouse the one represented by Current? -- (from GAME_MOUSE_BUTTON_EVENT) is_middle_button: BOOLEAN -- Is the middle button of the mouse the one represented by Current? -- (from GAME_MOUSE_BUTTON_EVENT) is_optional_button_1: BOOLEAN -- Is the first optional button of the mouse the one represented by Current? -- (from GAME_MOUSE_BUTTON_EVENT) is_optional_button_2: BOOLEAN -- Is the second optional button of the mouse the one represented by Current? -- (from GAME_MOUSE_BUTTON_EVENT) is_right_button: BOOLEAN -- Is the right button of the mouse the one represented by Current? -- (from GAME_MOUSE_BUTTON_EVENT) is_touch_device: BOOLEAN -- True if the mouse represented by Current is the touch device. -- (from GAME_MOUSE_EVENT) x: INTEGER_32 -- Horizontal position of Current (relative to the focussed window) -- (from GAME_MOUSE_COMMON) y: INTEGER_32 -- Vertical position of Current (relative to the focussed window) -- (from GAME_MOUSE_COMMON) 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_MOUSE_BUTTON_RELEASE_EVENT): 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_MOUSE_BUTTON_RELEASE_EVENT): 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_MOUSE_BUTTON_RELEASE_EVENT): 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_MOUSE_BUTTON_RELEASE_EVENT) -- 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_MOUSE_BUTTON_RELEASE_EVENT) -- 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_MOUSE_BUTTON_RELEASE_EVENT -- 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_MOUSE_BUTTON_RELEASE_EVENT) -- 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_MOUSE_BUTTON_RELEASE_EVENT -- 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_MOUSE_BUTTON_RELEASE_EVENT -- 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_MOUSE_BUTTON_RELEASE_EVENT -- 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 GAME_MOUSE_BUTTON_EVENT only_one_button: is_left_button.to_integer + is_right_button.to_integer + is_middle_button.to_integer + is_optional_button_1.to_integer + is_optional_button_2.to_integer = 1 -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class GAME_MOUSE_BUTTON_RELEASE_EVENT
Generated by ISE EiffelStudio