Automatic generation produced by ISE Eiffel
note description: "Set of Win32 API that can be statically accessed." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2021-06-19 10:50:46 -0800 (Sat, 19 Jun 2021) $" revision: "$Revision: 105553 $" class interface WEL_API create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access generating_type: TYPE [detachable WEL_API] -- 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 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_API): 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_API): 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: WEL_API): 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 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)) feature -- Duplication copy (other: WEL_API) -- 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_API) -- 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_API -- 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_API) -- 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_API -- 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_API -- 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 WEL_API -- 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 -- API free_module (a_module: POINTER): BOOLEAN -- Free module which instance is a_module ensure is_class: class load_api (a_module: POINTER; a_name: POINTER): POINTER -- Load api which name is a_name in a_module ensure is_class: class load_module (a_name: POINTER): POINTER -- Load module with a_name. -- a_name is LPCTSTR, we should use WEL_STRING here. ensure is_class: class feature -- Caret Handling get_caret_pos (a_point: POINTER): BOOLEAN ensure is_class: class feature -- Character codes vk_key_scan (a_char: CHARACTER_32): INTEGER_32 -- Given a character a_char gives us the key that triggers its generation. ensure is_class: class feature -- Code pages ansi_code_page: NATURAL_32 -- The current Windows ANSI code page (ACP) identifier for the operating system. ensure is_class: class console_input_code_page: NATURAL_32 -- Input code page of the console. ensure is_class: class console_output_code_page: NATURAL_32 -- Output code page of the console. ensure is_class: class oem_code_page: NATURAL_32 -- The current OEM code page identifier for the operating system. -- The OEM code page is used for conversion from MS-DOS-based, text-mode applications. ensure is_class: class set_console_input_code_page (cp: NATURAL_32): BOOLEAN -- Set input code page of the console to cp. -- Return True on success and False on error. -- Use `get_last_error` to get extended error information. ensure is_class: class set_console_output_code_page (cp: NATURAL_32): BOOLEAN -- Set output code page of the console to cp. -- Return True on success and False on error. -- Use `get_last_error` to get extended error information. ensure is_class: class feature -- Data Operations hiword (value: POINTER): INTEGER_32 -- SDK HIWORD ensure is_class: class loword (value: POINTER): INTEGER_32 -- SDK LOWORD ensure is_class: class lparam (i: INTEGER_32): POINTER -- Convert integer value i in a valid `lparam` value. ensure is_class: class lresult (i: INTEGER_32): POINTER -- Convert integer value i in a valid LRESULT value. ensure is_class: class makelong (low, high: INTEGER_32): POINTER -- SDK MAKELONG ensure is_class: class wparam (i: INTEGER_32): POINTER -- Convert integer value i in a valid `wparam` value. ensure is_class: class feature -- Dialogs end_dialog (hwnd, return_value: POINTER): BOOLEAN -- SDK EndDialog ensure is_class: class feature -- Drawings exclude_clip_rect (hdc: POINTER; left, top, right, bottom: INTEGER_32): INTEGER_32 -- SDK ExcludeClipRect ensure is_class: class feature -- Error get_last_error: INTEGER_32 -- SDK GetLastError -- WARNING: it mays return wrong value in Multithreaded or SCOOP mode -- it is recommended to get the last error within the same C external. ensure is_class: class feature -- File Drop Handling drag_query_file (hdrop: POINTER; ifile: INTEGER_32; buffer_pointer: POINTER; buffer_size: INTEGER_32): INTEGER_32 -- SDK DragQueryFile ensure is_class: class feature -- File input/output cwin_create_file (name: POINTER; desired_access: NATURAL_32; shared_mode: NATURAL_32; security_attributes: POINTER; creation_disposition: NATURAL_32; flags_and_attributes: NATURAL_32; template_handle: POINTER): POINTER -- SDK CreateFile. ensure is_class: class cwin_read_file (file_handle: POINTER; buffer: POINTER; number_of_bytes_to_read: NATURAL_32; number_of_bytes_read: TYPED_POINTER [NATURAL_32]; overlapped: POINTER): BOOLEAN -- SDK ReadFile. ensure is_class: class cwin_read_file_with_error (file_handle: POINTER; buffer: POINTER; number_of_bytes_to_read: NATURAL_32; number_of_bytes_read: TYPED_POINTER [NATURAL_32]; overlapped: POINTER; last_error: TYPED_POINTER [NATURAL_32]): BOOLEAN -- SDK ReadFile. ensure is_class: class cwin_write_file (file_handle: POINTER; buffer: POINTER; number_of_bytes_to_write: NATURAL_32; number_of_bytes_written: TYPED_POINTER [NATURAL_32]; overlapped: POINTER): BOOLEAN -- SDK WriteFile. ensure is_class: class feature -- Menus get_menu (hwnd: POINTER): POINTER -- SDK GetMenu ensure is_class: class get_menu_bar_info (hwnd: POINTER; id_object, id_item: INTEGER_32; menu_bar_info: POINTER): INTEGER_32 -- SDK GetMenuBarInfo ensure is_class: class get_menu_item_rect (hwnd, hmenu: POINTER; uitem: INTEGER_32; rect: POINTER): INTEGER_32 -- SDK GetMenuItemRect ensure is_class: class set_menu (hwnd, hmenu: POINTER): INTEGER_32 -- SDK SetMenu ensure is_class: class track_popup_menu (hmenu: POINTER; flags, x, y, reserved: INTEGER_32; hwnd, rect: POINTER): INTEGER_32 -- SDK TrackPopupMenu ensure is_class: class feature -- Messages post_message (hwnd: POINTER; msg: INTEGER_32; a_wparam, a_lparam: POINTER) -- SDK PostMessage (without the result) ensure is_class: class post_message_result (hwnd: POINTER; msg: INTEGER_32; a_wparam, a_lparam: POINTER): BOOLEAN -- SDK PostMessage (with the result) ensure is_class: class post_thread_message (idthread: INTEGER_32; msg: INTEGER_32; a_wparam, a_lparam: POINTER) -- SDK PostThreadMessage (without the result) ensure is_class: class register_window_message (a_message_name: POINTER): INTEGER_32 -- Register a custom window message named message_name. -- Result is id of new message. ensure is_class: class send_message (hwnd: POINTER; msg: INTEGER_32; a_wparam, a_lparam: POINTER) -- SDK SendMessage ensure is_class: class send_message_result (hwnd: POINTER; msg: INTEGER_32; a_wparam, a_lparam: POINTER): POINTER -- SDK SendMessage (with the result) ensure is_class: class send_message_result_boolean (hwnd: POINTER; msg: INTEGER_32; a_wparam, a_lparam: POINTER): BOOLEAN -- SDK SendMessage (with a boolean result) ensure is_class: class send_message_result_integer (hwnd: POINTER; msg: INTEGER_32; a_wparam, a_lparam: POINTER): INTEGER_32 -- SDK SendMessage (with an integer result) ensure is_class: class send_message_timeout (hwnd: POINTER; msg: INTEGER_32; a_wparam, a_lparam: POINTER; fuflags, utimeout: INTEGER_32; lpdwresult: TYPED_POINTER [INTEGER_32]) -- SDK SendMessageTimeout ensure is_class: class feature -- Metrics get_system_metrics (value: INTEGER_32): INTEGER_32 -- SDK GetSystemMetrics ensure is_class: class feature -- Multi-monitor get_monitor_info (a_monitor_handle: POINTER; a_monitor_info: POINTER): BOOLEAN -- SDK GetMonitorInfo ensure is_class: class monitor_from_rect (a_rect: POINTER; a_flags: INTEGER_32): POINTER -- SDK MonitorFromRect ensure is_class: class monitor_from_window (a_hwnd: POINTER; a_flags: INTEGER_32): POINTER -- SDK MonitorFromWindow ensure is_class: class 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 feature -- Printing close_printer (a_printer: POINTER): BOOLEAN -- The ClosePrinter function closes the specified printer object. ensure is_class: class get_default_printer (a_name: POINTER; a_name_length: TYPED_POINTER [INTEGER_32]; a_error_code: TYPED_POINTER [INTEGER_32]): BOOLEAN -- The GetDefaultPrinter function retrieves the printer name -- of the default printer for the current user on the local computer. ensure is_class: class get_printer (a_printer: POINTER; a_level: INTEGER_32; a_printer_info: POINTER; a_buf_size: INTEGER_32; a_printer_info_length: TYPED_POINTER [INTEGER_32]; a_error_code: TYPED_POINTER [INTEGER_32]): BOOLEAN -- The GetPrinter function retrieves information about a specified printer. ensure is_class: class open_printer (a_name: POINTER; a_printer_handle: TYPED_POINTER [POINTER]; a_defaults: POINTER): BOOLEAN -- The OpenPrinter function retrieves a handle to the specified printer or print -- server or other types of handles in the print subsystem. ensure is_class: class feature -- Processes close_handle (a_handle: POINTER): INTEGER_32 -- SDK CloseHandle -- If the function fails, the return value is zero. ensure is_class: class create_process (a_name, a_command_line, a_sec_attributes1, a_sec_attributes2: POINTER; a_herit_handles: BOOLEAN; a_flags: INTEGER_32; an_environment, a_directory, a_startup_info, a_process_info: POINTER): BOOLEAN -- SDK CreateProcess ensure is_class: class duplicate_handle (hsourceprocess, hsource, htargetprocess: POINTER; htarget: TYPED_POINTER [POINTER]; access: INTEGER_32; inherithandle: BOOLEAN; options: INTEGER_32): INTEGER_32 -- SDK DuplicateHandle ensure is_class: class get_current_process: POINTER -- SDK GetCurrentProcess ensure is_class: class get_exit_code_process (handle: POINTER; ptr: POINTER): BOOLEAN -- SDK GetExitCodeProcess ensure is_class: class infinite: INTEGER_32 -- SDK INFINITE constant. ensure is_class: class msg_wait_for_multiple_objects (n: INTEGER_32; phandles: POINTER; waitall: BOOLEAN; ms, mask: INTEGER_32): INTEGER_32 -- SDK MsgWaitForMultipleObjects ensure is_class: class msg_wait_for_multiple_objects_ex (n: INTEGER_32; phandles: POINTER; ms, wakemask, flags: INTEGER_32): INTEGER_32 -- SDK MsgWaitForMultipleObjectsEx ensure is_class: class still_active: INTEGER_32 -- SDK STILL_ACTIVE constant ensure is_class: class terminate_process (handle: POINTER; exit_code: INTEGER_32): BOOLEAN -- SDK TerminateProcess ensure is_class: class wait_failed: INTEGER_32 -- SDK WAIT_FAILED constant. ensure is_class: class wait_for_input_idle (hprocess: POINTER; ms: INTEGER_32): INTEGER_32 -- SDK WaitForInputIdle ensure is_class: class wait_for_single_object (handle: POINTER; type: INTEGER_32): INTEGER_32 ensure is_class: class wait_object_0: INTEGER_32 -- SDK WAIT_OBJECT_0 constant. ensure is_class: class wait_timeout: INTEGER_32 -- SDK WAIT_TIMEOUT constant. ensure is_class: class feature -- Scrolling get_control_scroll_info (hwnd: POINTER; info: POINTER): INTEGER_32 -- Retrieves the parameters of a control scroll bar, including the minimum and maximum -- scrolling positions, the page size, and the position of the scroll box (thumb). ensure is_class: class get_scroll_info (a_hwnd: POINTER; a_bar: INTEGER_32; a_info: POINTER): INTEGER_32 -- Retrieves the parameters of a scroll bar, including the minimum and maximum -- scrolling positions, the page size, and the position of the scroll box (thumb). -- -- a_bar can be {WEL_SB_CONSTANTS}.sb_ctl, Sb_horz, Sb_vert ensure is_class: class set_control_scroll_info (hwnd: POINTER; info: POINTER; redraw: BOOLEAN): INTEGER_32 -- Sets the parameters of a control scroll bar, including the minimum and maximum -- scrolling positions, the page size, and the position of the scroll box (thumb). -- The function also redraws the scroll bar, if requested. ensure is_class: class feature -- Shell shell_notify_icon (a_message: INTEGER_32; a_notify_icon_data_ptr: POINTER): INTEGER_32 -- Sends a message to the taskbar's status area. ensure is_class: class feature -- Threads resume_thread (a_thread: POINTER): INTEGER_32 -- SDK ResumeThread ensure is_class: class feature -- Window class get_window_long (hwnd: POINTER; offset: INTEGER_32): POINTER -- SDK GetWindowLongPtr ensure is_class: class set_window_long (hwnd: POINTER; offset: INTEGER_32; value: POINTER): POINTER -- SDK SetWindowLongPtr ensure is_class: class feature -- Windows adjust_window_rect_ex (a_rect: POINTER; a_style, a_ex_style: INTEGER_32; a_is_menu: BOOLEAN): BOOLEAN -- Wrapper for AdjustWindowRectEx. ensure is_class: class begin_defer_window_pos (n: INTEGER_32): POINTER -- SDK BeginDeferWindowPos ensure is_class: class child_window_from_point (hwnd_parent: POINTER; point: POINTER): POINTER -- SDK ChildWindowFromPoint ensure is_class: class defer_window_pos (hdwp, hwnd, hwnd_after: POINTER; a_x, a_y, a_w, a_h, flags: INTEGER_32): POINTER -- SDK DeferWindowPos ensure is_class: class destroy_window (hwnd: POINTER): BOOLEAN -- SDK DestroyWindow ensure is_class: class end_defer_window_pos (hdwp: POINTER): BOOLEAN -- SDK EndDeferWindowPos ensure is_class: class find_window (a_class_name, a_window_name: POINTER): POINTER ensure is_class: class find_window_ex (a_parent, a_child_after, a_class_name, a_window_name: POINTER): POINTER ensure is_class: class get_focus: POINTER -- SDK GetFocus ensure is_class: class get_parent (a_hwnd: POINTER): POINTER -- SDK GetParent ensure is_class: class get_window (a_hwnd: POINTER; a_cmd: INTEGER_32): POINTER -- SDK GetWindow ensure is_class: class get_window_text (hwnd, str: POINTER; len: INTEGER_32): INTEGER_32 -- SDK GetWindowText ensure is_class: class move_window (hwnd: POINTER; a_x, a_y, a_w, a_h: INTEGER_32; repaint: BOOLEAN): BOOLEAN -- SDK MoveWindow ensure is_class: class set_foreground_window (hwnd: POINTER): BOOLEAN -- The SetForegroundWindow function puts the thread that created the specified -- window into the foreground and activates the window. Keyboard input is -- directed to the window, and various visual cues are changed for the user. -- The system assigns a slightly higher priority to the thread that created -- the foreground window than it does to other threads. ensure is_class: class set_parent (hwnd_child, hwnd_parent: POINTER): POINTER -- Change the parent of the given child and return handle to -- previous parent, or NULL otherwise. ensure is_class: class set_window_pos (hwnd, hwnd_after: POINTER; a_x, a_y, a_w, a_h, flags: INTEGER_32): BOOLEAN -- SDK SetWindowPos ensure is_class: class set_window_text (hwnd, str: POINTER) -- SDK SetWindowText ensure is_class: class window_from_point (point: POINTER): POINTER -- SDK WindowFromPoint ensure is_class: class invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2020, 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_API -- Generated by Eiffel Studio --
For more details: eiffel.org