Automatic generation produced by ISE Eiffel
note description: "Contains information about a tree view control item." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2013-01-04 09:42:53 -0900 (Fri, 04 Jan 2013) $" revision: "$Revision: 90403 $" class interface WEL_TREE_VIEW_ITEM create make -- Make a tree item structure. 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 feature -- Access children: INTEGER_32 -- Information about the children of the item require exists: exists valid_member: children_is_valid generating_type: TYPE [detachable WEL_TREE_VIEW_ITEM] -- 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 h_item: POINTER -- Item to which this structure refers. require exists: exists item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) lparam: INTEGER_32 -- Information about the lparam of the item require exists: exists valid_member: lparam_is_valid mask: INTEGER_32 -- Array of flags that indicate which of the other -- structure members contain valid data or which are -- to be filled in. This member can be a combination -- of the Tvif_* values. -- See class WEL_TVIF_CONSTANTS. require exists: exists state: INTEGER_32 -- Current state of the item. require exists: exists valid_member: state_is_valid state_mask: INTEGER_32 -- State mask flag. require exists: exists text: STRING_32 -- Item text require valid_member: text_is_valid ensure result_not_void: Result /= Void Tvif_children: INTEGER_32 = 64 -- The cChildren member is valid. -- -- Declared in Windows as TVIF_CHILDREN -- (from WEL_TVIF_CONSTANTS) Tvif_handle: INTEGER_32 = 16 -- The hitem member is valid. -- -- Declared in Windows as TVIF_HANDLE -- (from WEL_TVIF_CONSTANTS) Tvif_image: INTEGER_32 = 2 -- The iImage member is valid. -- -- Declared in Windows as TVIF_IMAGE -- (from WEL_TVIF_CONSTANTS) Tvif_param: INTEGER_32 = 4 -- The lParam member is valid. -- -- Declared in Windows as TVIF_PARAM -- (from WEL_TVIF_CONSTANTS) Tvif_selectedimage: INTEGER_32 = 32 -- The iSelectedImage member is valid. -- -- Declared in Windows as TVIF_SELECTEDIMAGE -- (from WEL_TVIF_CONSTANTS) Tvif_state: INTEGER_32 = 8 -- The state and stateMask members are valid. -- -- Declared in Windows as TVIF_STATE -- (from WEL_TVIF_CONSTANTS) Tvif_text: INTEGER_32 = 1 -- The pszText and cchTextMax members are valid. -- -- Declared in Windows as TVIF_TEXT -- (from WEL_TVIF_CONSTANTS) feature -- Measurement Structure_size: INTEGER_32 -- Size to allocate (in bytes) ensure -- from WEL_STRUCTURE 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 alias "≡≡≡" (other: WEL_TREE_VIEW_ITEM): 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) 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: WEL_TREE_VIEW_ITEM): 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 children_is_valid: BOOLEAN -- Is the structure member `children` valid? require exists: exists 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) lparam_is_valid: BOOLEAN -- Is the structure member `lparam` valid? require exists: exists 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) state_is_valid: BOOLEAN -- Is the structure member `state` valid? require exists: exists text_is_valid: BOOLEAN -- Is the structure member `text` valid? require exists: exists feature -- Status setting 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 feature -- Element change add_mask (a_mask_value: INTEGER_32) -- add a_mask_value to the current mask. require exists: exists set_h_item (a_h_item: POINTER) -- Set `h_item` with a_h_item. require exists: exists ensure h_item_set: h_item = a_h_item set_image (image_normal: INTEGER_32; image_selected: INTEGER_32) -- Set the image for the tree item to image_normal. -- and image_selected for the image displayed when this -- item is selected. -- image_normal and image_selected are the index of -- an image in the image list associated with the treeview. require exists: exists set_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item set_lparam (a_lparam: INTEGER_32) -- Set a_lparam as current `lparam`. require exists: exists ensure lparam_set: lparam = a_lparam set_mask (a_mask_value: INTEGER_32) -- Set `mask` with a_mask_value. require exists: exists set_state (a_state: INTEGER_32) -- Set a_state as current `state`. require exists: exists ensure state_set: state = a_state set_text (a_text: READABLE_STRING_GENERAL) -- Set `text` with a_text. require exists: exists a_text_not_void: a_text /= Void ensure text_set: text.same_string_general (a_text) feature -- Removal 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) feature -- Duplication frozen deep_copy (other: WEL_TREE_VIEW_ITEM) -- 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_TREE_VIEW_ITEM -- 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_TREE_VIEW_ITEM) -- 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_TREE_VIEW_ITEM -- 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_TREE_VIEW_ITEM -- 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) copy (other: WEL_TREE_VIEW_ITEM) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from WEL_STRUCTURE) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen default: detachable WEL_TREE_VIEW_ITEM -- 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 structure_initialize -- Fill Current with zeros. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE exists: exists initialize_with_character (a_character: CHARACTER_8) -- Fill current with a_character. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE exists: exists is_equal (other: WEL_TREE_VIEW_ITEM): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from WEL_STRUCTURE) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result memory_copy (source_pointer: POINTER; length: INTEGER_32) -- Copy length bytes from source_pointer to `item`. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE length_small_enough: length <= Structure_size length_large_enough: length > 0 exists: exists 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) 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-2010, 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_TREE_VIEW_ITEM -- Generated by Eiffel Studio --
For more details: eiffel.org