Automatic generation produced by ISE Eiffel
note description: "[ The In-Ribbon Gallery is a control that displays a collection of related items or Commands in the Ribbon. If there are too many items in the gallery, an expand arrow is provided to display the rest of the collection in an expanded pane. ]" date: "$Date: 2013-05-20 15:15:17 -0800 (Mon, 20 May 2013) $" revision: "$Revision: 92557 $" deferred class interface EV_RIBBON_IN_RIBBON_GALLERY feature -- Access generating_type: TYPE [detachable EV_RIBBON_IN_RIBBON_GALLERY] -- 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 is_enabled: BOOLEAN -- If current has been checked? -- (from EV_RIBBON_BUTTON) require -- from EV_RIBBON_BUTTON ribbon_exists: attached ribbon as l_ribbon implies l_ribbon.exists select_actions: EV_NOTIFY_ACTION_SEQUENCE -- Select actions executed just after user clicked on button. -- (from EV_RIBBON_BUTTON) 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: EV_RIBBON_IN_RIBBON_GALLERY): 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: EV_RIBBON_IN_RIBBON_GALLERY): 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: EV_RIBBON_IN_RIBBON_GALLERY): 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: EV_RIBBON_IN_RIBBON_GALLERY) -- 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: EV_RIBBON_IN_RIBBON_GALLERY) -- 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: EV_RIBBON_IN_RIBBON_GALLERY -- 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: EV_RIBBON_IN_RIBBON_GALLERY) -- 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: EV_RIBBON_IN_RIBBON_GALLERY -- 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: EV_RIBBON_IN_RIBBON_GALLERY -- 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 EV_RIBBON_IN_RIBBON_GALLERY -- 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 -- Implementation command_list: ARRAY [NATURAL_32] -- Command ids handled by current -- (from EV_RIBBON_BUTTON) execute (a_command_id: NATURAL_32; a_execution_verb: INTEGER_32; a_property_key: POINTER; a_property_value: POINTER; a_command_execution_properties: POINTER): NATURAL_32 -- Responds to execute events on Commands bound to the Command handle -- This function is called from C codes -- (from EV_RIBBON_DROP_DOWN_GALLERY) require -- from EV_COMMAND_HANDLER_OBSERVER True update_property (a_command_id: NATURAL_32; a_property_key: POINTER; a_property_current_value: POINTER; a_property_new_value: POINTER): NATURAL_32 -- Responds to property update requests from the Ribbon framework -- This function is called from C codes -- (from EV_RIBBON_DROP_DOWN_GALLERY) require -- from EV_COMMAND_HANDLER_OBSERVER True feature -- Command ribbon: detachable EV_RIBBON -- Parent ribbon -- (from EV_COMMAND_HANDLER_OBSERVER) require -- from EV_RIBBON_TEXTABLE True require -- from EV_RIBBON_TOOLTIPABLE True require -- from EV_RIBBON_IMAGEABLE True set_enabled (a_bool: BOOLEAN) -- Set `is_enabled` with a_bool -- (from EV_RIBBON_BUTTON) require -- from EV_RIBBON_BUTTON ribbon_exists: attached ribbon as l_ribbon implies l_ribbon.exists set_item_source (a_item_source: like item_source) -- Set `item_source` with a_item_source -- (from EV_RIBBON_DROP_DOWN_GALLERY) require -- from EV_RIBBON_DROP_DOWN_GALLERY not_void: a_item_source /= Void set_large_image (a_image: EV_PIXEL_BUFFER) -- Set large image -- (from EV_RIBBON_IMAGEABLE) require -- from EV_RIBBON_IMAGEABLE not_void: a_image /= Void set_selected_item -- Set selected item -- (from EV_RIBBON_DROP_DOWN_GALLERY) set_small_image (a_image: EV_PIXEL_BUFFER) -- Set small image -- (from EV_RIBBON_IMAGEABLE) require -- from EV_RIBBON_IMAGEABLE not_void: a_image /= Void set_text (a_text: STRING_32) -- Set `label_title` with a_text -- (from EV_RIBBON_TEXTABLE) require -- from EV_RIBBON_TEXTABLE has_ribbon: attached ribbon ribbon_exists: attached ribbon as l_ribbon and then l_ribbon.exists set_tooltip_description (a_text: STRING_32) -- Set text with a_text -- (from EV_RIBBON_TOOLTIPABLE) set_tooltip_title (a_text: STRING_32) -- Set text with a_text -- (from EV_RIBBON_TOOLTIPABLE) 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 item_source: ARRAYED_LIST [EV_RIBBON_IN_RIBBON_GALLERY_ITEM] -- Query the collection of items in Current label_title: detachable STRING_32 -- Text will be used by `update_property` -- (from EV_RIBBON_TEXTABLE) selected_item: NATURAL_32 -- Current selected item index (base is 0) -- (from EV_RIBBON_DROP_DOWN_GALLERY) tooltip_description: detachable STRING_32 -- Text will be used by `update_property` -- (from EV_RIBBON_TOOLTIPABLE) tooltip_title: detachable STRING_32 -- Text will be used by `update_property` -- (from EV_RIBBON_TOOLTIPABLE) invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2011, 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 EV_RIBBON_IN_RIBBON_GALLERY -- Generated by Eiffel Studio --
For more details: eiffel.org