Automatic generation produced by ISE Eiffel

Classes
Clusters
Cluster hierarchy
Chart
Relations
Flat contracts
Go to: 
note
	description: "Eiffel Vision key. Represents a virtual key code. `code` can be any%Nof the constant values defined in EV_KEY_CONSTANTS."
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2024-05-29 07:57:19 -0800 (Wed, 29 May 2024) $"
	revision: "$Revision: 107787 $"

class interface
	EV_KEY

create 
	default_create
			-- Initialize with `key_enter`.

	make_with_code (a_code: INTEGER_32)
			-- Initialize with a_code.
		require
			a_code_valid: valid_key_code (a_code)

feature -- Access

	code: INTEGER_32
			-- Code representing some key.

	generating_type: TYPE [detachable EV_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

	key_code_from_key_string (key_string: READABLE_STRING_GENERAL): INTEGER_32
			-- Key code value from key_string
			-- (from EV_KEY_CONSTANTS)
		require -- from EV_KEY_CONSTANTS
			key_string_not_void: key_string /= Void

	Key_strings: ARRAY [STRING_32]
			-- String representations of all key codes.
			-- (from EV_KEY_CONSTANTS)
	
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_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: EV_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: EV_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

	is_alpha: BOOLEAN
			-- Is `code` in ["a"-"z"]?

	is_arrow: BOOLEAN
			-- Is `code` an arrow key?

	is_function: BOOLEAN
			-- Is `code` a function key?

	is_number: BOOLEAN
			-- Is `code` in ["0"-"9"]?

	is_numpad: BOOLEAN
			-- Is `code` a key on the numpad?

	is_printable: BOOLEAN
			-- Is `code` a printable key?

	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 -- Element change

	set_code (a_code: INTEGER_32)
			-- Assign a_code to `code`.
		require
			a_code_valid: valid_key_code (a_code)
		ensure
			code_assigned: code = a_code
	
feature -- Duplication

	copy (other: EV_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: EV_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: EV_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: EV_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: EV_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: EV_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 EV_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 -- Constants

	Key_0: INTEGER_32 = 1
			-- (from EV_KEY_CONSTANTS)

	Key_1: INTEGER_32 = 2
			-- (from EV_KEY_CONSTANTS)

	Key_2: INTEGER_32 = 3
			-- (from EV_KEY_CONSTANTS)

	Key_3: INTEGER_32 = 4
			-- (from EV_KEY_CONSTANTS)

	Key_4: INTEGER_32 = 5
			-- (from EV_KEY_CONSTANTS)

	Key_5: INTEGER_32 = 6
			-- (from EV_KEY_CONSTANTS)

	Key_6: INTEGER_32 = 7
			-- (from EV_KEY_CONSTANTS)

	Key_7: INTEGER_32 = 8
			-- (from EV_KEY_CONSTANTS)

	Key_8: INTEGER_32 = 9
			-- (from EV_KEY_CONSTANTS)

	Key_9: INTEGER_32 = 10
			-- (from EV_KEY_CONSTANTS)

	Key_a: INTEGER_32 = 68
			-- (from EV_KEY_CONSTANTS)

	Key_alt: INTEGER_32 = 96
			-- (from EV_KEY_CONSTANTS)

	Key_b: INTEGER_32 = 69
			-- (from EV_KEY_CONSTANTS)

	Key_back_space: INTEGER_32 = 40
			-- (from EV_KEY_CONSTANTS)

	Key_backquote: INTEGER_32 = 56
			-- (from EV_KEY_CONSTANTS)

	Key_backslash: INTEGER_32 = 54
			-- (from EV_KEY_CONSTANTS)

	Key_c: INTEGER_32 = 70
			-- (from EV_KEY_CONSTANTS)

	Key_caps_lock: INTEGER_32 = 45
			-- (from EV_KEY_CONSTANTS)

	Key_close_bracket: INTEGER_32 = 52
			-- (from EV_KEY_CONSTANTS)

	Key_comma: INTEGER_32 = 47
			-- (from EV_KEY_CONSTANTS)

	Key_ctrl: INTEGER_32 = 95
			-- (from EV_KEY_CONSTANTS)

	Key_d: INTEGER_32 = 71
			-- (from EV_KEY_CONSTANTS)

	Key_dash: INTEGER_32 = 57
			-- (from EV_KEY_CONSTANTS)

	Key_delete: INTEGER_32 = 67
			-- (from EV_KEY_CONSTANTS)

	Key_down: INTEGER_32 = 59
			-- (from EV_KEY_CONSTANTS)

	Key_e: INTEGER_32 = 72
			-- (from EV_KEY_CONSTANTS)

	Key_end: INTEGER_32 = 65
			-- (from EV_KEY_CONSTANTS)

	Key_enter: INTEGER_32 = 41
			-- (from EV_KEY_CONSTANTS)

	Key_equal: INTEGER_32 = 48
			-- (from EV_KEY_CONSTANTS)

	Key_escape: INTEGER_32 = 42
			-- (from EV_KEY_CONSTANTS)

	Key_f: INTEGER_32 = 73
			-- (from EV_KEY_CONSTANTS)

	Key_f1: INTEGER_32 = 27
			-- (from EV_KEY_CONSTANTS)

	Key_f10: INTEGER_32 = 36
			-- (from EV_KEY_CONSTANTS)

	Key_f11: INTEGER_32 = 37
			-- (from EV_KEY_CONSTANTS)

	Key_f12: INTEGER_32 = 38
			-- (from EV_KEY_CONSTANTS)

	Key_f2: INTEGER_32 = 28
			-- (from EV_KEY_CONSTANTS)

	Key_f3: INTEGER_32 = 29
			-- (from EV_KEY_CONSTANTS)

	Key_f4: INTEGER_32 = 30
			-- (from EV_KEY_CONSTANTS)

	Key_f5: INTEGER_32 = 31
			-- (from EV_KEY_CONSTANTS)

	Key_f6: INTEGER_32 = 32
			-- (from EV_KEY_CONSTANTS)

	Key_f7: INTEGER_32 = 33
			-- (from EV_KEY_CONSTANTS)

	Key_f8: INTEGER_32 = 34
			-- (from EV_KEY_CONSTANTS)

	Key_f9: INTEGER_32 = 35
			-- (from EV_KEY_CONSTANTS)

	Key_g: INTEGER_32 = 74
			-- (from EV_KEY_CONSTANTS)

	Key_h: INTEGER_32 = 75
			-- (from EV_KEY_CONSTANTS)

	Key_home: INTEGER_32 = 64
			-- (from EV_KEY_CONSTANTS)

	Key_i: INTEGER_32 = 76
			-- (from EV_KEY_CONSTANTS)

	Key_insert: INTEGER_32 = 66
			-- (from EV_KEY_CONSTANTS)

	Key_j: INTEGER_32 = 77
			-- (from EV_KEY_CONSTANTS)

	Key_k: INTEGER_32 = 78
			-- (from EV_KEY_CONSTANTS)

	Key_l: INTEGER_32 = 79
			-- (from EV_KEY_CONSTANTS)

	Key_left: INTEGER_32 = 60
			-- (from EV_KEY_CONSTANTS)

	Key_left_meta: INTEGER_32 = 97
			-- (from EV_KEY_CONSTANTS)

	Key_m: INTEGER_32 = 80
			-- (from EV_KEY_CONSTANTS)

	Key_menu: INTEGER_32 = 99
			-- (from EV_KEY_CONSTANTS)

	Key_n: INTEGER_32 = 81
			-- (from EV_KEY_CONSTANTS)

	Key_num_lock: INTEGER_32 = 24
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_0: INTEGER_32 = 11
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_1: INTEGER_32 = 12
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_2: INTEGER_32 = 13
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_3: INTEGER_32 = 14
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_4: INTEGER_32 = 15
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_5: INTEGER_32 = 16
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_6: INTEGER_32 = 17
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_7: INTEGER_32 = 18
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_8: INTEGER_32 = 19
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_9: INTEGER_32 = 20
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_add: INTEGER_32 = 21
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_decimal: INTEGER_32 = 26
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_divide: INTEGER_32 = 22
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_multiply: INTEGER_32 = 23
			-- (from EV_KEY_CONSTANTS)

	Key_numpad_subtract: INTEGER_32 = 25
			-- (from EV_KEY_CONSTANTS)

	Key_o: INTEGER_32 = 82
			-- (from EV_KEY_CONSTANTS)

	Key_open_bracket: INTEGER_32 = 51
			-- (from EV_KEY_CONSTANTS)

	Key_p: INTEGER_32 = 83
			-- (from EV_KEY_CONSTANTS)

	Key_page_down: INTEGER_32 = 63
			-- (from EV_KEY_CONSTANTS)

	Key_page_up: INTEGER_32 = 62
			-- (from EV_KEY_CONSTANTS)

	Key_pause: INTEGER_32 = 44
			-- (from EV_KEY_CONSTANTS)

	Key_period: INTEGER_32 = 49
			-- (from EV_KEY_CONSTANTS)

	Key_q: INTEGER_32 = 84
			-- (from EV_KEY_CONSTANTS)

	Key_quote: INTEGER_32 = 55
			-- (from EV_KEY_CONSTANTS)

	Key_r: INTEGER_32 = 85
			-- (from EV_KEY_CONSTANTS)

	Key_right: INTEGER_32 = 61
			-- (from EV_KEY_CONSTANTS)

	Key_right_meta: INTEGER_32 = 98
			-- (from EV_KEY_CONSTANTS)

	Key_s: INTEGER_32 = 86
			-- (from EV_KEY_CONSTANTS)

	Key_scroll_lock: INTEGER_32 = 46
			-- (from EV_KEY_CONSTANTS)

	Key_semicolon: INTEGER_32 = 50
			-- (from EV_KEY_CONSTANTS)

	Key_shift: INTEGER_32 = 94
			-- (from EV_KEY_CONSTANTS)

	Key_slash: INTEGER_32 = 53
			-- (from EV_KEY_CONSTANTS)

	Key_space: INTEGER_32 = 39
			-- (from EV_KEY_CONSTANTS)

	Key_t: INTEGER_32 = 87
			-- (from EV_KEY_CONSTANTS)

	Key_tab: INTEGER_32 = 43
			-- (from EV_KEY_CONSTANTS)

	Key_u: INTEGER_32 = 88
			-- (from EV_KEY_CONSTANTS)

	Key_up: INTEGER_32 = 58
			-- (from EV_KEY_CONSTANTS)

	Key_v: INTEGER_32 = 89
			-- (from EV_KEY_CONSTANTS)

	Key_w: INTEGER_32 = 90
			-- (from EV_KEY_CONSTANTS)

	Key_x: INTEGER_32 = 91
			-- (from EV_KEY_CONSTANTS)

	Key_y: INTEGER_32 = 92
			-- (from EV_KEY_CONSTANTS)

	Key_z: INTEGER_32 = 93
			-- (from EV_KEY_CONSTANTS)
	
feature -- Contract support

	valid_key_code (a_code: INTEGER_32): BOOLEAN
			-- Is a_code a valid key code?
			-- (from EV_KEY_CONSTANTS)
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			io_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
	
feature -- Standard output

	text: STRING_32
			-- Readable representation of `code`.
	
invariant
	code_valid: valid_key_code (code)

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

note
	copyright: "Copyright (c) 1984-2024, 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_KEY


Classes
Clusters
Cluster hierarchy
Chart
Relations
Flat contracts
Go to: 

-- Generated by Eiffel Studio --
For more details: eiffel.org