Automatic generation produced by ISE Eiffel
note description: "Zone that hold SD_TOOL_BAR_BUTTONs." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2021-06-25 04:16:34 -0800 (Fri, 25 Jun 2021) $" revision: "$Revision: 105580 $" class interface SD_TOOL_BAR_ZONE create make (a_vertical: BOOLEAN; a_is_menu_bar: BOOLEAN; a_content: SD_TOOL_BAR_CONTENT; a_docking_manager: SD_DOCKING_MANAGER) -- Creation method require a_docking_manager_not_void: a_docking_manager /= Void ensure set: is_vertical = a_vertical set: docking_manager = a_docking_manager feature -- Access generating_type: TYPE [detachable SD_TOOL_BAR_ZONE] -- 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 frozen id_object (an_id: INTEGER_32): detachable IDENTIFIED -- Object associated with an_id (void if no such object) -- (from IDENTIFIED) ensure -- from IDENTIFIED consistent: Result = Void or else Result.object_id = an_id frozen object_id: INTEGER_32 -- Unique for current object in any given session -- (from IDENTIFIED) ensure -- from IDENTIFIED valid_id: Result > 0 implies id_object (Result) = Current 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_TOOL_BAR_ZONE): 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_greater alias ">" (other: SD_TOOL_BAR_ZONE): BOOLEAN -- Is current object greater than other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = (other < Current) is_greater_equal alias ">=" alias "≥" (other: SD_TOOL_BAR_ZONE): BOOLEAN -- Is current object greater than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = (other <= Current) is_less_equal alias "<=" alias "≤" (other: SD_TOOL_BAR_ZONE): BOOLEAN -- Is current object less than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = ((Current < other) or (Current ~ other)) max alias "∨" (other: SD_TOOL_BAR_ZONE): SD_TOOL_BAR_ZONE -- The greater of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE current_if_not_smaller: Current >= other implies Result = Current other_if_smaller: Current < other implies Result = other min alias "∧" (other: SD_TOOL_BAR_ZONE): SD_TOOL_BAR_ZONE -- The smaller of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE current_if_not_greater: Current <= other implies Result = Current other_if_greater: Current > other implies Result = other 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_TOOL_BAR_ZONE): 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) three_way_comparison alias "⋚" (other: SD_TOOL_BAR_ZONE): INTEGER_32 -- If current object equal to other, 0; -- if smaller, -1; if greater, 1 -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE equal_zero: (Result = 0) = (Current ~ other) smaller_negative: (Result = -1) = (Current < other) greater_positive: (Result = 1) = (Current > other) 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 frozen id_freed: BOOLEAN -- Has Current been removed from the table? -- (from IDENTIFIED) is_hashable: BOOLEAN -- May current object be hashed? -- (True by default.) -- (from HASHABLE) 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 -- Removal dispose -- Free the entry associated with `object_id` if any -- (from IDENTIFIED) require -- from DISPOSABLE True ensure then -- from IDENTIFIED object_freed: id_freed frozen free_id -- Free the entry associated with `object_id` if any. -- (from IDENTIFIED) ensure -- from IDENTIFIED object_freed: id_freed feature -- Duplication copy (other: SD_TOOL_BAR_ZONE) -- 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_TOOL_BAR_ZONE) -- 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_TOOL_BAR_ZONE -- 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_TOOL_BAR_ZONE) -- 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_TOOL_BAR_ZONE -- 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_TOOL_BAR_ZONE -- 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_TOOL_BAR_ZONE -- 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 change_direction (a_horizontal: BOOLEAN) -- Change layout direction require not_destroyed: not is_destroyed ensure direction_changed: is_vertical = not a_horizontal clear_docking_manager -- Clear `docking_manager`. -- (from SD_DOCKING_MANAGER_HOLDER) compute_minmum_size require not_destroyed: not is_destroyed destroy -- Destroy -- Called by SD_TOOL_BAR_MANAGER.destroy ensure destroyed: is_destroyed destroy_parent_containers -- Destroy related parent containers require not_destroyed: not is_destroyed disable_drag_area -- Remove drag area which is located at head require not_destroyed: not is_destroyed dock -- Dock to a tool bar area require not_destroyed: not is_destroyed is_floating: is_floating ensure pruned: floating_tool_bar = Void enable_drag_area -- Show drag area which is located at the head require not_destroyed: not is_destroyed float (a_screen_x, a_screen_y: INTEGER_32; a_visible: BOOLEAN) -- Float to a_screen_x and a_screen_y require not_destroyed: not is_destroyed ensure pruned: (attached row as l_row and then attached {EV_WIDGET} tool_bar as lt_widget_2) implies not l_row.has (lt_widget_2) is_floating: is_floating hide -- Hide require not_destroyed: not is_destroyed prune (a_item: SD_TOOL_BAR_ITEM) -- Prune a_item require not_destroyed: not is_destroyed replace (a_content: SD_TOOL_BAR_CONTENT) -- Replace `content` with a_content. require not_destroyed: not is_destroyed a_content_not_void: a_content /= Void ensure set: content = a_content 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_position (a_screen_x, a_screen_y: INTEGER_32) -- Set position when `is_floating` require not_destroyed: not is_destroyed is_floating: is_floating ensure set: (create {PLATFORM} end).is_windows implies (attached floating_tool_bar as le_tool_bar and then (le_tool_bar.screen_x = a_screen_x and le_tool_bar.screen_y = a_screen_y)) show -- Show require not_destroyed: not is_destroyed update_drag_area --Update drag area sizes require not_destroyed: not is_destroyed wipe_out -- Wipe out require not_destroyed: not is_destroyed feature -- Command is add_auto_hide_panel (a_auto_hide_panel: SD_AUTO_HIDE_PANEL) -- Add a_auto_hide_panel's object id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_auto_hide_panel /= Void ensure -- from SD_WIDGETS_LISTS has: all_auto_hide_panels.has (a_auto_hide_panel) add_notebook (a_notebook: SD_NOTEBOOK) -- Add a_notebook' object id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_notebook /= Void ensure -- from SD_WIDGETS_LISTS has: all_notebooks.has (a_notebook) add_title_bar (a_title_bar: SD_TITLE_BAR) -- Add a_title_bar's object id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_title_bar /= Void ensure -- from SD_WIDGETS_LISTS has: all_title_bars.has (a_title_bar) add_tool_bar (a_tool_bar: SD_GENERIC_TOOL_BAR) -- Add a_tool_bar's object id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_tool_bar /= Void ensure -- from SD_WIDGETS_LISTS has: all_tool_bars.has (a_tool_bar) add_tool_bar_zone (a_tool_bar_zone: SD_TOOL_BAR_ZONE) -- Add a_tool_bar_zone's object id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_tool_bar_zone /= Void ensure -- from SD_WIDGETS_LISTS has: all_tool_bar_zones.has (a_tool_bar_zone) prune_auto_hide_panel (a_auto_hide_panel: SD_AUTO_HIDE_PANEL) -- Prune a_auto_hide_panel's object id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_auto_hide_panel /= Void ensure -- from SD_WIDGETS_LISTS not_has: not all_auto_hide_panels.has (a_auto_hide_panel) prune_notebook (a_notebook: SD_NOTEBOOK) -- Prune a_notebook's object id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_notebook /= Void ensure -- from SD_WIDGETS_LISTS not_has: not all_notebooks.has (a_notebook) prune_title_bar (a_title_bar: SD_TITLE_BAR) -- Prune a_title_bar's id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_title_bar /= Void ensure -- from SD_WIDGETS_LISTS not_has: not all_title_bars.has (a_title_bar) prune_tool_bar (a_tool_bar: SD_GENERIC_TOOL_BAR) -- Prune a_tool_bar's object id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_tool_bar /= Void ensure -- from SD_WIDGETS_LISTS not_has: not all_tool_bars.has (a_tool_bar) prune_tool_bar_zone (a_tool_bar_zone: SD_TOOL_BAR_ZONE) -- Prune a_tool_bar_zone's id. -- (from SD_WIDGETS_LISTS) require -- from SD_WIDGETS_LISTS not_void: a_tool_bar_zone /= Void ensure -- from SD_WIDGETS_LISTS not_has: not all_tool_bar_zones.has (a_tool_bar_zone) feature -- Implmentation hash_code: INTEGER_32 -- Hash code is index in all tool bar zones ensure -- from HASHABLE good_hash_value: Result >= 0 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 all_auto_hide_panels: ARRAYED_LIST [SD_AUTO_HIDE_PANEL] -- All SD_AUTO_HIDE_PANEL instances. -- (from SD_WIDGETS_LISTS) ensure -- from SD_WIDGETS_LISTS not_void: Result /= Void all_notebooks: ARRAYED_LIST [SD_NOTEBOOK] -- All SD_NOTEBOOK instances. -- (from SD_WIDGETS_LISTS) ensure -- from SD_WIDGETS_LISTS not_void: Result /= Void all_title_bars: ARRAYED_LIST [SD_TITLE_BAR] -- All SD_TITLE_BAR instances. -- (from SD_WIDGETS_LISTS) ensure -- from SD_WIDGETS_LISTS not_void: Result /= Void all_tool_bar_zones: ARRAYED_LIST [SD_TOOL_BAR_ZONE] -- All SD_TOOL_BAR_ZONE instances. -- (from SD_WIDGETS_LISTS) ensure -- from SD_WIDGETS_LISTS not_void: Result /= Void all_tool_bars: ARRAYED_LIST [SD_GENERIC_TOOL_BAR] -- All SD_TOOL_BAR instances. -- (from SD_WIDGETS_LISTS) ensure -- from SD_WIDGETS_LISTS not_void: Result /= Void assistant: SD_TOOL_BAR_ZONE_ASSISTANT -- Assistant to manage size issues content: like internal_content -- Attached `internal_content` require set: internal_content /= Void ensure not_void: Result /= Void customize_dialog: detachable SD_TOOL_BAR_CUSTOMIZE_DIALOG -- SD_TOOL_BAR_CUSTOMIZE_DIALOG if exists docking_manager: SD_DOCKING_MANAGER -- Docking manager instance. -- (from SD_DOCKING_MANAGER_HOLDER) drag_area_rectangle: EV_RECTANGLE -- Drag area rectangle floating_tool_bar: detachable SD_FLOATING_TOOL_BAR_ZONE -- Floating tool bar zone which contain Current when floating has (a_item: SD_TOOL_BAR_ITEM): BOOLEAN -- If Current has a_item? require not_destroyed: not is_destroyed has_drop_function (a_screen_x, a_screen_y: INTEGER_32): BOOLEAN -- If button at a_screen_x, a_screen_y has drop function? require not_destroyed: not is_destroyed has_pebble_function (a_screen_x, a_screen_y: INTEGER_32): BOOLEAN -- If button at a_screen_x, a_screen_y has pebble function? require not_destroyed: not is_destroyed has_right_click_action (a_screen_x, a_screen_y: INTEGER_32): BOOLEAN -- If button at a_screen_x, a_screen_y has pointer actions? require not_destroyed: not is_destroyed hidden_dialog_position: EV_COORDINATE -- Screen position for SD_TOOL_BAR_HIDDEN_ITEM_DIALOG require not_destroyed: not is_destroyed ensure not_void: Result /= Void internal_content: SD_TOOL_BAR_CONTENT -- Content in Current is_destroyed: BOOLEAN -- If Current destoryed? is_docking_manager_attached: BOOLEAN -- If `docking_manager` has been set? -- (from SD_DOCKING_MANAGER_HOLDER) is_equal (a_other: SD_TOOL_BAR_ZONE): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- Only compare position, used by {SD_TOOL_BAR_ROW}.zones require -- from ANY other_not_void: a_other /= Void ensure -- from ANY symmetric: Result implies a_other ~ Current consistent: standard_is_equal (a_other) implies Result ensure then -- from COMPARABLE trichotomy: Result = (not (Current < a_other) and not (a_other < Current)) is_floating: BOOLEAN -- If Current floating? require not_destroyed: not is_destroyed is_less alias "<" (a_other: SD_TOOL_BAR_ZONE): BOOLEAN -- Is current object less than other? -- Only compare position, used by {SD_TOOL_BAR_ROW}.zones require -- from PART_COMPARABLE other_exists: a_other /= Void ensure then -- from COMPARABLE asymmetric: Result implies not (a_other < Current) is_vertical: BOOLEAN -- Is Current vertical layout or horizontal layout? maximize_size: INTEGER_32 -- Maximize width of Current if not `is_vertical`. Maximize height of Current if `is_vertical` position: INTEGER_32 -- X position if not `is_vertical` or Y position if `is_vertical` require not_destroyed: not is_destroyed row: detachable SD_TOOL_BAR_ROW -- Parent which contain Current require not_destroyed: not is_destroyed size: INTEGER_32 -- Current size require not_destroyed: not is_destroyed ensure valid: Result >= 0 tool_bar: SD_GENERIC_TOOL_BAR -- Tool bar managed by Current. tool_bar_items: detachable ARRAYED_LIST [SD_TOOL_BAR_ITEM] -- Tool bar items on Current including invisible items. require not_destroyed: not is_destroyed ensure not_void: Result /= Void invariant not_void: internal_shared /= Void not_void: assistant /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from COMPARABLE irreflexive_comparison: not (Current < Current) note library: "SmartDocking: Library of reusable components for Eiffel." copyright: "Copyright (c) 1984-2021, 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_TOOL_BAR_ZONE -- Generated by Eiffel Studio --
For more details: eiffel.org