Automatic generation produced by ISE Eiffel
note description: "Objects that contain all the singletons in Smart Docking library." 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_SHARED create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access auto_hide_tab_slide_timer_interval: INTEGER_32 -- Auto hide tab slide timer interval -- 0 means no animation. default_screen_x: INTEGER_32 -- Default floating screen x/y position for the zone's float feature first time be called default_screen_y: INTEGER_32 -- Default floating screen x/y position for the zone's float feature first time be called Feedback: SD_FEEDBACK_DRAWER -- SD_DRAW_FEEDBACK instance which is draw things on the desktop. ensure not_void: Result /= Void generating_type: TYPE [detachable SD_SHARED] -- 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 hot_zone_factory: detachable SD_HOT_ZONE_ABSTRACT_FACTORY -- Factory for different style hot zones. require set: is_hot_zone_factory_set ensure not_void: Result /= Void icons: SD_ICONS_SINGLETON -- SD_ICONS_SINGLETON instance. ensure not_void: Result /= Void interface_names: SD_INTERFACE_NAMES -- All interface names ensure not_void: Result /= Void Notebook_tab_drawer (a_tab: SD_NOTEBOOK_TAB): SD_NOTEBOOK_TAB_DRAWER_I -- Drawer for notebook tabs with initial tab a_tab. -- The tab needs to be changed by calling {SD_NOTEBOOK_TAB_DRAWER_I}.set_drawing_area. Setter: SD_SYSTEM_SETTER -- System special handler Tool_bar_docker_mediator_cell: CELL [detachable SD_TOOL_BAR_DOCKER_MEDIATOR] -- Tool bar docker mediator when user dragging a SD_TOOL_BAR_ZONE. ensure not_void: Result /= Void Tool_bar_drawer: SD_TOOL_BAR_DRAWER -- Drawer for tool bars tool_bar_font: EV_FONT -- Tool bar font. ensure not_void: Result /= Void Widget_factory: SD_WIDGET_FACTORY -- SD_WIDGET_FACTORY instance. ensure not_void: Result /= Void zone_navigation_accelerator_key: INTEGER_32 -- Accelerator key setting for zone navigation dialog -- On Windows by default is Ctlr + Tab 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_SHARED): 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_SHARED): 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_SHARED): 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 allow_window_to_back: BOOLEAN -- Does allow SD_FLOATING_ZONE or SD_FLOATING_TOOL_BAR_ZONE to go to back of main window? 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 icons_set: BOOLEAN -- Is `icons` has been set? is_hot_zone_factory_set: BOOLEAN -- Is `hot_zone_factory` has been set? 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)) show_all_feedback_indicator: BOOLEAN -- If show all indicators same time when use transparent rectangle style feedback? show_all_tab_stub_text: BOOLEAN -- When more than one tab stubs stay together at side of main window, show inactive tab stub text? zone_navigation_accelerator_alt: BOOLEAN -- Accelerator alt setting for zone navigation dialog. -- On Windows by default is Ctlr + Tab. zone_navigation_accelerator_ctrl: BOOLEAN -- Accelerator ctrl setting for zone navigation dialog. -- On Windows by default is Ctlr + Tab. zone_navigation_accelerator_shift: BOOLEAN -- Accelerator shift setting for zone navigation dialog. -- On Windows by default is Ctlr + Tab. feature -- Status setting set_allow_window_to_back (a_bool: BOOLEAN) -- Set `allow_window_to_back` with a_bool ensure set: allow_window_to_back = a_bool set_auto_hide_tab_slide_timer_interval (a_int: INTEGER_32) -- Set `auto_hide_tab_slide_timer_interval` with a_int. ensure set: Auto_hide_tab_slide_timer_interval_cell.item = a_int set_default_screen_x (a_x: INTEGER_32) -- Set `default_screen_x` require valid: default_screen_x >= 0 ensure set: default_screen_x = a_x set_default_screen_y (a_y: INTEGER_32) -- Set `default_screen_y` require valid: default_screen_y >= 0 ensure set: default_screen_y = a_y set_hot_zone_factory (a_factory: like hot_zone_factory) -- Set `hot_zone_factory` require a_factory_not_void: a_factory /= Void ensure set: hot_zone_factory = a_factory set_icons (a_icons: like icons) -- Set the SD_ICONS_SINGLETON instance -- Client programmers don't have to call this feature since SD_DEFAULT_ICONS will be used by default. require a_icons_not_void: a_icons /= Void ensure set: Internal_icons_cell.item = a_icons set_interface_names (a_names: like interface_names) -- Set internal_interface_names with a_names require not_void: a_names /= Void ensure set: Internal_interface_names_cell.item = a_names set_show_all_feedback_indicator (a_bool: BOOLEAN) -- Set `show_all_feedback_indicator` ensure set: show_all_feedback_indicator = a_bool set_show_tab_stub_text (a_bool: BOOLEAN) -- Set `show_tab_stub_text_cell` with a_bool ensure set: show_all_tab_stub_text = a_bool set_zone_navigation_accelerator_alt (a_bool: BOOLEAN) -- Set `zone_navigation_accelerator_alt` with a_bool. ensure set: zone_navigation_accelerator_alt = a_bool set_zone_navigation_accelerator_ctrl (a_bool: BOOLEAN) -- Set `zone_navigation_accelerator_ctrl` with a_bool. ensure set: zone_navigation_accelerator_ctrl = a_bool set_zone_navigation_accelerator_key (a_key: INTEGER_32) -- Set `zone_navigation_accelerator_key` with a_key. ensure set: zone_navigation_accelerator_key = a_key set_zone_navigation_accelerator_shift (a_bool: BOOLEAN) -- Set `zone_navigation_accelerator_shift` with a_bool. ensure set: zone_navigation_accelerator_shift = a_bool feature -- Duplication copy (other: SD_SHARED) -- 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_SHARED) -- 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_SHARED -- 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_SHARED) -- 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_SHARED -- 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_SHARED -- 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_SHARED -- 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 -- Colors border_color: EV_COLOR -- Border color, used by SD_TAB_STUB, SD_NOTEBOOK_TAB... ensure not_void: Result /= Void default_background_color: EV_COLOR -- Default background color. -- Changed when theme changed feedback_indicator_region_window_discard_color: EV_COLOR -- Feedback indicator window region discard color. ensure not_void: Result /= Void focused_color: EV_COLOR -- Focused color. Used by SD_TITLE_BAR... ensure not_void: Result /= Void focused_title_text_color: EV_COLOR -- Focused title bar text color. Used bt SD_TITLE_BAR. ensure not_void: Result /= Void non_focused_color: EV_COLOR -- Non focuse color. Used by SD_TITLE_BAR... ensure not_void: Result /= Void non_focused_color_lightness: EV_COLOR -- Lighter `non_focused_color`. non_focused_title_color: EV_COLOR -- Non focused color of window title bar. ensure not_void: Result /= Void non_focused_title_text_color: EV_COLOR -- Non focused title text color ensure not_void: Result /= Void tab_text_color: EV_COLOR -- Text color ensure not_void: Result /= Void tool_bar_title_bar_color: EV_COLOR -- Tool bar tilte bar color when tool bar floating. ensure not_void: Result /= Void tool_tip_color: EV_COLOR -- Tooltip color which is used by SD_NOTEBOOK_HIDE_DIALOG. ensure not_void: Result /= Void feature -- Constants Auto_hide_delay: INTEGER_32 = 2000 -- When SD_AUTO_HIDE_ZONE show but no focused, time to hide SD_AUTO_HIDE_ZONE. Auto_hide_panel_gap_size: INTEGER_32 = 4 -- Auto hide panel's Gap size. Auto_hide_panel_lightness: REAL_32 = 0.5 -- Auto hide panel lightness value. Used by SD_AUTO_HIDE_PANEL. auto_hide_panel_size: INTEGER_32 -- Width of auto hide panel. Auto_hide_tab_stub_show_delay: INTEGER_32 = 1000 -- Auto hide tab stub delay time in milliseconds. Border_width: INTEGER_32 = 1 -- Border widht, used by SD_TITLE_BARs, SD_TAB_STUBs, SD_NOTEBOOK_TABs.... Default_docking_height_rate: REAL_32 = 0.25 -- When change from floating to docking, height := main container height * `default_docking_height_rate`. Default_docking_width_rate: REAL_32 = 0.2 -- When change from floating to docking, width := main container width * `default_docking_width_rate`. Default_floating_window_height: INTEGER_32 = 280 -- Default floating window height. Default_floating_window_width: INTEGER_32 = 470 -- Default floating window width. Editor_place_holder_content_name: STRING_32 = "docking manager editor place holder" -- Content name for place_holder_content in SD_DOCKING_MANAGER_ZONES. Feedback_tab_width: INTEGER_32 = 60 -- When user dragging, the width of feedback rectangle for tab. Focuse_border_width: INTEGER_32 = 1 -- Border width of a zone. This is width show focus color surround a zone. Hide_tab_indicator_size: INTEGER_32 = 20 -- Hide tab indicator size. Hide tabs are tabs in SD_NOTEBOOK_TAB_AREA. Highlight_before_width: INTEGER_32 = 4 -- Title highlight area width before drawn title texts. Highlight_tail_width: INTEGER_32 = 30 -- Tilte highlight area width which shown color chang gradually. Line_width: INTEGER_32 = 4 -- Width of feedback line. Notebook_minimum_width: INTEGER_32 = 77 -- Minimumu width for SD_NOTEBOOK, it's useful when a zone is minimized. notebook_tab_height: INTEGER_32 -- Notebook tab height. notebook_tab_maximum_size: INTEGER_32 -- Maximum size of a notebook tab. -- If the title on the tab would exceed this size, it is cropped. Padding_width: INTEGER_32 = 4 -- Padding width used by whole system. Resize_bar_width_height: INTEGER_32 = 5 -- Resize bar width or height which is used by SD_RESIZE_BAR. tab_zone_upper_minimum_height: INTEGER_32 -- SD_TAB_ZONE_UPPER and SD_DOCKING_ZONE_UPPER's minimum height. title_bar_height: INTEGER_32 -- Size of zone's title bar. Title_bar_text_start_x: INTEGER_32 = 0 -- When title bar drawing text, start x position. title_bar_text_start_y: INTEGER_32 -- When title bar drawing text, start y position. tool_bar_border_width: INTEGER_32 -- Tool bar border width. Tool_bar_customize_dialog_default_height: INTEGER_32 = 360 -- Tool bar customize dialog default height. Tool_bar_customize_dialog_default_width: INTEGER_32 = 560 -- Tool bar customize dialog default width. Tool_bar_hidden_item_dialog_max_width: INTEGER_32 = 400 -- Tool bar hidden item dialog maximum allowed width. tool_bar_size: INTEGER_32 -- Size of tool bar. When horizontal the size is height. When vertical the size is width. -- Note: SD_WIDGET_TOOL_BAR's size may bigger than this size when font size is very small. -- For example, on Linux Desktop when using font Scans 8. zone_minimum_height: INTEGER_32 -- Minimum height of a zone. zone_minimum_width: INTEGER_32 -- Minimum width of a zone. Zone_navigation_column_count: INTEGER_32 = 8 -- How many items per column in zone navigation dialog which is normally activated by Ctrl + Tab. feature -- Markers fixme (comment: READABLE_STRING_8) -- Mark code that has to be "fixed" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement (comment: READABLE_STRING_8) -- Mark code that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement_assertion (comment: READABLE_STRING_8): BOOLEAN -- Mark assertion that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class 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 -- Right click menu items notebook_tab_area_menu_items: ARRAYED_LIST [EV_MENU_ITEM] -- Menu items shown at notebook tab area. -- Client programmers can customize the menu items here ensure not_void: Result /= Void notebook_tab_area_menu_items_agent: detachable FUNCTION [SD_CONTENT, ARRAYED_LIST [EV_MENU_ITEM]] -- Menu items shown at notebook tab area -- Client programmers can customize the menu items here -- Same as `notebook_tab_area_menu_items` but has higer priority than `notebook_tab_area_menu_items` set_notebook_tab_area_menu_items_agent (a_agent: like notebook_tab_area_menu_items_agent) -- Set `notebook_tab_area_menu_items_agent` with a_gent ensure set: notebook_tab_area_menu_items_agent = a_agent set_title_bar_area_menu_items_agent (a_agent: like title_bar_area_menu_items_agent) -- Set `title_bar_area_menu_items_agent_cell` with a_agent ensure set: title_bar_area_menu_items_agent = a_agent title_bar_area_menu_items: ARRAYED_LIST [EV_MENU_ITEM] -- Menu items shown at {SD_CONTENT}'s title bar. -- Client programmers can customize the menu items here. ensure not_void: Result /= Void title_bar_area_menu_items_agent: detachable FUNCTION [SD_CONTENT, ARRAYED_LIST [EV_MENU_ITEM]] -- Menu items shown at {SD_CONTENT}'s title bar. -- Client programmers can customize the menu items here. -- Same as `title_bar_area_menu_items` but has higer priority than `title_bar_area_menu_items -- Note: parameter SD_CONTENT maybe 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_SHARED -- Generated by Eiffel Studio --
For more details: eiffel.org