Automatic generation produced by ISE Eiffel
note description: "Docking manager queries." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2017-04-14 10:05:46 -0800 (Fri, 14 Apr 2017) $" revision: "$Revision: 100203 $" class interface SD_DOCKING_MANAGER_QUERY create make (a_docking_manager: SD_DOCKING_MANAGER) -- Associate new object with a_docking_manager. feature -- Access generating_type: TYPE [detachable SD_DOCKING_MANAGER_QUERY] -- 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_DOCKING_MANAGER_QUERY): 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_DOCKING_MANAGER_QUERY): 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_DOCKING_MANAGER_QUERY): 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: SD_DOCKING_MANAGER_QUERY) -- 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_DOCKING_MANAGER_QUERY) -- 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_DOCKING_MANAGER_QUERY -- 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_DOCKING_MANAGER_QUERY) -- 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_DOCKING_MANAGER_QUERY -- 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_DOCKING_MANAGER_QUERY -- 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_DOCKING_MANAGER_QUERY -- 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 set_opening_tools_layout (a_bool: BOOLEAN) -- Set `is_opening_tools_layout` with a_bool ensure set: is_opening_tools_layout = a_bool 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 -- 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) feature -- Querys all_zones_in_widget (a_widget: EV_WIDGET): ARRAYED_LIST [SD_ZONE] -- All zones in a_widget if exist require not_void: a_widget /= Void ensure not_void: Result /= Void auto_hide_panel (a_direction: INTEGER_32): SD_AUTO_HIDE_PANEL -- Auto hide panel at a_direction require a_direction_valid: a_direction = {SD_ENUMERATION}.top or a_direction = {SD_ENUMERATION}.bottom or a_direction = {SD_ENUMERATION}.left or a_direction = {SD_ENUMERATION}.right ensure not_void: Result /= Void container_rectangle: EV_RECTANGLE -- Rectangle area of center_area require not_destroyed: not docking_manager.is_destroyed ensure not_void: Result /= Void container_rectangle_screen: EV_RECTANGLE -- Rectangle area of the fixed_area base on screen ensure not_void: Result /= Void content_by_title (a_unique_title: READABLE_STRING_GENERAL): detachable SD_CONTENT -- Content by a_title require a_title_not_void: a_unique_title /= Void and then not a_unique_title.is_empty content_by_title_for_restore (a_unique_title: READABLE_STRING_GENERAL): detachable SD_CONTENT -- Content by a_unique_title. Result = Void if not found require a_unique_title_not_void: a_unique_title /= Void contents_editors: ARRAYED_LIST [SD_CONTENT] -- All editor type contents ensure not_void: Result /= Void docker_mediator (a_caller: SD_ZONE; a_docking_manager: SD_DOCKING_MANAGER): SD_DOCKER_MEDIATOR -- Factory method require not_void: a_caller /= Void not_void: a_docking_manager /= Void ensure not_void: Result /= Void editor_zone_count: INTEGER_32 -- How many editors zones (not editor content) now? find_window_by_widget (a_widget: EV_WIDGET): EV_WINDOW -- Find a window which can lock_update require a_zone_not_void: a_widget /= Void ensure not_void: Result /= Void find_window_by_zone (a_zone: SD_ZONE): EV_WINDOW -- Find a window which can lock_update. require a_zone_not_void: a_zone /= Void ensure not_void: Result /= Void fixed_area_rectangle: EV_RECTANGLE -- Rectangle area of fixed_area floating_zones: ARRAYED_LIST [SD_FLOATING_ZONE] -- All floating zones in Current system ensure not_void: Result /= Void golbal_accelerators: SEQUENCE [EV_ACCELERATOR] -- Golbal accelerators has_auto_hide_zone: BOOLEAN -- If Current we have SD_AUTO_HIDE_ZONE showing? has_content_visible: BOOLEAN -- Has visible contents except editor place holder content? inner_container (a_zone: SD_ZONE): SD_MULTI_DOCK_AREA -- SD_MULTI_DOCK_AREA which has a_zone require a_zone_not_void: a_zone /= Void ensure not_void: Result /= Void inner_container_by_widget (a_widget: EV_WIDGET): SD_MULTI_DOCK_AREA -- SD_MULTI_DOCK_AREA which has a_widget require a_zone_not_void: a_widget /= Void ensure not_void: Result /= Void inner_container_include_hidden (a_zone: SD_ZONE): detachable SD_MULTI_DOCK_AREA -- SD_MULTI_DOCK_AREA which a_zone in, also finding in widgets which are hidden by a maximized zone -- Maybe void if not found require not_void: a_zone /= Void inner_container_main: SD_MULTI_DOCK_AREA -- Container in main window ensure not_void: Result /= Void internal_restore_whole_editor_area_actions: detachable EV_NOTIFY_ACTION_SEQUENCE -- When whole editor area restored automatically, actions will be invoked internal_restore_whole_editor_area_for_minimized_actions: detachable EV_NOTIFY_ACTION_SEQUENCE -- When whole editor area restored automatically for minimized editor area, actions will be invoked is_floating (a_content: SD_CONTENT): BOOLEAN -- If a_content floating? require not_void: a_content /= Void is_in_main_window (a_tool_bar: SD_GENERIC_TOOL_BAR): BOOLEAN -- If a_widget in main window? is_main_inner_container (a_area: SD_MULTI_DOCK_AREA): BOOLEAN -- Contract support -- If a_area is first one in inner_containers. require a_area_not_void: a_area /= Void is_opening_tools_layout: BOOLEAN -- If executing {SD_DOCKING_MANAGER_QUERY}.open_tools_config is_unique_title_free_to_use (a_title: READABLE_STRING_GENERAL): BOOLEAN -- If a_title unique in all current contents? Not already used by other contents? is_zone_in_same_window (a_zone_one, a_zone_two: SD_ZONE): BOOLEAN -- If a_zone_one and a_zone_two in same window? maximized_hidden_main_container (a_zone: SD_ZONE): detachable SD_MULTI_DOCK_AREA -- Find the item in main area hidden widget when whole editor area maximized maximized_inner_container (a_zone: EV_WIDGET): detachable SD_MULTI_DOCK_AREA -- Find a_zone only in main areas which have maximized zone -- Maybe void if not found require not_void: a_zone /= Void only_one_editor_zone: detachable SD_UPPER_ZONE -- If Current docking layout only have one editor zone (only one SD_DOCKING_ZONE_UPPER or SD_TAB_ZONE_UPPER)? -- If yes, then the result is the only one editor zone -- If not only one, then result is Void ensure valid: editor_zone_count = 1 implies Result /= Void valid: editor_zone_count /= 1 implies Result = Void restore_whole_editor_area_actions: EV_NOTIFY_ACTION_SEQUENCE -- When whole editor area restored automatically, actions will be invoked ensure not_void: Result /= Void restore_whole_editor_area_for_minimized_actions: EV_NOTIFY_ACTION_SEQUENCE -- When whole editor area restored automatically for minimized editor area, actions will be invoked. ensure not_void: Result /= Void unique_title_verified: BOOLEAN zone_max_screen_x (a_zone: SD_ZONE): INTEGER_32 -- Max screen x of a_zone zone_under_pointer: detachable SD_ZONE -- {SD_CONTENT} under mouse pointer -- Result void if not found invariant -- 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_DOCKING_MANAGER_QUERY -- Generated by Eiffel Studio --
For more details: eiffel.org