Automatic generation produced by ISE Eiffel
note description: "EiffelVision menu item. Implementation interface." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2009-06-10 20:44:06 -0800 (Wed, 10 Jun 2009) $" revision: "$Revision: 79201 $" deferred class interface EV_MENU_ITEM_I feature -- Access accept_cursor: detachable EV_POINTER_STYLE -- Accept cursor set by user. -- To be displayed when the screen pointer is over a target that accepts -- `pebble` during pick and drop. -- (from EV_PICK_AND_DROPABLE_I) configurable_target_menu_handler: detachable PROCEDURE [EV_MENU, ARRAYED_LIST [EV_PND_TARGET_DATA], EV_PICK_AND_DROPABLE, detachable ANY] -- (from EV_PICK_AND_DROPABLE_I) deny_cursor: detachable EV_POINTER_STYLE -- Deny cursor set by user. -- To be displayed when the screen pointer is not over a valid target. -- (from EV_PICK_AND_DROPABLE_I) generating_type: TYPE [detachable EV_MENU_ITEM_I] -- 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 parent: detachable EV_ITEM_LIST [EV_ITEM] -- Item list containing Current. -- (from EV_ITEM_I) parent_imp: detachable EV_ITEM_LIST_I [EV_ITEM] -- The parent of the Current widget -- Can be void. -- (from EV_ITEM_I) pebble: detachable ANY -- Data to be transported by pick and drop mechanism. -- (from EV_PICK_AND_DROPABLE_I) pebble_function: detachable FUNCTION [detachable ANY] -- Returns data to be transported by pick and drop mechanism. -- (from EV_PICK_AND_DROPABLE_I) pebble_positioning_enabled: BOOLEAN -- If True then pick and drop start coordinates are -- `pebble_x_position`, `pebble_y_position`. -- If False then pick and drop start coordinates are -- the pointer coordinates. -- (from EV_PICK_AND_DROPABLE_I) pebble_x_position: INTEGER_32 -- Initial x position for pick and drop relative to Current. -- (from EV_PICK_AND_DROPABLE_I) pebble_y_position: INTEGER_32 -- Initial y position for pick and drop relative to Current. -- (from EV_PICK_AND_DROPABLE_I) pixmap: detachable EV_PIXMAP -- Image displayed on Current. -- (from EV_PIXMAPABLE_I) text: STRING_32 -- Text displayed in label. -- (from EV_TEXTABLE_I) ensure -- from EV_TEXTABLE_I not_void: Result /= Void cloned: Result /= text feature -- Measurement dpi: NATURAL_32 -- Window dpi. -- (from EV_POSITIONED_I) height: INTEGER_32 -- Vertical size in pixels. -- (from EV_POSITIONED_I) minimum_height: INTEGER_32 -- Minimum vertical size in pixels. -- (from EV_POSITIONED_I) minimum_width: INTEGER_32 -- Minimum horizontal size in pixels. -- (from EV_POSITIONED_I) screen_x: INTEGER_32 -- Horizontal offset relative to screen. -- (from EV_POSITIONED_I) screen_y: INTEGER_32 -- Vertical offset relative to screen. -- (from EV_POSITIONED_I) width: INTEGER_32 -- Horizontal size in pixels. -- (from EV_POSITIONED_I) x_position: INTEGER_32 -- Horizontal offset relative to parent `x_position` in pixels. -- (from EV_POSITIONED_I) y_position: INTEGER_32 -- Vertical offset relative to parent `y_position` in pixels. -- (from EV_POSITIONED_I) 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_MENU_ITEM_I): 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_MENU_ITEM_I): 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_MENU_ITEM_I): 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 internal_non_sensitive: BOOLEAN -- Is Current not sensitive to input as seen -- from `interface`? -- (from EV_SENSITIVE_I) is_destroyed: BOOLEAN -- Is Current no longer usable? -- (from EV_ANY_I) is_transport_enabled: BOOLEAN -- Is the transport mechanism enabled? -- (from EV_PICK_AND_DROPABLE_I) mode_is_configurable_target_menu: BOOLEAN -- Is the transport mechanism a configurable target menu? -- (from EV_PICK_AND_DROPABLE_I) mode_is_drag_and_drop: BOOLEAN -- Is the transport mechanism drag and drop? -- (from EV_PICK_AND_DROPABLE_I) mode_is_pick_and_drop: BOOLEAN -- Is the transport mechanism pick and drop? -- (from EV_PICK_AND_DROPABLE_I) mode_is_target_menu: BOOLEAN -- Is the transport mechanism a target menu? -- (from EV_PICK_AND_DROPABLE_I) 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)) user_is_sensitive: BOOLEAN -- Is the object sensitive to user input. -- (from EV_SENSITIVE_I) feature -- Status setting disable_pebble_positioning -- Assign False to `pebble_positioning_enabled`. -- (from EV_PICK_AND_DROPABLE_I) disable_transport -- Deactivate pick/drag and drop mechanism. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I is_transport_disabled: not is_transport_enabled enable_pebble_positioning -- Assign True to `pebble_positioning_enabled`. -- (from EV_PICK_AND_DROPABLE_I) enable_transport -- Activate pick/drag and drop mechanism. -- (from EV_PICK_AND_DROPABLE_I) require -- from EV_PICK_AND_DROPABLE_I pebble_not_void: pebble /= Void or pebble_function /= Void ensure -- from EV_PICK_AND_DROPABLE_I is_transport_enabled: is_transport_enabled remove_pebble -- Remove `pebble`. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I pebble_removed: pebble = Void and pebble_function = Void is_transport_disabled: not is_transport_enabled reset_pebble_function -- Reset any values created by calling `pebble_function`. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I pebble_function_preserved: pebble_function = old pebble_function pebble_without_function: pebble_function = Void implies (pebble = old pebble) pebble_with_function: pebble_function /= Void implies pebble = Void set_accept_cursor (a_cursor: like accept_cursor) -- Set a_cursor to be displayed when the screen pointer is over a -- target that accepts `pebble` during pick and drop. -- (from EV_PICK_AND_DROPABLE_I) set_configurable_target_menu_handler (a_handler: like configurable_target_menu_handler) -- Set Configurable Target Menu Handler to a_handler. -- (from EV_PICK_AND_DROPABLE_I) set_configurable_target_menu_mode -- Set transport mechanism to a configurable target_menu. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I mode_is_target_menu: mode_is_configurable_target_menu set_deny_cursor (a_cursor: like deny_cursor) -- Set a_cursor to be displayed when the screen pointer is over a -- target that doesn't accept `pebble` during pick and drop. -- (from EV_PICK_AND_DROPABLE_I) set_drag_and_drop_mode -- Set transport mechanism to drag and drop, -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I mode_is_drag_and_drop: mode_is_drag_and_drop set_pebble (a_pebble: ANY) -- Assign a_pebble to `pebble`. -- (from EV_PICK_AND_DROPABLE_I) require -- from EV_PICK_AND_DROPABLE_I a_pebble_not_void: a_pebble /= Void ensure -- from EV_PICK_AND_DROPABLE_I pebble_assigned: pebble = a_pebble is_transport_enabled: is_transport_enabled set_pebble_function (a_function: FUNCTION [detachable ANY]) -- Assign a_function to `pebble_function`. -- (from EV_PICK_AND_DROPABLE_I) require -- from EV_PICK_AND_DROPABLE_I a_function_not_void: a_function /= Void ensure -- from EV_PICK_AND_DROPABLE_I pebble_function_assigned: pebble_function = a_function is_transport_enabled: is_transport_enabled set_pebble_position (a_x, a_y: INTEGER_32) -- Set the initial position for pick and drop relative to Current. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I pick_x_assigned: pick_x.to_integer_32 = a_x pick_y_assigned: pick_y.to_integer_32 = a_y set_pick_and_drop_mode -- Set transport mechanism to pick and drop, -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I mode_is_pick_and_drop: mode_is_pick_and_drop set_target_menu_mode -- Set transport mechanism to a target_menu. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I mode_is_target_menu: mode_is_target_menu show_configurable_target_menu (a_x, a_y: INTEGER_32) -- Show the configurable target menu at position a_x, a_y relative to Current. -- (from EV_PICK_AND_DROPABLE_I) user_disable_sensitive -- Make object desensitive to user input. -- (from EV_SENSITIVE_I) ensure -- from EV_SENSITIVE_I is_desensitive: not user_is_sensitive user_enable_sensitive -- Make object sensitive to user input. -- (from EV_SENSITIVE_I) ensure -- from EV_SENSITIVE_I is_sensitive_if_parent_sensitive: (has_parent and then parent_is_sensitive) implies attached_interface.implementation.is_sensitive is_sensitive_if_orphaned: not has_parent implies attached_interface.implementation.is_sensitive feature -- Element change pixmap_equal_to (a_pixmap: EV_PIXMAP): BOOLEAN -- Is a_pixmap equal to `pixmap`? -- (from EV_PIXMAPABLE_I) remove_pixmap -- Make `pixmap` Void. -- (from EV_PIXMAPABLE_I) ensure -- from EV_PIXMAPABLE_I pixmap_removed: pixmap = Void set_pixmap (a_pixmap: EV_PIXMAP) -- Assign a_pixmap to `pixmap`. -- (from EV_PIXMAPABLE_I) require -- from EV_PIXMAPABLE_I pixmap_not_void: a_pixmap /= Void set_text (a_text: READABLE_STRING_GENERAL) -- Assign a_text to `text`. -- (from EV_TEXTABLE_I) require -- from EV_TEXTABLE_I a_text_not_void: a_text /= Void no_carriage_returns: not a_text.has_code (('%R').natural_32_code) ensure -- from EV_TEXTABLE_I text_cloned: attached a_text as l_text and then text.same_string_general (l_text) and then text /= l_text feature -- Duplication copy (other: EV_MENU_ITEM_I) -- 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_MENU_ITEM_I) -- 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_MENU_ITEM_I -- 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_MENU_ITEM_I) -- 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_MENU_ITEM_I -- 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_MENU_ITEM_I -- 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_MENU_ITEM_I -- 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 -- Access EV_DRAGABLE_SOURCE. dockable_dialog_target: detachable EV_DOCKABLE_DIALOG -- A dockable dialog that will be created as -- necessary. This is not a local, to avoid it -- being garbage collected. -- (from EV_SHARED_TRANSPORT_I) Global_drag_targets: ARRAYED_LIST [INTEGER_32] -- Shortcut to EV_APPLICATION.pnd_targets. -- (from EV_SHARED_TRANSPORT_I) frozen Insert_label: EV_CELL -- Label used to indicate where Current will be placed in target. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I result_not_void: Result /= Void Insert_label_imp: EV_CELL_I -- Once access to implementation of `insert_label`. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I Result /= Void Insert_sep: EV_TOOL_BAR_SEPARATOR -- Once access to a separator used to indicate the insertion position -- when moving tool bar items. -- (from EV_SHARED_TRANSPORT_I) Insert_sep_imp: EV_TOOL_BAR_SEPARATOR_I -- Once access to implementation of `insert_sep`. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I Result /= Void Internal_screen: EV_SCREEN -- Once access to an EV_SCREEN. -- (from EV_SHARED_TRANSPORT_I) original_x_offset: INTEGER_16 -- Original x_offset and original_y_offset of transport -- realtive to widget. Only used for dragable transports. -- (from EV_SHARED_TRANSPORT_I) original_y_offset: INTEGER_16 -- Original x_offset and original_y_offset of transport -- realtive to widget. Only used for dragable transports. -- (from EV_SHARED_TRANSPORT_I) originating_source: detachable EV_DOCKABLE_SOURCE_I -- Dragable source that originated the transport of source_being_dragged. -- (from EV_SHARED_TRANSPORT_I) remove_insert_label -- Remove `insert_label` from its current `parent`. -- We must handle a special case for cells. If the parent is a cell, -- then we remove the cell from its parent, and then restore it. -- Otherwise, when the label, removed, the cell keeps it size, and cells -- are normally used with real_target when the cell must -- not be visible. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I not_parented: Insert_label.parent = Void remove_insert_sep -- Ensure inset_sep is not parented. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I not_parented: Insert_sep.parent = Void source_being_docked: detachable EV_DOCKABLE_SOURCE_I -- Dragable source currently being transported. May be a -- WIDGET_IMP or an EV_TOOL_BAR_BUTTON_IMP. -- (from EV_SHARED_TRANSPORT_I) feature -- Access EV_PICK_AND_DROPABLE. Default_accept_cursor: EV_POINTER_STYLE -- Used in lieu of a user defined `accept_cursor`. -- (from EV_SHARED_TRANSPORT_I) Default_deny_cursor: EV_POINTER_STYLE -- Used in lieu of a user defined `deny_cursor`. -- (from EV_SHARED_TRANSPORT_I) Default_pixmaps: EV_STOCK_PIXMAPS -- Default pixmaps -- (from EV_SHARED_TRANSPORT_I) Global_pnd_targets: HASH_TABLE [INTEGER_32, INTEGER_32] -- Shortcut to EV_APPLICATION.pnd_targets. -- (from EV_SHARED_TRANSPORT_I) rubber_band_is_drawn: BOOLEAN -- Is a rubber band line currently on the screen? -- (from EV_SHARED_TRANSPORT_I) feature -- Access common. pointer_x: INTEGER_16 -- (from EV_SHARED_TRANSPORT_I) pointer_y: INTEGER_16 -- (from EV_SHARED_TRANSPORT_I) feature -- Event handling conforming_pick_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when a pebble that fits here is picked. -- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I) ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I not_void: Result /= Void drop_actions: EV_PND_ACTION_SEQUENCE -- Actions to be performed when a pebble is dropped here. -- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I) ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I not_void: Result /= Void pick_actions: EV_PND_START_ACTION_SEQUENCE -- Actions to be performed when `pebble` is picked up. -- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I) ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I not_void: Result /= Void pick_ended_actions: EV_PND_FINISHED_ACTION_SEQUENCE -- Actions to be performed when a transport from Current ends. -- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I) ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I not_void: Result /= Void pointer_button_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is pressed. -- (from EV_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void pointer_double_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer is double clicked. -- (from EV_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void pointer_motion_actions: EV_POINTER_MOTION_ACTION_SEQUENCE -- Actions to be performed when screen pointer moves. -- (from EV_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void select_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when selected. -- (from EV_MENU_ITEM_ACTION_SEQUENCES_I) ensure -- from EV_MENU_ITEM_ACTION_SEQUENCES_I not_void: Result /= Void 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 invariant -- from EV_PICK_AND_DROPABLE_I user_interface_modes_mutually_exclusive: mode_is_pick_and_drop.to_integer + mode_is_drag_and_drop.to_integer + mode_is_target_menu.to_integer = 1 pebble_function_takes_two_integer_open_operands: attached pebble_function as l_pebble_function implies l_pebble_function.valid_operands ([1, 1]) -- from EV_ANY_I interface_coupled: is_usable implies interface /= Void and then attached_interface.implementation = Current base_make_called: is_usable implies base_make_called -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from EV_POSITIONED_I minimum_width_positive_or_zero: is_usable implies minimum_width >= 0 minimum_height_positive_or_zero: is_usable implies minimum_height >= 0 note copyright: "Copyright (c) 1984-2006, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 356 Storke Road, 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_MENU_ITEM_I -- Generated by Eiffel Studio --
For more details: eiffel.org