Automatic generation produced by ISE Eiffel
note description: "Represents structure that is sent to the OS to add,modify, inspect, ... items of a WEL_HEADER_CONTROL" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2012-11-28 08:31:03 -0900 (Wed, 28 Nov 2012) $" revision: "$Revision: 90000 $" class interface WEL_HD_ITEM create make -- Allocate `item` -- (from WEL_STRUCTURE) ensure -- from WEL_STRUCTURE 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 feature -- Access bitmap_handle: POINTER -- Handle to item bitmap. require exists: exists good_mask: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_bitmap) custom_data: INTEGER_32 -- Application-defined item data. require exists: exists good_mask: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_lparam) format: INTEGER_32 -- A set of bit flags that specify the item's format. -- Constants are defined in class WEL_HDF_CONSTANTS. -- Constants may be combined. require exists: exists good_mask: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_format) generating_type: TYPE [detachable WEL_HD_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 frozen hdf_bitmap: INTEGER_32 -- The item displays a bitmap. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class frozen hdf_center: INTEGER_32 -- Centers the contents of the item. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class frozen hdf_image: INTEGER_32 -- The item displays an image from an image list. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class frozen hdf_justify_mask: INTEGER_32 -- You can use this mask to isolate the text justification -- portion of the fmt member. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class frozen hdf_left: INTEGER_32 -- Left aligns the contents of the item. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class frozen hdf_owner_draw: INTEGER_32 -- The owner window of the header control draws the item. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class frozen hdf_right: INTEGER_32 -- Right aligns the contents of the item. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class frozen hdf_rtl_reading: INTEGER_32 -- In addition, on Hebrew or Arabic systems you can specify this flag -- to display text using right-to-left reading order. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class frozen hdf_string: INTEGER_32 -- The item displays a string. -- (from WEL_HDF_CONSTANTS) ensure -- from WEL_HDF_CONSTANTS is_class: class height: INTEGER_32 -- Height of item (Only available when mask contains Hdi_height require exists: exists good_mask: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_height) ensure positive_result: Result >= 0 iimage: INTEGER_32 -- Zero-based index of an image within the image list. require exists: exists item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) mask: INTEGER_32 -- Mask flags that indicate which of the other structure -- members contain valid data. -- Constants may be combined. -- The valid constants can be found in class WEL_HDI_CONSTANTS require exists: exists text: STRING_32 -- Text of the button associated with the notification. require exists: exists text_count: INTEGER_32 -- Count of characters in the button text. require exists: exists ensure positive_result: Result >= 0 width: INTEGER_32 -- Width of item (Only available when mask contains Hdi_width require exists: exists good_mask: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_width) ensure positive_result: Result >= 0 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_HD_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_HD_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 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) 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 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 set_bitmap (a_bitmap: WEL_BITMAP) -- Sets item bitmap. -- Also updates `mask` require exists: exists a_bitmap_not_void: a_bitmap /= Void bitmap_exsits: a_bitmap.exists ensure mask_set: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_bitmap) set_custom_data (value: INTEGER_32) -- Sets application-defined item data. -- Also updates `mask` require exists: exists ensure mask_set: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_lparam) set_format (value: INTEGER_32) -- Sets a set of bit flags that specify the item's format. -- Constants are defined in class WEL_HDF_CONSTANTS. -- Constants may be combined. -- Also updates `mask` require exists: exists ensure mask_set: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_format) set_height (value: INTEGER_32) -- Sets height of item with value -- Also updates `mask` -- Note: You can only specify either the width or the height require exists: exists positive_value: value >= 0 ensure mask_set: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_height) set_iimage (an_index: INTEGER_32) -- Zero-based index of an image within the image list. require exists: exists an_index_positive: an_index >= 0 set_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item set_mask (value: INTEGER_32) -- Sets mask flags that indicate which of the other structure -- members contain valid data. -- Constants may be combined. -- The valid constants can be found in class WEL_HDI_CONSTANTS require exists: exists set_text (a_text: READABLE_STRING_GENERAL) -- Set `text` with a_text. -- Also Updates `text_count` and `mask` require text_not_void: a_text /= Void ensure text_set: text.same_string_general (a_text) text_count_set: a_text.count = text_count mask_set: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_text) set_width (value: INTEGER_32) -- Sets width of item with value -- Also updates `mask` -- Note: You can only specify either the width or the height require exists: exists positive_value: value >= 0 ensure mask_set: flag_set (mask, {WEL_HDI_CONSTANTS}.hdi_width) 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_HD_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_HD_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_HD_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_HD_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_HD_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_HD_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_HD_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 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_HD_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-2012, 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_HD_ITEM -- Generated by Eiffel Studio --
For more details: eiffel.org