Automatic generation produced by ISE Eiffel
note description: "Common ancestor for docking tool bars." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2017-02-26 05:18:00 -0900 (Sun, 26 Feb 2017) $" revision: "$Revision: 99858 $" deferred class interface SD_GENERIC_TOOL_BAR feature -- Access generating_type: TYPE [detachable SD_GENERIC_TOOL_BAR] -- 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_GENERIC_TOOL_BAR): 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_GENERIC_TOOL_BAR): 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_GENERIC_TOOL_BAR): 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_GENERIC_TOOL_BAR) -- 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_GENERIC_TOOL_BAR) -- 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_GENERIC_TOOL_BAR -- 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_GENERIC_TOOL_BAR) -- 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_GENERIC_TOOL_BAR -- 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_GENERIC_TOOL_BAR -- 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_GENERIC_TOOL_BAR -- 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 -- Docking command compute_minimum_size -- Compute minmum_width and `minimum_height` extend (a_item: SD_TOOL_BAR_ITEM) -- Extend a_item to the end. require not_void: a_item /= Void valid: is_item_valid (a_item) ensure has: has (a_item) is_parent_set: is_parent_set (a_item) force (a_item: SD_TOOL_BAR_ITEM; a_index: INTEGER_32) -- Assign item a_item to a_index-th entry. -- Always applicable: resize the array if a_index falls out of -- currently defined bounds; preserve existing items. require not_void: a_item /= Void valid: is_item_valid (a_item) prune (a_item: SD_TOOL_BAR_ITEM) -- Prune a_item set_need_calculate_size (a_bool: BOOLEAN) -- Set if need recalculate `row_height` ensure a_bool_set: is_need_calculate_size = a_bool update_size -- Update tool_bar size if Current width changed feature -- Docking query content: detachable SD_TOOL_BAR_CONTENT -- Related tool bar content. has (a_item: SD_TOOL_BAR_ITEM): BOOLEAN -- If Current has a_item ? is_item_position_valid (a_screen_x, a_screen_y: INTEGER_32): BOOLEAN -- If a_screen_x and a_screen_y within tool bar items area? is_item_valid (a_item: SD_TOOL_BAR_ITEM): BOOLEAN -- If a_item valid? is_need_calculate_size: BOOLEAN -- Need recalcualte current `row_height` because of something have been changed? is_parent_set (a_item: SD_TOOL_BAR_ITEM): BOOLEAN -- If a_item parent set? item_at_position (a_screen_x, a_screen_y: INTEGER_32): detachable SD_TOOL_BAR_ITEM -- Item at a_screen_x, a_screen_y -- Result may be void when tool bar wraps. require in_position: is_item_position_valid (a_screen_x, a_screen_y) items: ARRAYED_SET [SD_TOOL_BAR_ITEM] -- Visible items ensure not_void: Result /= Void items_have_texts: BOOLEAN -- If any item has text? padding_width: INTEGER_32 -- Padding width 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 -- Vision2 command clear_rectangle (x, y, a_width, a_height: INTEGER_32) -- Draw rectangle with upper-left corner on (x, y) -- with size a_width and a_height in background_color. destroy -- Destroy underlying native toolkit object. -- Render Current unusable. disable_capture -- Disable capture enable_capture -- Enable capture object_id: INTEGER_32 -- Unique for current object in any given session redraw_rectangle (a_x, a_y, a_width, a_height: INTEGER_32) -- Call `expose_actions` for rectangle described with upper-left -- corner on (a_x, a_y) with size a_width and a_height when next idle. set_pointer_style (a_style: EV_POINTER_STYLE) -- Assign a_style to pointer style. set_tooltip (a_tooltip: READABLE_STRING_GENERAL) -- Assign a_tooltip to `tooltip`. wipe_out -- Wipe out feature -- Vision2 query has_capture: BOOLEAN -- Does widget have capture? height: INTEGER_32 -- Vertical size in pixels. -- Same as `minimum_height` when not displayed. is_destroyed: BOOLEAN -- Is Current no longer usable? is_displayed: BOOLEAN -- Is Current visible on the screen? -- True when show requested and parent displayed. minimum_height: INTEGER_32 -- Lower bound on `height` in pixels. minimum_width: INTEGER_32 -- Lower bound on `width` in pixels. pointer_button_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is pressed. pointer_button_release_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is released. pointer_double_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer is double clicked. pointer_motion_actions: EV_POINTER_MOTION_ACTION_SEQUENCE -- Actions to be performed when screen pointer moves. screen_x: INTEGER_32 -- Horizontal offset relative to screen. screen_y: INTEGER_32 -- Vertical offset relative to screen. tooltip: STRING_32 -- Tooltip displayed on Current. -- If Result is empty then no tooltip displayed. width: INTEGER_32 -- Horizontal size in pixels. -- Same as `minimum_width` when not displayed. 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-2016, 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_GENERIC_TOOL_BAR -- Generated by Eiffel Studio --
For more details: eiffel.org