indexing description: "Objects to synthesize keystrokes, mouse motions and button clicks." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $" revision: "$Revision: 56675 $" class interface WEL_INPUT_EVENT create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access 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) 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 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: like Current) -- 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: 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 -- Keyboard events send_keyboard_key_down (virtual_key_code: INTEGER_32) -- The keybd_event function synthesizes a keystroke. The system -- can use such a synthesized keystroke to generate a -- WM_KEYDOWN message. -- -- An application can simulate a press of the PRINTSCRN key in -- order to obtain a screen snapshot and save it to the -- clipboard. -- To do this, call `send_keyboard_key_down(Vk_snapshot)'. -- -- Windows NT: The send_keyboard_key_down can toggle the -- NUM LOCK, CAPS LOCK, and SCROLL LOCK keys. -- -- Windows 95: The send_keyboard_key_down function can toggle -- only the CAPS LOCK and SCROLL LOCK keys. It cannot toggle -- the NUM LOCK key. send_keyboard_key_up (virtual_key_code: INTEGER_32) -- The keybd_event function synthesizes a keystroke. The system -- can use such a synthesized keystroke to generate a -- WM_KEYUP message. -- -- Windows NT: The send_keyboard_key_down can toggle the -- NUM LOCK, CAPS LOCK, and SCROLL LOCK keys. -- -- Windows 95: The send_keyboard_key_down function can toggle -- only the CAPS LOCK and SCROLL LOCK keys. It cannot toggle -- the NUM LOCK key. feature -- Mouse events send_mouse_absolute_move (a_x, a_y: INTEGER_32) -- Synthesize a fake mouse move to absolute -- screen position `a_x', `a_y'. -- -- `a_x' and `a_y' contain normalized absolute coordinates -- between 0 and 65,535. The event procedure maps these -- coordinates onto the display surface. Coordinate (0,0) -- maps onto the upper-left corner of the display surface, -- (65535,65535) maps onto the lower-right corner. -- -- To determine the size of the screen use -- {WEL_SYSTEM_METRICS}.screen_width and -- {WEL_SYSTEM_METRICS}.screen_height. send_mouse_left_button_down -- Synthesize a fake press on the left button of the -- mouse. send_mouse_left_button_up -- Synthesize a fake press on the left button of the -- mouse. send_mouse_middle_button_down -- Synthesize a fake press on the middle button of the -- mouse. send_mouse_middle_button_up -- Synthesize a fake press on the middle button of the -- mouse. send_mouse_relative_move (a_x, a_y: INTEGER_32) -- Synthesize a fake mouse move. -- `a_x' and `a_y' are the number of mickeys moved. -- -- A mickey is the amount that a mouse has to move -- for it to report that it has moved. send_mouse_right_button_down -- Synthesize a fake press on the right button of the -- mouse. send_mouse_right_button_up -- Synthesize a fake press on the right button of the -- mouse. 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) invariant -- 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 WEL_INPUT_EVENT