note description: "A physical keyboard key." author: "Louis Marchand" date: "Sun, 30 Apr 2017 15:08:50 +0000" revision: "2.1" deferred class interface GAME_PHYSICAL_KEY feature -- Access generating_type: TYPE [detachable GAME_PHYSICAL_KEY] -- 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 is_0: BOOLEAN -- Current represent the physical 0 key is_1: BOOLEAN -- Current represent the physical 1 key is_2: BOOLEAN -- Current represent the physical 2 key is_3: BOOLEAN -- Current represent the physical 3 key is_4: BOOLEAN -- Current represent the physical 4 key is_5: BOOLEAN -- Current represent the physical 5 key is_6: BOOLEAN -- Current represent the physical 6 key is_7: BOOLEAN -- Current represent the physical 7 key is_8: BOOLEAN -- Current represent the physical 8 key is_9: BOOLEAN -- Current represent the physical 9 key is_a: BOOLEAN -- Current represent the physical a key is_again: BOOLEAN -- Current represent the physical again key is_apostrophe: BOOLEAN -- Current represent the physical apostrophe key is_app_1: BOOLEAN -- Current represent the physical app 1 key is_app_2: BOOLEAN -- Current represent the physical app 2 key is_application: BOOLEAN -- Current represent the physical application key is_application_control_back: BOOLEAN -- Current represent the physical back key of the application_control keypad is_application_control_bookmarks: BOOLEAN -- Current represent the physical bookmarks key of the application_control keypad is_application_control_forward: BOOLEAN -- Current represent the physical forward key of the application_control keypad is_application_control_home: BOOLEAN -- Current represent the physical home key of the application_control keypad is_application_control_refresh: BOOLEAN -- Current represent the physical refresh key of the application_control keypad is_application_control_search: BOOLEAN -- Current represent the physical search key of the application_control keypad is_application_control_stop: BOOLEAN -- Current represent the physical stop key of the application_control keypad is_as400_keypad_equals: BOOLEAN -- Current represent the physical keypad equals key for as400 keyboard is_audio_mute: BOOLEAN -- Current represent the physical audio mute key is_audio_next: BOOLEAN -- Current represent the physical audio next key is_audio_play: BOOLEAN -- Current represent the physical audio play key is_audio_prev: BOOLEAN -- Current represent the physical audio prev key is_audio_stop: BOOLEAN -- Current represent the physical audio stop key is_b: BOOLEAN -- Current represent the physical b key is_backslash: BOOLEAN -- Current represent the physical backslash key is_backspace: BOOLEAN -- Current represent the physical backspace key is_brightness_down: BOOLEAN -- Current represent the physical brightness down key is_brightness_up: BOOLEAN -- Current represent the physical brightness up key is_c: BOOLEAN -- Current represent the physical c key is_calculator: BOOLEAN -- Current represent the physical calculator key is_cancel: BOOLEAN -- Current represent the physical cancel key is_caps_lock: BOOLEAN -- Current represent the physical caps lock key is_clear: BOOLEAN -- Current represent the physical clear key is_clear_again: BOOLEAN -- Current represent the physical clear/again key is_comma: BOOLEAN -- Current represent the physical comma key is_computer: BOOLEAN -- Current represent the physical computer key is_copy: BOOLEAN -- Current represent the physical copy key is_crsel: BOOLEAN -- Current represent the physical crsel key is_currency_sub_unit: BOOLEAN -- Current represent the physical currency sub unit key is_currency_unit: BOOLEAN -- Current represent the physical currency unit key is_cut: BOOLEAN -- Current represent the physical cut key is_d: BOOLEAN -- Current represent the physical d key is_decimal_separator: BOOLEAN -- Current represent the physical decimal separator key is_delete: BOOLEAN -- Current represent the physical delete key is_display_switch: BOOLEAN -- Current represent the physical display switch key is_down: BOOLEAN -- Current represent the physical down key is_e: BOOLEAN -- Current represent the physical e key is_eject: BOOLEAN -- Current represent the physical eject key is_end: BOOLEAN -- Current represent the physical end key is_equals: BOOLEAN -- Current represent the physical equals key is_erase_eaze_alternate_erase: BOOLEAN -- Current represent the physical alternate erase key for Erase Eaze keyboard is_escape: BOOLEAN -- Current represent the physical escape key is_execute: BOOLEAN -- Current represent the physical execute key is_exsel: BOOLEAN -- Current represent the physical exsel key is_f: BOOLEAN -- Current represent the physical f key is_f1: BOOLEAN -- Current represent the physical f1 key is_f10: BOOLEAN -- Current represent the physical f10 key is_f11: BOOLEAN -- Current represent the physical f11 key is_f12: BOOLEAN -- Current represent the physical f12 key is_f13: BOOLEAN -- Current represent the physical f13 key is_f14: BOOLEAN -- Current represent the physical f14 key is_f15: BOOLEAN -- Current represent the physical f15 key is_f16: BOOLEAN -- Current represent the physical f16 key is_f17: BOOLEAN -- Current represent the physical f17 key is_f18: BOOLEAN -- Current represent the physical f18 key is_f19: BOOLEAN -- Current represent the physical f19 key is_f2: BOOLEAN -- Current represent the physical f2 key is_f20: BOOLEAN -- Current represent the physical f20 key is_f21: BOOLEAN -- Current represent the physical f21 key is_f22: BOOLEAN -- Current represent the physical f22 key is_f23: BOOLEAN -- Current represent the physical f23 key is_f24: BOOLEAN -- Current represent the physical f24 key is_f3: BOOLEAN -- Current represent the physical f3 key is_f4: BOOLEAN -- Current represent the physical f4 key is_f5: BOOLEAN -- Current represent the physical f5 key is_f6: BOOLEAN -- Current represent the physical f6 key is_f7: BOOLEAN -- Current represent the physical f7 key is_f8: BOOLEAN -- Current represent the physical f8 key is_f9: BOOLEAN -- Current represent the physical f9 key is_find: BOOLEAN -- Current represent the physical find key is_g: BOOLEAN -- Current represent the physical g key is_grave_accent: BOOLEAN -- Current represent the physical grave accent key is_h: BOOLEAN -- Current represent the physical h key is_help: BOOLEAN -- Current represent the physical help key is_home: BOOLEAN -- Current represent the physical home key is_i: BOOLEAN -- Current represent the physical i key is_insert: BOOLEAN -- Current represent the physical insert key is_internationa_6: BOOLEAN -- Current represent the physical international 6 key is_international_1: BOOLEAN -- Current represent the physical international 1 key is_international_2: BOOLEAN -- Current represent the physical international 2 key is_international_3: BOOLEAN -- Current represent the physical international 3 key is_international_4: BOOLEAN -- Current represent the physical international 4 key is_international_5: BOOLEAN -- Current represent the physical international 5 key is_international_7: BOOLEAN -- Current represent the physical international 7 key is_international_8: BOOLEAN -- Current represent the physical international 8 key is_international_9: BOOLEAN -- Current represent the physical international 9 key is_iso_backslash: BOOLEAN -- Current represent the physical backslash key for ISO keyboard is_iso_hash: BOOLEAN -- Current represent the physical hash key for ISO keyboard. -- Don't use this, use is_backslash instead. is_j: BOOLEAN -- Current represent the physical j key is_k: BOOLEAN -- Current represent the physical k key is_keyboard_illumination_down: BOOLEAN -- Current represent the physical keyboard illumination down key is_keyboard_illumination_toggle: BOOLEAN -- Current represent the physical keyboard illumination toggle key is_keyboard_illumination_up: BOOLEAN -- Current represent the physical keyboard illumination up key is_keypad_0: BOOLEAN -- Current represent the physical keypad 0 key is_keypad_00: BOOLEAN -- Current represent the physical keypad 00 key is_keypad_000: BOOLEAN -- Current represent the physical keypad 000 key is_keypad_1: BOOLEAN -- Current represent the physical keypad 1 key is_keypad_2: BOOLEAN -- Current represent the physical keypad 2 key is_keypad_3: BOOLEAN -- Current represent the physical keypad 3 key is_keypad_4: BOOLEAN -- Current represent the physical keypad 4 key is_keypad_5: BOOLEAN -- Current represent the physical keypad 5 key is_keypad_6: BOOLEAN -- Current represent the physical keypad 6 key is_keypad_7: BOOLEAN -- Current represent the physical keypad 7 key is_keypad_8: BOOLEAN -- Current represent the physical keypad 8 key is_keypad_9: BOOLEAN -- Current represent the physical keypad 9 key is_keypad_a: BOOLEAN -- Current represent the physical keypad a key is_keypad_ampersand: BOOLEAN -- Current represent the physical keypad ampersand key is_keypad_at: BOOLEAN -- Current represent the physical keypad at key is_keypad_b: BOOLEAN -- Current represent the physical keypad b key is_keypad_backspace: BOOLEAN -- Current represent the physical keypad backspace key is_keypad_binary: BOOLEAN -- Current represent the physical keypad binary key is_keypad_c: BOOLEAN -- Current represent the physical keypad c key is_keypad_clear: BOOLEAN -- Current represent the physical keypad clear key is_keypad_clear_entry: BOOLEAN -- Current represent the physical keypad clear entry key is_keypad_colon: BOOLEAN -- Current represent the physical keypad colon key is_keypad_comma: BOOLEAN -- Current represent the physical keypad comma key is_keypad_d: BOOLEAN -- Current represent the physical keypad d key is_keypad_decimal: BOOLEAN -- Current represent the physical keypad decimal key is_keypad_divide: BOOLEAN -- Current represent the physical keypad divide key is_keypad_double_ampersand: BOOLEAN -- Current represent the physical keypad double ampersand key is_keypad_double_vertical_bar: BOOLEAN -- Current represent the physical keypad double vertical bar key is_keypad_e: BOOLEAN -- Current represent the physical keypad e key is_keypad_enter: BOOLEAN -- Current represent the physical keypad enter key is_keypad_equals: BOOLEAN -- Current represent the physical keypad equals key is_keypad_exclamation_mark: BOOLEAN -- Current represent the physical keypad exclamation mark key is_keypad_f: BOOLEAN -- Current represent the physical keypad f key is_keypad_greater: BOOLEAN -- Current represent the physical keypad greater key is_keypad_hash: BOOLEAN -- Current represent the physical keypad hash key is_keypad_hexadecimal: BOOLEAN -- Current represent the physical keypad hexadecimal key is_keypad_left_brace: BOOLEAN -- Current represent the physical keypad left brace key is_keypad_left_parenthesis: BOOLEAN -- Current represent the physical keypad left parenthesis key is_keypad_less: BOOLEAN -- Current represent the physical keypad less key is_keypad_mem_add: BOOLEAN -- Current represent the physical keypad mem add key is_keypad_mem_clear: BOOLEAN -- Current represent the physical keypad mem clear key is_keypad_mem_divide: BOOLEAN -- Current represent the physical keypad mem divide key is_keypad_mem_multiply: BOOLEAN -- Current represent the physical keypad mem multiply key is_keypad_mem_recall: BOOLEAN -- Current represent the physical keypad mem recall key is_keypad_mem_store: BOOLEAN -- Current represent the physical keypad mem store key is_keypad_mem_subtract: BOOLEAN -- Current represent the physical keypad mem subtract key is_keypad_minus: BOOLEAN -- Current represent the physical keypad minus key is_keypad_multiply: BOOLEAN -- Current represent the physical keypad multiply key is_keypad_octal: BOOLEAN -- Current represent the physical keypad octal key is_keypad_percent: BOOLEAN -- Current represent the physical keypad percent key is_keypad_period: BOOLEAN -- Current represent the physical keypad period key is_keypad_plus: BOOLEAN -- Current represent the physical keypad plus key is_keypad_plus_minus: BOOLEAN -- Current represent the physical keypad plus/minus key is_keypad_power: BOOLEAN -- Current represent the physical kp_power key is_keypad_right_parenthesis: BOOLEAN -- Current represent the physical keypad right parenthesis key is_keypad_rightbrace: BOOLEAN -- Current represent the physical keypad right brace key is_keypad_space: BOOLEAN -- Current represent the physical keypad space key is_keypad_tab: BOOLEAN -- Current represent the physical keypad tab key is_keypad_vertical_bar: BOOLEAN -- Current represent the physical keypad vertical bar key is_keypad_xor: BOOLEAN -- Current represent the physical keypad xor key is_l: BOOLEAN -- Current represent the physical l key is_lang_1: BOOLEAN -- Current represent the physical lang 1 key is_lang_2: BOOLEAN -- Current represent the physical lang 2 key is_lang_3: BOOLEAN -- Current represent the physical lang 3 key is_lang_4: BOOLEAN -- Current represent the physical lang 4 key is_lang_5: BOOLEAN -- Current represent the physical lang 5 key is_lang_6: BOOLEAN -- Current represent the physical lang 6 key is_lang_7: BOOLEAN -- Current represent the physical lang 7 key is_lang_8: BOOLEAN -- Current represent the physical lang 8 key is_lang_9: BOOLEAN -- Current represent the physical lang 9 key is_left: BOOLEAN -- Current represent the physical left key is_left_alt: BOOLEAN -- Current represent the physical left alt key is_left_bracket: BOOLEAN -- Current represent the physical left bracket key is_left_ctrl: BOOLEAN -- Current represent the physical left ctrl key is_left_gui: BOOLEAN -- Current represent the physical left gui key is_left_shift: BOOLEAN -- Current represent the physical left shift key is_m: BOOLEAN -- Current represent the physical m key is_mail: BOOLEAN -- Current represent the physical mail key is_media_select: BOOLEAN -- Current represent the physical media select key is_menu: BOOLEAN -- Current represent the physical menu key is_minus: BOOLEAN -- Current represent the physical minus key is_mode: BOOLEAN -- Current represent the physical mode key is_mute: BOOLEAN -- Current represent the physical mute key is_n: BOOLEAN -- Current represent the physical n key is_num_lock_clear: BOOLEAN -- Current represent the physical num lock clear key is_o: BOOLEAN -- Current represent the physical o key is_oper: BOOLEAN -- Current represent the physical oper key is_out: BOOLEAN -- Current represent the physical out key is_p: BOOLEAN -- Current represent the physical p key is_page_down: BOOLEAN -- Current represent the physical page down key is_page_up: BOOLEAN -- Current represent the physical page up key is_paste: BOOLEAN -- Current represent the physical paste key is_pause: BOOLEAN -- Current represent the physical pause key is_period: BOOLEAN -- Current represent the physical period key is_power: BOOLEAN -- Current represent the physical power key is_print_screen: BOOLEAN -- Current represent the physical print screen key is_prior: BOOLEAN -- Current represent the physical prior key is_q: BOOLEAN -- Current represent the physical q key is_r: BOOLEAN -- Current represent the physical r key is_return: BOOLEAN -- Current represent the physical return key is_return_2: BOOLEAN -- Current represent the physical second return key is_right: BOOLEAN -- Current represent the physical right key is_right_alt: BOOLEAN -- Current represent the physical right alt key is_right_bracket: BOOLEAN -- Current represent the physical right bracket key is_right_ctrl: BOOLEAN -- Current represent the physical right ctrl key is_right_gui: BOOLEAN -- Current represent the physical right gui key is_right_shift: BOOLEAN -- Current represent the physical right shift key is_s: BOOLEAN -- Current represent the physical s key is_scroll_lock: BOOLEAN -- Current represent the physical scroll lock key is_select: BOOLEAN -- Current represent the physical select key is_semicolon: BOOLEAN -- Current represent the physical semicolon key is_separator: BOOLEAN -- Current represent the physical separator key is_slash: BOOLEAN -- Current represent the physical slash key is_sleep: BOOLEAN -- Current represent the physical sleep key is_space: BOOLEAN -- Current represent the physical space key is_stop: BOOLEAN -- Current represent the physical stop key is_sysreq: BOOLEAN -- Current represent the physical sysreq key is_t: BOOLEAN -- Current represent the physical t key is_tab: BOOLEAN -- Current represent the physical tab key is_thousands_separator: BOOLEAN -- Current represent the physical thousands separator key is_u: BOOLEAN -- Current represent the physical u key is_undo: BOOLEAN -- Current represent the physical undo key is_unknown: BOOLEAN -- The Current physical key is not valid is_up: BOOLEAN -- Current represent the physical up key is_v: BOOLEAN -- Current represent the physical v key is_volume_down: BOOLEAN -- Current represent the physical volume down key is_volume_up: BOOLEAN -- Current represent the physical volume up key is_w: BOOLEAN -- Current represent the physical w key is_www: BOOLEAN -- Current represent the physical www key is_x: BOOLEAN -- Current represent the physical x key is_y: BOOLEAN -- Current represent the physical y key is_z: BOOLEAN -- Current represent the physical z key physical_code: INTEGER_32 -- Hardware code of the key -- (not compatible between systems) 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_PHYSICAL_KEY): 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_PHYSICAL_KEY): 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_PHYSICAL_KEY): 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_PHYSICAL_KEY) -- 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_PHYSICAL_KEY) -- 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_PHYSICAL_KEY -- 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_PHYSICAL_KEY) -- 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_PHYSICAL_KEY -- 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_PHYSICAL_KEY -- 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_PHYSICAL_KEY -- 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_PHYSICAL_KEY
Generated by ISE EiffelStudio