Automatic generation produced by ISE Eiffel
note description: "SD_STATE which manage SD_ZONE baes on different states. A state pattern." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2017-04-18 10:22:38 -0800 (Tue, 18 Apr 2017) $" revision: "$Revision: 100223 $" deferred class interface SD_STATE feature -- Access generating_type: TYPE [detachable SD_STATE] -- 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 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: SD_STATE): 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: SD_STATE): 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: SD_STATE): 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 content_count_valid (a_titles: ARRAYED_LIST [READABLE_STRING_GENERAL]): BOOLEAN -- If a_titles vaild? require a_titles_not_void: a_titles /= Void content_void: BOOLEAN -- If current a_content 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_dock_at_top (a_multi_dock_area: SD_MULTI_DOCK_AREA): BOOLEAN -- If `zone` dock at top level of a_multi_dock_area? 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)) value: INTEGER_32 -- State value, see {SD_ENUMERATION} -- State ensure valid: (create {SD_ENUMERATION} end).is_state_valid (Result) feature -- Duplication copy (other: SD_STATE) -- 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: SD_STATE) -- 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: SD_STATE -- 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: SD_STATE) -- 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: SD_STATE -- 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: SD_STATE -- 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 SD_STATE -- 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 clear_docking_manager -- Clear `docking_manager`. -- (from SD_DOCKING_MANAGER_HOLDER) set_docking_manager (a_docking_manager: like docking_manager) -- Set `docking_manager` with a_docking_manager -- (from SD_DOCKING_MANAGER_HOLDER) require -- from SD_DOCKING_MANAGER_HOLDER not_void: a_docking_manager /= Void ensure -- from SD_DOCKING_MANAGER_HOLDER set: is_docking_manager_attached feature -- Commands change_zone_split_area (a_target_zone: SD_ZONE; a_direction: INTEGER_32) -- Change zone position to a_target_zone's parent at a_direction require a_target_zone_not_void: a_target_zone /= Void dock_at_top_level (a_multi_dock_area: SD_MULTI_DOCK_AREA) -- Perform a restore require internal_content_not_void: not content_void float (a_x, a_y: INTEGER_32) -- Make current window floating hide -- Handle hide zone minimize -- Minimize if possible move_to_docking_zone (a_target_zone: SD_DOCKING_ZONE; a_first: BOOLEAN) -- Move to a SD_DOCKING_ZONE, then a_target_zone and Current became SD_TAB_ZONE require a_target_zone_not_void: a_target_zone /= Void move_to_tab_zone (a_target_zone: SD_TAB_ZONE; a_index: INTEGER_32) -- Move to a tab zone require a_target_zone_not_void: a_target_zone /= Void on_normal_max_window -- Handle normal\max zone require set: attached zone record_state -- Record current state set_split_proportion (a_proportion: REAL_32) -- Set parent splitter proportion to a_proportion if is possible show -- Handle show zone stick (a_direction: INTEGER_32) -- Stick/Unstick a zone feature -- Contract support initialized: BOOLEAN -- If ready to be used? 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 feature -- Properties change_tab_tooltip (a_tooltip: detachable READABLE_STRING_GENERAL) -- Set notebook tab tooltip if possible direction: INTEGER_32 -- Dock top or dock bottom or dock left or dock right? One enumeration from {SD_DOCKING_MANAGER} floating_zone: detachable SD_FLOATING_ZONE -- When Current is floating, this is floating zone which Current is in -- Otherwise is Void last_floating_height: INTEGER_32 -- Last floating height (At the beginning the height is default floating height from SD_SHARED) last_floating_width: INTEGER_32 -- Last floating width (At the beginning the width is default floating width from SD_SHARED) set_direction (a_direction: INTEGER_32) -- Set `direction` set_last_floating_height (a_height: INTEGER_32) -- Set `last_floating_height` require valid: a_height >= 0 ensure set: last_floating_height = a_height set_last_floating_width (a_width: INTEGER_32) -- Set `last_floating_width` require valid: a_width >= 0 ensure set: last_floating_width = a_width set_mini_toolbar (a_toolbar_widget: EV_WIDGET) -- After SD_CONTENT changed mini_toolbar, we update related container's mini toolbar set_user_widget (a_widget: EV_WIDGET) -- After SD_CONTENT changed user_widget, we update related container's widget set_width_height (a_width_height: INTEGER_32) -- Set `width_height` require a_widht_height_valid: a_width_height >= 0 ensure set: width_height = a_width_height width_height: INTEGER_32 -- Width of zone if dock_left or dock_right -- Height of zone if dock_top or dock_bottom width_height_by_direction: INTEGER_32 -- Width of zone if dock left/right, Height of zone if dock top/bottom zone: detachable SD_ZONE -- Zone which is managed by Current (if any). feature -- Query docking_manager: SD_DOCKING_MANAGER -- Docking manager instance. -- (from SD_DOCKING_MANAGER_HOLDER) is_docking_manager_attached: BOOLEAN -- If `docking_manager` has been set? -- (from SD_DOCKING_MANAGER_HOLDER) invariant last_floating_height_valid: initialized implies last_floating_height >= 0 last_floating_width_valid: initialized implies last_floating_width >= 0 -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note library: "SmartDocking: Library of reusable components for Eiffel." copyright: "Copyright (c) 1984-2017, 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 SD_STATE -- Generated by Eiffel Studio --
For more details: eiffel.org