Automatic generation produced by ISE Eiffel
note description: "Contains information about a notification message (Wm_notify)." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2009-02-24 14:44:31 -0900 (Tue, 24 Feb 2009) $" revision: "$Revision: 77298 $" class interface WEL_NMHDR 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 code: INTEGER_32 -- Notification code generating_type: TYPE [detachable WEL_NMHDR] -- 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 Gwl_exstyle: INTEGER_32 = -20 -- (from WEL_GWL_CONSTANTS) Gwl_style: INTEGER_32 = -16 -- (from WEL_GWL_CONSTANTS) id_from: INTEGER_32 -- Identifier of control sending message item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) Mb_abortretryignore: INTEGER_32 = 2 -- (from WEL_MB_CONSTANTS) Mb_applmodal: INTEGER_32 = 0 -- (from WEL_MB_CONSTANTS) Mb_default_desktop_only: INTEGER_32 = 131072 -- (from WEL_MB_CONSTANTS) Mb_defbutton1: INTEGER_32 = 0 -- (from WEL_MB_CONSTANTS) Mb_defbutton2: INTEGER_32 = 256 -- (from WEL_MB_CONSTANTS) Mb_defbutton3: INTEGER_32 = 512 -- (from WEL_MB_CONSTANTS) Mb_defmask: INTEGER_32 = 3840 -- (from WEL_MB_CONSTANTS) Mb_help: INTEGER_32 = 16384 -- (from WEL_MB_CONSTANTS) Mb_iconasterisk: INTEGER_32 = 64 -- (from WEL_MB_CONSTANTS) Mb_iconerror: INTEGER_32 = 16 -- Same as `mb_iconhand`. -- (from WEL_MB_CONSTANTS) Mb_iconexclamation: INTEGER_32 = 48 -- (from WEL_MB_CONSTANTS) Mb_iconhand: INTEGER_32 = 16 -- (from WEL_MB_CONSTANTS) Mb_iconinformation: INTEGER_32 = 64 -- Same as `mb_iconasterisk`. -- (from WEL_MB_CONSTANTS) Mb_iconmask: INTEGER_32 = 240 -- (from WEL_MB_CONSTANTS) Mb_iconquestion: INTEGER_32 = 32 -- (from WEL_MB_CONSTANTS) Mb_iconstop: INTEGER_32 = 16 -- Same as `mb_iconhand`. -- (from WEL_MB_CONSTANTS) Mb_iconwarning: INTEGER_32 = 48 -- Same as `mb_iconexclamation`. -- (from WEL_MB_CONSTANTS) Mb_nofocus: INTEGER_32 = 32768 -- (from WEL_MB_CONSTANTS) Mb_ok: INTEGER_32 = 0 -- (from WEL_MB_CONSTANTS) Mb_okcancel: INTEGER_32 = 1 -- (from WEL_MB_CONSTANTS) Mb_retrycancel: INTEGER_32 = 5 -- (from WEL_MB_CONSTANTS) Mb_right: INTEGER_32 = 524288 -- (from WEL_MB_CONSTANTS) Mb_rtlreading: INTEGER_32 = 1048576 -- (from WEL_MB_CONSTANTS) Mb_setforeground: INTEGER_32 = 65536 -- (from WEL_MB_CONSTANTS) Mb_systemmodal: INTEGER_32 = 4096 -- (from WEL_MB_CONSTANTS) Mb_taskmodal: INTEGER_32 = 8192 -- (from WEL_MB_CONSTANTS) Mb_topmost: INTEGER_32 = 262144 -- (from WEL_MB_CONSTANTS) Mb_typemask: INTEGER_32 = 15 -- (from WEL_MB_CONSTANTS) Mb_usericon: INTEGER_32 = 128 -- (from WEL_MB_CONSTANTS) Mb_yesno: INTEGER_32 = 4 -- (from WEL_MB_CONSTANTS) Mb_yesnocancel: INTEGER_32 = 3 -- (from WEL_MB_CONSTANTS) window_from: detachable WEL_WINDOW -- Control sending message 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_NMHDR): 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_NMHDR): 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) foreground_window: detachable WEL_WINDOW -- Foreground window (window with focus) -- (from WEL_WINDOWS_ROUTINES) is_terminal_service: BOOLEAN -- If window in terminal service (Remote Desktop)? -- (from WEL_WINDOWS_ROUTINES) require -- from WEL_WINDOWS_ROUTINES after_2000: (create {WEL_WINDOWS_VERSION} end).is_windows_2000_compatible is_window (hwnd: POINTER): BOOLEAN -- Does hwnd point to a valid Window? -- (from WEL_WINDOWS_ROUTINES) key_down (virtual_key: INTEGER_32): BOOLEAN --Is 'virtual' key pressed -- (from WEL_WINDOWS_ROUTINES) key_locked (virtual_key: INTEGER_32): BOOLEAN --Is 'virtual' key locked -- (from WEL_WINDOWS_ROUTINES) key_to_string (key_data: INTEGER_32): STRING_32 -- Give the string associated with the key given by -- virtual_key. -- (from WEL_WINDOWS_ROUTINES) 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) system_directory: STRING_32 -- Path of the Windows system directory -- (from WEL_WINDOWS_ROUTINES) ensure -- from WEL_WINDOWS_ROUTINES result_not_void: Result /= Void tick_count: INTEGER_32 -- Number of milliseconds that have -- elapsed since Windows was started. -- (from WEL_WINDOWS_ROUTINES) ensure -- from WEL_WINDOWS_ROUTINES positive_result: Result >= 0 window_of_item (hwnd: POINTER): detachable WEL_WINDOW -- Retrieve Eiffel object associated with hwnd pointer. -- (from WEL_WINDOWS_ROUTINES) require -- from WEL_WINDOWS_ROUTINES hwnd_not_null: hwnd /= default_pointer is_window_pointer: is_window (hwnd) ensure -- from WEL_WINDOWS_ROUTINES is_wel_window: Result /= Void end implies (create {INTERNAL} end).type_conforms_to ((create {INTERNAL} end).dynamic_type (Result), (create {INTERNAL} end).dynamic_type_from_string ("WEL_WINDOW")) is_proper_wel_window: Result /= Void implies Result.item = hwnd windows_directory: STRING_32 -- Path of the Windows directory -- (from WEL_WINDOWS_ROUTINES) ensure -- from WEL_WINDOWS_ROUTINES result_not_void: Result /= Void 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_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item 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_NMHDR) -- 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_NMHDR -- 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_NMHDR) -- 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_NMHDR -- 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_NMHDR -- 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 copy (other: WEL_NMHDR) -- 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 cwin_hi_word (value: POINTER): INTEGER_32 -- SDK HIWORD -- (from WEL_WORD_OPERATIONS) cwin_lo_word (value: POINTER): INTEGER_32 -- SDK LOWORD -- (from WEL_WORD_OPERATIONS) cwin_make_long (low, high: INTEGER_32): POINTER -- SDK MAKELONG -- (from WEL_WORD_OPERATIONS) cwin_make_lparam (low, high: INTEGER_32): POINTER -- SKD MAKELPARAM -- (from WEL_WORD_OPERATIONS) frozen default: detachable WEL_NMHDR -- 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 eif_current_object_id: INTEGER_32 -- New identifier for Current -- (from IDENTIFIED_ROUTINES) ensure -- from IDENTIFIED_ROUTINES eif_current_object_id: Result > 0 inserted: eif_is_object_id_of_current (Result) eif_id_any_object (an_id: INTEGER_32): detachable ANY -- Object associated with an_id -- (from IDENTIFIED_ROUTINES) require -- from IDENTIFIED_ROUTINES an_id_non_negative: an_id >= 0 ensure -- from IDENTIFIED_ROUTINES instance_free: class eif_is_object_id_of_current (an_id: INTEGER_32): BOOLEAN -- Is an_id the associated object ID of Current. -- (from IDENTIFIED_ROUTINES) require -- from IDENTIFIED_ROUTINES an_id_non_negative: an_id >= 0 eif_object_id (an_object: ANY): INTEGER_32 -- New identifier for an_object -- (from IDENTIFIED_ROUTINES) ensure -- from IDENTIFIED_ROUTINES instance_free: class eif_object_id_positive: Result > 0 inserted: eif_id_any_object (Result) = an_object eif_object_id_free (an_id: INTEGER_32) -- Free the entry an_id -- (from IDENTIFIED_ROUTINES) require -- from IDENTIFIED_ROUTINES an_id_non_negative: an_id >= 0 ensure -- from IDENTIFIED_ROUTINES instance_free: class removed: eif_id_any_object (an_id) = Void hide_cursor -- Hide the cursor. -- (from WEL_WINDOWS_ROUTINES) 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_NMHDR): 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 message_beep_asterisk -- Play the system asterisk waveform sound. -- (from WEL_WINDOWS_ROUTINES) message_beep_exclamation -- Play the system exclamation waveform sound. -- (from WEL_WINDOWS_ROUTINES) message_beep_hand -- Play the system hand waveform sound. -- (from WEL_WINDOWS_ROUTINES) message_beep_ok -- Play the system ok waveform sound. -- (from WEL_WINDOWS_ROUTINES) message_beep_question -- Play the system question waveform sound. -- (from WEL_WINDOWS_ROUTINES) output_debug_string (s: READABLE_STRING_GENERAL) -- Send a string s to the system debugger. -- (from WEL_WINDOWS_ROUTINES) require -- from WEL_WINDOWS_ROUTINES s_not_void: s /= Void resource_string_id (an_id: INTEGER_32): STRING_32 -- String identified by an_id in the resource file. -- (from WEL_WINDOWS_ROUTINES) ensure -- from WEL_WINDOWS_ROUTINES result_not_void: Result /= Void set_cursor_position_absolute (x, y: INTEGER_32) -- Set the cursor position to x, y. -- (from WEL_WINDOWS_ROUTINES) show_cursor -- Show the cursor. -- (from WEL_WINDOWS_ROUTINES) feature -- Conversion from Eiffel to Windows frozen to_lparam (i: INTEGER_32): POINTER -- Convert integer value i in a valid LPARAM value. -- (from WEL_DATA_TYPE) ensure -- from WEL_DATA_TYPE is_class: class frozen to_lresult (i: INTEGER_32): POINTER -- Convert integer value i in a valid LRESULT value. -- (from WEL_DATA_TYPE) ensure -- from WEL_DATA_TYPE is_class: class frozen to_wparam (i: INTEGER_32): POINTER -- Convert integer value i in a valid WPARAM value. -- (from WEL_DATA_TYPE) ensure -- from WEL_DATA_TYPE is_class: class feature -- For dialogs frozen dwlp_dlgproc: INTEGER_32 -- (from WEL_GWL_CONSTANTS) frozen dwlp_msgresult: INTEGER_32 -- (from WEL_GWL_CONSTANTS) frozen dwlp_user: INTEGER_32 -- (from WEL_GWL_CONSTANTS) feature -- For windows Gwl_hinstance: INTEGER_32 = -6 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwlp_hinstance`. -- (from WEL_GWL_CONSTANTS) Gwl_hwndparent: INTEGER_32 = -8 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwlp_hwndparent`. -- (from WEL_GWL_CONSTANTS) Gwl_id: INTEGER_32 = -12 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwlp_id`. -- (from WEL_GWL_CONSTANTS) Gwl_userdata: INTEGER_32 = -21 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwlp_userdata`. -- (from WEL_GWL_CONSTANTS) Gwl_wndproc: INTEGER_32 = -4 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwlp_wndproc`. -- (from WEL_GWL_CONSTANTS) Gwlp_hinstance: INTEGER_32 = -6 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwl_hinstance`. -- (from WEL_GWL_CONSTANTS) Gwlp_hwndparent: INTEGER_32 = -8 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwl_hwndparent`. -- (from WEL_GWL_CONSTANTS) Gwlp_id: INTEGER_32 = -12 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwl_id`. -- (from WEL_GWL_CONSTANTS) Gwlp_userdata: INTEGER_32 = -21 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwl_userdata`. -- (from WEL_GWL_CONSTANTS) Gwlp_wndproc: INTEGER_32 = -4 -- Was declared in {WEL_GWL_CONSTANTS} as synonym of `gwl_wndproc`. -- (from WEL_GWL_CONSTANTS) 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-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 WEL_NMHDR -- Generated by Eiffel Studio --
For more details: eiffel.org