Automatic generation produced by ISE Eiffel
note description: "Contents that have a tool bar items that client programmer want to managed by docking library." 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_CONTENT create make_with_items (a_unique_title: READABLE_STRING_GENERAL; a_items: like items) -- Creation method require a_title_not_void: a_unique_title /= Void a_items_not_void: a_items /= Void ensure set: unique_title.same_string_general (a_unique_title) set: items = a_items make_with_tool_bar (a_unique_title: READABLE_STRING_GENERAL; a_tool_bar: EV_TOOL_BAR) -- Creation method. A helper function, actually SD_TOOL_BAR_ZONE only appcept EV_TOOL_BAR_ITEMs. -- Warning: use this method will lose alpha data, which will show nothing when use AlphaBlend functions! require a_title_not_void: a_unique_title /= Void a_tool_bar_not_void: a_tool_bar /= Void ensure set: a_unique_title.same_string (unique_title) set: a_tool_bar.count = items.count feature -- Access generating_type: TYPE [detachable SD_TOOL_BAR_CONTENT] -- 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_TOOL_BAR_CONTENT): 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_TOOL_BAR_CONTENT): 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_TOOL_BAR_CONTENT): 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 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 -- Duplication copy (other: SD_TOOL_BAR_CONTENT) -- 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_CONTENT) -- 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_CONTENT -- 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_CONTENT) -- 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_CONTENT -- 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_CONTENT -- 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_CONTENT -- 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 close -- Close Current require not_destroyed: not is_destroyed destroy -- When a SD_DOCKING_MANAGER destroy, all SD_CONTENTs in it will be destroyed -- Clear all resources and all references ensure destroyed: is_destroyed hide -- Hide Current require not_destroyed: not is_destroyed refresh -- Refresh tool bar if items visible changed require not_destroyed: not is_destroyed set_title (a_display_title: READABLE_STRING_GENERAL) -- Set `title` with a_display_title require not_destroyed: not is_destroyed not_void: a_display_title /= Void ensure set: title.same_string_general (a_display_title) set_top (a_direction: INTEGER_32) -- Set dock at a_direction require not_destroyed: not is_destroyed valid: a_direction = {SD_ENUMERATION}.top or a_direction = {SD_ENUMERATION}.bottom added: is_added ensure visible: is_visible set_top_with (a_target_content: SD_TOOL_BAR_CONTENT) -- Set Current dock at same row/column with a_other_content require not_destroyed: not is_destroyed not_void: a_target_content /= Void added: is_added target_docking: a_target_content.is_docking ensure visible: is_visible show -- Show Current require not_destroyed: not is_destroyed 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 close_request_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to perfrom when close requested. group_items (a_group_index: INTEGER_32; a_include_invisible: BOOLEAN): LIST [SD_TOOL_BAR_ITEM] -- Group items. require valid: 0 < a_group_index and a_group_index <= groups_count (False) ensure not_void: Result /= Void not_contain_separator: ∀ c: Result ¦ not attached {SD_TOOL_BAR_SEPARATOR} c groups_count (a_include_invisible: BOOLEAN): INTEGER_32 -- Group count, group is buttons before one separater hash_code: INTEGER_32 -- Hash code ensure -- from HASHABLE good_hash_value: Result >= 0 is_added: BOOLEAN -- If Current added to a tool bar manager? is_contain_widget_item: BOOLEAN -- If Current contain normal widget items? is_destroyed: BOOLEAN -- If Current destroyed? is_docking: BOOLEAN -- If current docking at four side of main container? is_floating: BOOLEAN -- If current floating? is_menu_bar: BOOLEAN -- If Current is a menu bar which only contain SD_TOOL_BAR_MENU_ITEM. is_visible: BOOLEAN -- If Current visible? item_count_except_sep (a_include_invisible: BOOLEAN): INTEGER_32 -- Item count except SD_TOOL_BAR_SEPARATOR items: ARRAYED_SET [SD_TOOL_BAR_ITEM] -- All EV_TOOL_BAR_ITEM in Current including invisible items items_except_sep (a_include_invisible: BOOLEAN): LIST [SD_TOOL_BAR_ITEM] -- `items` except SD_TOOL_BAR_SEPARATOR ensure not_void: Result /= Void items_visible: LIST [SD_TOOL_BAR_ITEM] -- All displayed items ensure not_void: Result /= Void show_request_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to perform when show requested title: STRING_32 -- Title for display unique_title: STRING_32 -- Unique tool bar title -- It's used for store/open layout data, so it should not be changed invariant items_not_void: items /= Void -- 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-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_CONTENT -- Generated by Eiffel Studio --
For more details: eiffel.org