INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "Visual Eiffel Library.", "Win32 API: Window Functions"
project: "Visual Eiffel Win32 Library"
revision: "$Revision: 1.1 $"
copyright: "Copyright (C) 1996-2005 Object Tools Group"
license: "http://visual-eiffel.com/license"
cluster: winlib
class WAPI_WINDOW_FUNCTIONS
inherit

WAPI_ERROR_SERVER
end
feature -- Access

BringWindowToTop (hwnd: INTEGER)
-- The `BringWindowToTop' function brings the specified window to the top
-- of the Z order. If the window is a top-level window, it is activated.
-- If the window is a child window, the top-level parent window associated
-- with the child window is activated.
require
correct_hwnd: hwnd /= null_

CreateWindow (lpszclassname: POINTER; lpszwindowname: POINTER; dwstyle: BIT 32; x, y, nwidth, nheight: INTEGER; hwndparent: INTEGER; hmenu: INTEGER; hinst: INTEGER; lpvparam: POINTER): INTEGER
-- The 'CreateWindow' function creates an overlapped, pop-up,
-- or child window. It specifies the window class, window title,
-- window style, and (optionally) the initial position and size
-- of the window. The function also specifies the window's parent
-- or owner, if any, and the window's menu.
require
correct_lpszclassname: lpszclassname /= default_pointer
correct_hinst: hinst /= null_

CreateWindowEx (dwexstyle: BIT 32; lpszclassname: POINTER; lpszwindowname: POINTER; dwstyle: BIT 32; x, y, nwidth, nheight: INTEGER; hwndparent: INTEGER; hmenu: INTEGER; hinst: INTEGER; lpvparam: POINTER): INTEGER
-- The 'CreateWindowEx' function creates an overlapped, pop-up,
-- or child window with an extended style; otherwise, this function
-- is identical to the 'CreateWindow' function.
-- For more information about creating a window and for full
-- descriptions of the other parameters of 'CreateWindowEx',
-- see 'CreateWindow'.
require
correct_lpszclassname: lpszclassname /= default_pointer
correct_hinst: hinst /= null_

DestroyWindow (hwnd: INTEGER)
-- The 'DestroyWindow' procedure destroys the given window.
-- The procedure sends WM_DESTROY and WM_NCDESTROY messages to the window
-- to deactivate it and remove the keyboard focus from it.
-- The procedure also destroys the window's menu, flushes the thread
-- message queue, destroys timers, removes clipboard ownership, and breaks
-- the clipboard viewer chain (if the window is at the top of the viewer
-- chain).
--
-- If the given window is a parent or owner window, 'DestroyWindow'
-- automatically destroys the associated child or owned windows when it
-- destroys the parent or owner window. The procedure first destroys
-- child or owned windows, and then it destroys the parent or owner window.
--
-- 'DestroyWindow' also destroys modeless dialog boxes created by the
-- 'CreateDialog' function.
require
correct_hwnd: hwnd /= null_

EnableWindow (hwnd, fenable: INTEGER): INTEGER
-- The 'EnableWindow' function enables or disables mouse and keyboard
-- input to the specified window or control. When input is disabled,
-- the window does not receive input such as mouse clicks and key presses.
-- When input is enabled, the window receives all input.
require
correct_hwnd: hwnd /= null_
correct_fenable: fenable = 0 or fenable = 1

GetClientRect (hwnd: INTEGER; lprc: POINTER)
-- The 'GetClientRect' procedure retrieves the coordinates of a window's
-- client area. The client coordinates specify the upper-left and
-- lower-right corners of the client area. Because client coordinates
-- are relative to the upper-left corner of a window's client area,
-- the coordinates of the upper-left corner are (0,0).
require
correct_hwnd: hwnd /= null_
correct_lprc: lprc /= default_pointer

GetWindowLong (hwnd, nindex: INTEGER): INTEGER
-- The 'GetWindowLong' function retrieves information about the specified
-- window. The function also retrieves the 32-bit (long) value at the
-- specified offset into the extra window memory of a window.
require
correct_hwnd: hwnd /= null_

GetWindowRect (hwnd: INTEGER; lprc: POINTER)
-- The 'GetWindowRect' procedure retrieves the dimensions of the bounding
-- rectangle of the specified window. The dimensions are given in screen
-- coordinates that are relative to the upper-left corner of the screen.
require
correct_hwnd: hwnd /= null_
correct_lprc: lprc /= default_pointer

GetWindowText (hwnd: INTEGER; lpsz: POINTER; cch: INTEGER): INTEGER
-- The 'GetWindowText' function copies the text of the specified
-- window's title bar (if it has one) into a buffer. If the specified
-- window is a control, the text of the control is copied.
require
correct_hwnd: hwnd /= null_
correct_lpsz: lpsz /= default_pointer

IsIconic (hwnd: INTEGER): BOOLEAN
-- The `IsIconic' function determines whether the specified window
-- is minimized (iconic).

