Automatic generation produced by ISE Eiffel
note description: "[ Objects that represent source of a dockable transport. The dockable mechanism allows a component to be dragged by a user to an EV_DOCKABLE_TARGET that has been enabled to receive transport. `drop_started_actions' are fired immediately after a transport begins from `Current'. It is not possible to override the transport from within these actions. ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2009-06-03 17:11:49 -0700 (Wed, 03 Jun 2009) $" revision: "$Revision: 79073 $" deferred class interface EV_DOCKABLE_SOURCE feature -- Access data: detachable ANY -- Arbitrary user data may be stored here. -- (from EV_ANY) generating_type: TYPE [detachable EV_DOCKABLE_SOURCE] -- 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 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 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 definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal (other: attached EV_DOCKABLE_SOURCE): 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: attached EV_DOCKABLE_SOURCE): 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 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 (other: attached EV_DOCKABLE_SOURCE): 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_dockable: BOOLEAN -- Is `Current' dockable? -- If `True', then `Current' may be dragged -- from its current parent. require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.is_dockable is_external_docking_enabled: BOOLEAN -- Is `Current' able to be docked into an EV_DOCKABLE_DIALOG -- When there is no valid EV_DRAGABLE_TARGET upon completion -- of transport? require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.is_external_docking_enabled is_external_docking_relative: BOOLEAN -- Will dockable dialog displayed when `Current' is docked externally -- be displayed relative to parent window of `Current'? -- Otherwise displayed as a standard window. require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.is_external_docking_relative real_source: detachable EV_DOCKABLE_SOURCE -- `Result' is source to be dragged -- when a docking drag occurs on `Current'. -- If `Void', `Current' is dragged. require not_destroyed: not is_destroyed ensure bridge_ok: Result = implementation.real_source 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 -- Status setting disable_dockable -- Ensure `Current' is not dockable. require not_destroyed: not is_destroyed ensure not_is_dockable: not is_dockable disable_external_docking -- Assign `False' to is_external_docking_enabled. -- Forbid `Current' to be docked into an EV_DOCKABLE_DIALOG -- When there is no valid EV_DRAGABLE_TARGET upon completion -- of transport. require not_destroyed: not is_destroyed is_dockable: is_dockable ensure not_externally_dockable: not is_external_docking_enabled disable_external_docking_relative -- Assign `False' to is_external_docking_relative, ensuring that -- a dockable dialog displayed when `Current' is docked externally -- is displayed as a standard window. require not_destroyed: not is_destroyed external_docking_enabled: is_external_docking_enabled ensure external_docking_not_relative: not is_external_docking_relative enable_dockable -- Ensure `Current' is dockable. require not_destroyed: not is_destroyed ensure is_dockable: is_dockable enable_external_docking -- Assign `True' to is_external_docking_enabled. -- Allows `Current' to be docked into an EV_DOCKABLE_DIALOG -- When there is no valid EV_DRAGABLE_TARGET upon completion -- of transport. require not_destroyed: not is_destroyed is_dockable: is_dockable ensure is_externally_dockable: is_external_docking_enabled enable_external_docking_relative -- Assign `True' to is_external_docking_relative, ensuring that -- a dockable dialog displayed when `Current' is docked externally -- is displayed relative to the top level window. require not_destroyed: not is_destroyed external_docking_enabled: is_external_docking_enabled ensure external_docking_not_relative: is_external_docking_relative remove_real_source -- Ensure real_source is `Void'. require not_destroyed: not is_destroyed ensure real_source_void: real_source = Void set_real_source (dockable_source: EV_DOCKABLE_SOURCE) -- Assign `dockable_source' to real_source. require not_destroyed: not is_destroyed is_dockable: is_dockable dockable_source_not_void: dockable_source /= Void dockable_source_is_parent_recursive: source_has_current_recursive (dockable_source) ensure real_source_assigned: real_source = dockable_source 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 copy (other: attached EV_DOCKABLE_SOURCE) -- Update current object using fields of object attached -- to `other', so as to yield equal objects. -- (from EV_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: attached EV_DOCKABLE_SOURCE) -- 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: attached EV_DOCKABLE_SOURCE -- 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: attached EV_DOCKABLE_SOURCE) -- 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: attached EV_DOCKABLE_SOURCE -- 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: attached EV_DOCKABLE_SOURCE -- 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 ~ Current feature -- Basic operations frozen as_attached: attached EV_DOCKABLE_SOURCE -- Attached version of Current -- (Can be used during transitional period to convert -- non-void-safe classes to void-safe ones.) -- (from ANY) frozen default: detachable EV_DOCKABLE_SOURCE -- 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 -- Command destroy -- Destroy underlying native toolkit object. -- Render `Current' unusable. -- (from EV_ANY) ensure -- from EV_ANY is_destroyed: is_destroyed feature -- Contract support is_in_default_state: BOOLEAN -- Is `Current' in its default state? parent_of_source_allows_docking: BOOLEAN -- Does parent of source to be transported -- allow current to be dragged out? (See real_source) -- Not all Vision2 containers are currently supported by this -- mechanism, only descendents of EV_DOCKABLE_TARGET -- are supported. source_has_current_recursive (source: EV_DOCKABLE_SOURCE): BOOLEAN -- Does `source' recursively contain `Current'? -- As seen by parenting structure. require not_destroyed: not is_destroyed source_not_void: source /= Void feature -- Event handling dock_ended_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed after a dock completes from `Current'. -- Either to a dockable target or a dockable dialog. -- (from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES) ensure -- from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES not_void: Result /= Void dock_started_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when a dockable source is dragged. -- (from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES) ensure -- from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES not_void: Result /= Void feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY 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) 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 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 parent_permits_docking: is_dockable implies parent_of_source_allows_docking -- from EV_ANY is_initialized: is_initialized default_create_called: default_create_called is_coupled: default_create_called implies implementation.interface = Current -- 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_DOCKABLE_SOURCE -- Generated by Eiffel Studio --
For more details: docs.eiffel.com