Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "A keyboard accelerator defines actions to be performed when akey is pressed. See {EV_TITLED_WINDOW}.accelerators" legal: "See notice at end of class." status: "See notice at end of class." keywords: "accelerator, keyboard, key, shortcut, hotkey" date: "$Date: 2017-05-03 07:56:14 -0800 (Wed, 03 May 2017) $" revision: "$Revision: 100317 $" class interface EV_ACCELERATOR create default_create -- Standard creation procedure. -- (from EV_ANY) require -- from ANY True ensure then -- from EV_ANY is_coupled: implementation /= Void is_initialized: is_initialized default_create_called: default_create_called is_in_default_state: is_in_default_state make_with_key_combination (a_key: EV_KEY; require_control, require_alt, require_shift: BOOLEAN) -- Create with a_key and modifiers. require a_key_not_void: a_key /= Void feature -- Access alt_required: BOOLEAN -- Must the alt key be pressed to trigger actions? require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.alt_required control_required: BOOLEAN -- Must the control key be pressed to trigger actions? require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.control_required data: detachable ANY -- Arbitrary user data may be stored here. -- (from EV_ANY) generating_type: TYPE [detachable EV_ACCELERATOR] -- 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: EV_KEY -- Key that will trigger actions. require not_destroyed: not is_destroyed ensure bridge_ok: equal (Result, implementation.key) parented: BOOLEAN -- Does Current have a parent? -- Current is parented if it has been placed in the -- accelerator list of a window. -- key combination of Current cannot be modified if True. require not_destroyed: not is_destroyed shift_required: BOOLEAN -- Must the shift key be pressed to trigger actions? require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.shift_required 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_ACCELERATOR): 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) 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_ACCELERATOR): 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 debug_output: STRING_32 -- String that should be displayed in debugger to represent Current. ensure -- from DEBUG_OUTPUT result_not_void: Result /= Void is_equal (other: like Current): BOOLEAN -- Does other have the same key combination as Current? require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result 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)) text: STRING_32 -- String representation of key combination. ensure then result_attached: Result /= Void feature -- Status setting disable_alt_required -- Make alt_required False. require not_destroyed: not is_destroyed not_parented: not parented ensure not_alt_required: not alt_required disable_control_required -- Make control_required False. require not_destroyed: not is_destroyed not_parented: not parented ensure not_control_required: not control_required disable_shift_required -- Make shift_required False. require not_destroyed: not is_destroyed not_parented: not parented ensure not_shift_required: not shift_required enable_alt_required -- Make alt_required True. require not_destroyed: not is_destroyed not_parented: not parented ensure alt_required: alt_required enable_control_required -- Make control_required True. require not_destroyed: not is_destroyed not_parented: not parented ensure control_required: control_required enable_shift_required -- Make shift_required True. require not_destroyed: not is_destroyed not_parented: not parented ensure shift_required: shift_required set_key (a_key: EV_KEY) -- Assign a_key to key. require not_destroyed: not is_destroyed a_key_not_void: a_key /= Void not_parented: not parented ensure a_key_assigned: key.is_equal (a_key) feature -- Element change set_data (some_data: like data) -- Assign some_data to data. -- (from EV_ANY) require -- from EV_ANY not_destroyed: not is_destroyed ensure -- from EV_ANY data_assigned: data = some_data feature -- Duplication frozen deep_copy (other: EV_ACCELERATOR) -- 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_ACCELERATOR -- 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_ACCELERATOR) -- 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_ACCELERATOR -- 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_ACCELERATOR -- 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_ACCELERATOR -- 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 -- Command destroy -- Destroy underlying native toolkit object. -- Render Current unusable. -- (from EV_ANY) ensure -- from EV_ANY is_destroyed: is_destroyed feature -- Events actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when key combination is received by the window within which -- Current is parented. require not_destroyed: not is_destroyed ensure result_not_void: Result /= Void 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 -- Status Report is_destroyed: BOOLEAN -- Is Current no longer usable? -- (from EV_ANY) ensure -- from EV_ANY bridge_ok: Result = implementation.is_destroyed invariant key_not_void: key /= Void -- from EV_ANY is_initialized: is_initialized default_create_called: default_create_called is_coupled: default_create_called implies (implementation.interface = Current or (attached {EV_ENVIRONMENT} Current and then attached implementation.interface)) -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note 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 EV_ACCELERATOR
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

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