IsWindow (hwnd: INTEGER): INTEGER
-- The 'IsWindow' function determines whether the specified window handle
-- identifies an existing window.

IsChild (hwndparent, hwnd: INTEGER): INTEGER
-- The IsChild function tests whether a window is a child window
-- or descendant window of a specified parent window. A child window
-- is the direct descendant of a specified parent window if that
-- parent window is in the chain of parent windows; the chain of
-- parent windows leads from the original overlapped or pop-up window
-- to the child window.

IsWindowEnabled (hwnd: INTEGER): INTEGER
-- The 'IsWindowEnabled' function determines whether the specified window
-- is enabled for mouse and keyboard input.
require
correct_hwnd: hwnd /= null_

IsWindowVisible (hwnd: INTEGER): INTEGER
-- The 'IsWindowVisible' function retrieves the visibility state
-- of the specified window.
require
correct_hwnd: hwnd /= null_

IsZoomed (hwnd: INTEGER): BOOLEAN
-- The `IsZoomed' function determines whether a window is maximized.

MoveWindow (hwnd, x, y, cx, cy, frepaint: INTEGER)
-- The 'MoveWindow' procedure changes the position and dimensions
-- of the specified window. For a top-level window, the position and
-- dimensions are relative to the upper-left corner of the screen.
-- For a child window, they are relative to the upper-left corner
-- of the parent window's client area.
require
correct_hwnd: hwnd /= null_

SetParent (hwndchild, hwndnewparent: INTEGER)
-- The SetParent function changes the parent window of the specified
-- child window

SetWindowLong (hwnd, nindex, lnewlong: INTEGER): INTEGER
-- The 'SetWindowLong' function changes an attribute of the specified
-- window. The function also sets a 32-bit (long) value at the specified
-- offset into the extra window memory of a window.
require
correct_hwnd: hwnd /= null_

SetWindowPos (hwnd, hwndinsertafter, x, y, cx, cy: INTEGER; fuflags: BIT 32)
-- The 'SetWindowPos' procedure changes the size, position, and Z order
-- of a child, pop-up, or top-level window. Child, pop-up, and top-level
-- windows are ordered according to their appearance on the screen.
-- The topmost window receives the highest rank and is the first window
-- in the Z order.
require
correct_hwnd: hwnd /= null_

SetWindowText (hwnd: INTEGER; lpsz: POINTER)
-- The 'SetWindowText' procedure changes the text of the specified
-- window's title bar (if it has one). If the specified window
-- is a control, the text of the control is changed.
require
correct_hwnd: hwnd /= null_
correct_lpsz: lpsz /= default_pointer

ShowWindow (hwnd, ncmdshow: INTEGER): INTEGER
-- The 'ShowWindow' function sets the specified window's show state.
require
correct_hwnd: hwnd /= null_

GetParent (hwnd: INTEGER): INTEGER
require
correct_hwnd: hwnd /= null_

WindowFromPoint (x, y: INTEGER): INTEGER
-- The WindowFromPoint function retrieves a handle to the
-- window that contains the specified point
feature -- Implementation

wBringWindowToTop (hwnd: INTEGER): INTEGER

wCreateWindowEx (dwexstyle: BIT 32; lpszclassname: POINTER; lpszwindowname: POINTER; dwstyle: BIT 32; x, y, nwidth, nheight: INTEGER; hwndparent: INTEGER; hmenu: INTEGER; hinst: INTEGER; lpvparam: POINTER): INTEGER

wDestroyWindow (hwnd: INTEGER): INTEGER

wGetClientRect (hwnd: INTEGER; lprc: POINTER): INTEGER

wGetWindowRect (hwnd: INTEGER; lprc: POINTER): INTEGER

wIsIconic (hwnd: INTEGER): INTEGER

wIsZoomed (hwnd: INTEGER): INTEGER

wMoveWindow (hwnd, x, y, cx, cy, frepaint: INTEGER): INTEGER

wSetParent (hwndchild, hwndnewparent: INTEGER): INTEGER

wSetWindowLong (hwnd, nindex, lnewlong: INTEGER): INTEGER

wSetWindowPos (hwnd, hwndinsertafter, x, y, cx, cy: INTEGER; fuflags: BIT 32): INTEGER

wSetWindowText (hwnd: INTEGER; lpsz: POINTER): INTEGER

frozen SetWindowRgn (hwnd: INTEGER; hrgn: INTEGER; bredraw: INTEGER): INTEGER
-- The SetWindowRgn function sets the window region of a window. The
-- window region determines the area within the window where the operating
-- system permits drawing. The operating system does not display any
-- portion of a window that lies outside of the window region

frozen GetDesktopWindow: INTEGER
-- The GetDesktopWindow function returns the handle of the Windows desktop
-- window.

frozen wAdjustWindowRectEx (lprect: POINTER; dwstyle, bmenu, dwexstyle: INTEGER): INTEGER
end -- class WAPI_WINDOW_FUNCTIONS

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES