indexing
	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: 2008-05-08 18:18:29 -0700 (Thu, 08 May 2008) $"
	revision: "$Revision: 73426 $"

class interface
	WEL_API


create 
	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)

feature -- Access

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generating_type_not_void: Result /= Void
			generating_type_not_empty: not Result.is_empty

	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 (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies (other /= Void and then some.same_type (other))
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	frozen is_deep_equal (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.is_equal (Current)
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' 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
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (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: is_equal (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/twining semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result.is_equal (Current)
	
feature -- Basic operations

	frozen default: ?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)

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
	
feature -- API

	frozen free_module (a_module: POINTER): BOOLEAN
			-- Free module which instance is `a_module'

	frozen load_module (a_name: POINTER): POINTER
			-- Load module with `a_name'.
			-- `a_name' is LPCTSTR, we should use WEL_STRING here.

	frozen loal_api (a_module: POINTER; a_name: POINTER): POINTER
			-- Load api which name is `a_name' in `a_module'
	
feature -- Character codes

	frozen vk_key_scan (a_char: CHARACTER_32): INTEGER_32
			-- Given a character `a_char' gives us the key that triggers its generation.
	
feature -- Error

	frozen get_last_error: INTEGER_32
			-- SDK GetLastError
	
feature -- File Drop Handling

	frozen drag_query_file (hdrop: POINTER; ifile: INTEGER_32; buffer_pointer: POINTER; buffer_size: INTEGER_32): INTEGER_32
			-- SDK DragQueryFile
	
feature -- Menus

	frozen get_menu (hwnd: POINTER): POINTER
			-- SDK GetMenu

	frozen get_menu_bar_info (hwnd: POINTER; id_object, id_item: INTEGER_32; menu_bar_info: POINTER): INTEGER_32
			-- SDK GetMenuBarInfo

	frozen get_menu_item_rect (hwnd, hmenu: POINTER; uitem: INTEGER_32; rect: POINTER): INTEGER_32
			-- SDK GetMenuItemRect

	frozen set_menu (hwnd, hmenu: POINTER): INTEGER_32
			-- SDK SetMenu

	frozen track_popup_menu (hmenu: POINTER; flags, x, y, reserved: INTEGER_32; hwnd, rect: POINTER)
			-- SDK TrackPopupMenu
	
feature -- Messages

	frozen post_message (hwnd: POINTER; msg: INTEGER_32; wparam, lparam: POINTER)
			-- SDK PostMessage (without the result)

	frozen post_message_result (hwnd: POINTER; msg: INTEGER_32; wparam, lparam: POINTER): POINTER
			-- SDK PostMessage (with the result)

	frozen post_message_result_boolean (hwnd: POINTER; msg: INTEGER_32; wparam, lparam: POINTER): BOOLEAN
			-- SDK PostMessage (with the result)

	frozen register_window_message (a_message_name: POINTER): INTEGER_32
			-- Register a custom window message named `message_name'.
			-- `Result' is id of new message.

	frozen send_message (hwnd: POINTER; msg: INTEGER_32; wparam, lparam: POINTER)
			-- SDK SendMessage

	frozen send_message_result (hwnd: POINTER; msg: INTEGER_32; wparam, lparam: POINTER): POINTER
			-- SDK SendMessage (with the result)

	frozen send_message_result_boolean (hwnd: POINTER; msg: INTEGER_32; wparam, lparam: POINTER): BOOLEAN
			-- SDK SendMessage (with a boolean result)

	frozen send_message_result_integer (hwnd: POINTER; msg: INTEGER_32; wparam, lparam: POINTER): INTEGER_32
			-- SDK SendMessage (with an integer result)

	frozen send_message_timeout (hwnd: POINTER; msg: INTEGER_32; wparam, lparam: POINTER; fuflags, utimeout: INTEGER_32; lpdwresult: TYPED_POINTER [INTEGER_32])
			-- SDK SendMessageTimeout
	
feature -- Output

	io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			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 (some: ?ANY)
			-- Write terse external representation of `some'
			-- on standard output.
			-- (from ANY)

	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
			operating_environment_not_void: Result /= Void
	
feature -- Processes

	frozen close_handle (a_handle: POINTER): INTEGER_32
			-- SDK CloseHandle

	frozen duplicate_handle (hsourceprocess, hsource, htargetprocess: POINTER; htarget: TYPED_POINTER [POINTER]; access: INTEGER_32; inherithandle: BOOLEAN; options: INTEGER_32): INTEGER_32
			-- SDK DuplicateHandle

	frozen get_current_process: POINTER
			-- SDK GetCurrentProcess

	frozen msg_wait_for_multiple_objects (n: INTEGER_32; phandles: POINTER; waitall: BOOLEAN; ms, mask: INTEGER_32): INTEGER_32
			-- SDK MsgWaitForMultipleObjects

	frozen wait_for_input_idle (hprocess: POINTER; ms: INTEGER_32): INTEGER_32
			-- SDK WaitForInputIdle
	
feature -- Scrolling

	frozen 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).

	frozen 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.
	
feature -- Shell

	frozen shell_notify_icon (a_message: INTEGER_32; a_notify_icon_data_ptr: POINTER): INTEGER_32
			-- Sends a message to the taskbar's status area.
	
feature -- Windows

	frozen child_window_from_point (hwnd_parent: POINTER; point: POINTER): POINTER
			-- SDK ChildWindowFromPoint

	frozen get_focus: POINTER
			-- SDK GetFocus

	frozen move_window (hwnd: POINTER; a_x, a_y, a_w, a_h: INTEGER_32; repaint: BOOLEAN): BOOLEAN
			-- SDK MoveWindow

	frozen 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.

	frozen set_parent (hwnd_child, hwnd_parent: POINTER): POINTER
			-- Change the parent of the given child and return handle to
			-- previous parent, or NULL otherwise.

	frozen set_window_pos (hwnd, hwnd_after: POINTER; a_x, a_y, a_w, a_h, flags: INTEGER_32): BOOLEAN
			-- SDK SetWindowPos

	frozen set_window_text (hwnd, str: POINTER)
			-- SDK SetWindowText

	frozen window_from_point (point: POINTER): POINTER
			-- SDK WindowFromPoint
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

indexing
	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_API