Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "List of items which can be selected by the user." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2011-10-03 15:26:17 -0800 (Mon, 03 Oct 2011) $" revision: "$Revision: 87385 $" class interface WEL_MENU create make -- Make an empty menu make_by_id (id: INTEGER_32) -- Load the resource by an id -- (from WEL_RESOURCE) require -- from WEL_RESOURCE valid_id: id > 0 ensure -- from WEL_RESOURCE not_shared: not shared make_by_name (name: READABLE_STRING_GENERAL) -- Load the resource by a name -- (from WEL_RESOURCE) require -- from WEL_RESOURCE name_not_void: name /= Void name_not_empty: not name.is_empty ensure -- from WEL_RESOURCE not_shared: not shared make_by_pointer (a_pointer: POINTER) -- Set item with a_pointer. -- Since item is shared, it does not need -- to be freed. -- Caution: a_pointer must be a pointer -- coming from Windows. -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = a_pointer shared: shared make_track -- Make an empty track popup menu feature -- Access generating_type: TYPE [detachable WEL_MENU] -- 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 item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) Mf_append: INTEGER_32 = 256 -- (from WEL_MF_CONSTANTS) Mf_bitmap: INTEGER_32 = 4 -- (from WEL_MF_CONSTANTS) Mf_bycommand: INTEGER_32 = 0 -- (from WEL_MF_CONSTANTS) Mf_byposition: INTEGER_32 = 1024 -- (from WEL_MF_CONSTANTS) Mf_change: INTEGER_32 = 128 -- (from WEL_MF_CONSTANTS) Mf_checked: INTEGER_32 = 8 -- (from WEL_MF_CONSTANTS) Mf_delete: INTEGER_32 = 512 -- (from WEL_MF_CONSTANTS) Mf_disabled: INTEGER_32 = 2 -- (from WEL_MF_CONSTANTS) Mf_enabled: INTEGER_32 = 0 -- (from WEL_MF_CONSTANTS) Mf_end: INTEGER_32 = 128 -- (from WEL_MF_CONSTANTS) Mf_grayed: INTEGER_32 = 1 -- (from WEL_MF_CONSTANTS) Mf_help: INTEGER_32 = 16384 -- (from WEL_MF_CONSTANTS) Mf_hilite: INTEGER_32 = 128 -- (from WEL_MF_CONSTANTS) Mf_insert: INTEGER_32 = 0 -- (from WEL_MF_CONSTANTS) Mf_menubarbreak: INTEGER_32 = 32 -- (from WEL_MF_CONSTANTS) Mf_menubreak: INTEGER_32 = 64 -- (from WEL_MF_CONSTANTS) Mf_mouseselect: INTEGER_32 = 32768 -- (from WEL_MF_CONSTANTS) Mf_ownerdraw: INTEGER_32 = 256 -- (from WEL_MF_CONSTANTS) Mf_popup: INTEGER_32 = 16 -- (from WEL_MF_CONSTANTS) Mf_remove: INTEGER_32 = 4096 -- (from WEL_MF_CONSTANTS) Mf_separator: INTEGER_32 = 2048 -- (from WEL_MF_CONSTANTS) Mf_string: INTEGER_32 = 0 -- (from WEL_MF_CONSTANTS) Mf_sysmenu: INTEGER_32 = 8192 -- (from WEL_MF_CONSTANTS) Mf_unchecked: INTEGER_32 = 0 -- (from WEL_MF_CONSTANTS) Mf_unhilite: INTEGER_32 = 0 -- (from WEL_MF_CONSTANTS) Mf_usecheckbitmaps: INTEGER_32 = 512 -- (from WEL_MF_CONSTANTS) popup_menu (position: INTEGER_32): WEL_MENU -- Popup menu at the zero-based relative position require exists: exists position_large_enough: position >= 0 position_small_enough: position < count popup_exists: popup_exists (position) ensure result_not_void: Result /= Void tpm_bottomalign: INTEGER_32 -- (from WEL_TPM_CONSTANTS) tpm_centeralign: INTEGER_32 -- (from WEL_TPM_CONSTANTS) tpm_leftalign: INTEGER_32 -- (from WEL_TPM_CONSTANTS) tpm_leftbutton: INTEGER_32 -- (from WEL_TPM_CONSTANTS) tpm_returncmd: INTEGER_32 -- (from WEL_TPM_CONSTANTS) tpm_rightalign: INTEGER_32 -- (from WEL_TPM_CONSTANTS) tpm_rightbutton: INTEGER_32 -- (from WEL_TPM_CONSTANTS) tpm_topalign: INTEGER_32 -- (from WEL_TPM_CONSTANTS) tpm_vcenteralign: INTEGER_32 -- (from WEL_TPM_CONSTANTS) feature -- Measurement count: INTEGER_32 -- Number of items require exists: exists ensure positive_result: Result >= 0 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 (other: WEL_MENU): 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: WEL_MENU): 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 (other: WEL_MENU): 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 exists: BOOLEAN -- Does the item exist? -- (from WEL_ANY) ensure -- from WEL_ANY Result = (item /= default_pointer) flag_set (flags, mask: INTEGER_32): BOOLEAN -- Is mask set in flags? -- (from WEL_BIT_OPERATIONS) id_string (an_id: INTEGER_32): STRING_32 -- String associated with an_id require exists: exists positive_id: an_id > 0 item_exists: item_exists (an_id) ensure result_not_void: Result /= Void item_checked (an_id: INTEGER_32): BOOLEAN -- Is the item idenfied by an_id checked? require exists: exists positive_id: an_id > 0 item_exists: item_exists (an_id) item_enabled (an_id: INTEGER_32): BOOLEAN -- Is the item idenfied by an_id enabled? require exists: exists positive_id: an_id > 0 item_exists: item_exists (an_id) item_exists (an_id: INTEGER_32): BOOLEAN -- Does an_id exist in the menu? require exists: exists positive_id: an_id > 0 popup_exists (position: INTEGER_32): BOOLEAN -- Does a popup menu exists at the zero-based position? require exists: exists positive_position: position >= 0 position_enabled (position: INTEGER_32): BOOLEAN -- Is the item at zero-based position enabled? require exists: exists position_large_enough: position >= 0 position_small_enough: position < count 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)) shared: BOOLEAN -- Is item shared by another object? -- If False (by default), item will -- be destroyed by destroy_item. -- If True, item will not be destroyed. -- (from WEL_ANY) feature -- Status setting check_item (an_id: INTEGER_32) -- Put a check mark for the item identified by an_id. require exists: exists positive_id: an_id > 0 item_exists: item_exists (an_id) ensure item_checked: item_checked (an_id) disable_item (an_id: INTEGER_32) -- Disable the item identified by an_id. require exists: exists positive_id: an_id > 0 item_exists: item_exists (an_id) ensure item_disabled: not item_enabled (an_id) disable_position (position: INTEGER_32) -- Disable the item at zero-based position. require exists: exists position_large_enough: position >= 0 position_small_enough: position < count ensure position_disabled: not position_enabled (position) enable_item (an_id: INTEGER_32) -- Enable the item idenfied by an_id. require exists: exists positive_id: an_id > 0 item_exists: item_exists (an_id) ensure item_enabled: item_enabled (an_id) enable_position (position: INTEGER_32) -- Enable the item at zero-based position. require exists: exists position_large_enough: position >= 0 position_small_enough: position < count ensure position_enabled: position_enabled (position) set_shared -- Set shared to True. -- (from WEL_ANY) ensure -- from WEL_ANY shared: shared set_unshared -- Set shared to False. -- (from WEL_ANY) ensure -- from WEL_ANY unshared: not shared uncheck_item (an_id: INTEGER_32) -- Remove the check mark for the item identified -- by an_id. require exists: exists positive_id: an_id > 0 item_exists: item_exists (an_id) ensure item_unchecked: not item_checked (an_id) feature -- Element change append_bitmap (bitmap: WEL_BITMAP; an_id: INTEGER_32) -- Append bitmap with the identifier an_id to the -- menu. require exists: exists bitmap_not_void: bitmap /= Void bitmap_exists: bitmap.exists positive_id: an_id > 0 item_not_exists: not item_exists (an_id) ensure new_count: count = old count + 1 item_exists: item_exists (an_id) append_popup (a_menu: WEL_MENU; a_title: READABLE_STRING_GENERAL) -- Append a popup menu a_menu with a_title to the -- current menu. require exists: exists a_menu_not_void: a_menu /= Void a_menu_exists: a_menu.exists a_title_not_void: a_title /= Void ensure new_count: count = old count + 1 append_separator -- Append a separator to the current menu. require exists: exists ensure new_count: count = old count + 1 append_string (a_string: READABLE_STRING_GENERAL; an_id: INTEGER_32) -- Append a_string with the identifier an_id to the -- menu. require exists: exists a_string_not_void: a_string /= Void positive_id: an_id > 0 item_not_exists: not item_exists (an_id) ensure new_count: count = old count + 1 item_exists: item_exists (an_id) string_set: id_string (an_id).same_string_general (a_string) append_string_with_break (a_string: READABLE_STRING_GENERAL; an_id: INTEGER_32; has_separator: BOOLEAN) -- Append an item with a break to the menu. -- All the following items will be set in a new column. -- If has_separator is True, then a vertical separator -- appears between the two columns. require exists: exists a_string_not_void: a_string /= Void positive_id: an_id > 0 item_not_exists: not item_exists (an_id) ensure new_count: count = old count + 1 item_exists: item_exists (an_id) string_set: id_string (an_id).same_string_general (a_string) insert_bitmap (bitmap: WEL_BITMAP; a_position, an_id: INTEGER_32) -- Insert bitmap at zero-based a_position with -- an_id. require exists: exists a_position_large_enough: a_position >= 0 a_position_small_enough: a_position <= count bitmap_not_void: bitmap /= Void bitmap_exists: bitmap.exists positive_id: an_id > 0 item_not_exists: not item_exists (an_id) ensure new_count: count = old count + 1 insert_popup (a_menu: WEL_MENU; a_position: INTEGER_32; a_title: READABLE_STRING_GENERAL) -- Insert a popup menu a_menu at zero-based a_position -- with a_title. require exists: exists a_menu_not_void: a_menu /= Void a_menu_exists: a_menu.exists a_title_not_void: a_title /= Void a_position_large_enough: a_position >= 0 a_position_small_enough: a_position <= count ensure new_count: count = old count + 1 popup_menu_set: popup_menu (a_position).item = a_menu.item insert_separator (a_position: INTEGER_32) -- Insert a separator at zero-based a_position. require exists: exists a_position_large_enough: a_position >= 0 a_position_small_enough: a_position <= count ensure new_count: count = old count + 1 insert_string (a_string: READABLE_STRING_GENERAL; a_position, an_id: INTEGER_32) -- Insert a_string at zero-based a_position with -- an_id. require exists: exists a_position_large_enough: a_position >= 0 a_position_small_enough: a_position <= count a_string_not_void: a_string /= Void positive_id: an_id > 0 item_not_exists: not item_exists (an_id) ensure new_count: count = old count + 1 string_set: id_string (an_id).same_string_general (a_string) modify_string (a_string: READABLE_STRING_GENERAL; an_id: INTEGER_32) -- Modify the menu title identified by an_id to -- a_string. require exists: exists a_string_not_void: a_string /= Void positive_id: an_id > 0 item_exists: item_exists (an_id) ensure string_set: id_string (an_id).same_string_general (a_string) set_item (an_item: POINTER) -- Set item with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item feature -- Removal delete_item (an_id: INTEGER_32) -- Delete an_id from the menu. require exists: exists positive_id: an_id > 0 item_exists: item_exists (an_id) ensure new_count: count = old count - 1 item_not_exists: not item_exists (an_id) delete_position (position: INTEGER_32) -- Delete the item at zero-based position. require exists: exists position_large_enough: position >= 0 position_small_enough: position < count ensure new_count: count = old count - 1 dispose -- Destroy the inner structure of Current. -- -- This function should be called by the GC when the -- object is collected or by the user if Current is -- no more usefull. -- (from WEL_ANY) remove_position (position: INTEGER_32) -- Remove the item at zero-based position. require exists: exists position_large_enough: position >= 0 position_small_enough: position < count ensure new_count: count = old count - 1 feature -- Conversion position_to_item_id (position: INTEGER_32): INTEGER_32 -- Retrieve the menu item identifier of a menu item at -- the zero-based position. -- Return 0 if the item at the zero-based -- position is a separator or a pop-up menu. require exists: exists position_large_enough: position >= 0 position_small_enough: position < count feature -- Duplication copy (other: WEL_MENU) -- 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: WEL_MENU) -- 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: WEL_MENU -- 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: WEL_MENU) -- 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: WEL_MENU -- 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: WEL_MENU -- 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 clear_flag (flags, mask: INTEGER_32): INTEGER_32 -- Clear the mask in flags -- (from WEL_BIT_OPERATIONS) ensure -- from WEL_BIT_OPERATIONS flag_unset: not flag_set (Result, mask) frozen default: detachable WEL_MENU -- 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 hilite_menu_item (window: WEL_COMPOSITE_WINDOW; an_id: INTEGER_32) -- Hilite the item identified by an_id in the -- window's menu. require exists: exists window_not_void: window /= Void window_exists: window.exists positive_id: an_id > 0 item_exists: item_exists (an_id) set_flag (flags, mask: INTEGER_32): INTEGER_32 -- Set the mask in flags -- (from WEL_BIT_OPERATIONS) ensure -- from WEL_BIT_OPERATIONS flag_set: flag_set (Result, mask) show_track (x, y: INTEGER_32; window: WEL_COMPOSITE_WINDOW) -- Show a track popup menu at the x and y absolute -- position. window will receive the selection in -- on_menu_command. require exists: exists not_empty: count > 0 window_not_void: window /= Void window_exists: window.exists show_track_with_option (x, y: INTEGER_32; window: WEL_COMPOSITE_WINDOW; option: INTEGER_32; rect: detachable WEL_RECT) -- Show a track popup menu with option at -- the x and y absolute position. -- window will receive the selection in -- on_menu_command. -- rect specifies the portion of the screen -- in which the user can select without -- dismissing the popup menu. If this parameter -- is Void the popup menu is dismissed if the -- user clicks outside the popup menu require exists: exists not_empty: count > 0 window_not_void: window /= Void window_exists: window.exists unhilite_menu_item (window: WEL_COMPOSITE_WINDOW; an_id: INTEGER_32) -- unhilite the item identified by an_id in the -- window's menu. require exists: exists window_not_void: window /= Void window_exists: window.exists positive_id: an_id > 0 item_exists: item_exists (an_id) 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 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 WEL_MENU
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

-- Generated by Eiffel Studio --
For more details: eiffel.org