INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "Visual Eiffel Library.", "Win32 API: Message and Message Queue 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_MESSAGE_AND_MESSAGE_QUEUE_FUNCTIONS
inherit

WAPI_ERROR_SERVER
end
feature -- Access

DefWindowProc (hwnd, umsg, wparam, lparam: INTEGER): INTEGER
-- The 'DefWindowProc' function calls the default window procedure
-- to provide default processing for any window messages that
-- an application does not process. This function ensures that every
-- message is processed. 'DefWindowProc' is called with the same
-- parameters received by the window procedure.

DispatchMessage (lpmsg: POINTER): INTEGER
-- The 'DispatchMessage' function dispatches a message to a window
-- procedure. It is typically used to dispatch a message retrieved
-- by the 'GetMessage' function.
require
correct_lpmsg: lpmsg /= default_pointer

GetMessage (lpmsg: POINTER; hwnd, umsgfiltermin, umsgfiltermax: INTEGER): INTEGER
-- The 'GetMessage' function retrieves a message from the calling thread's
-- message queue and places it in the specified structure. This function
-- can retrieve both messages associated with a specified window and
-- thread messages posted via the 'PostThreadMessage' function.
-- The function retrieves messages that lie within a specified range
-- of message values. 'GetMessage' does not retrieve messages for windows
-- that belong to other threads or applications.
require
correct_lpmsg: lpmsg /= default_pointer

PeekMessage (lpmsg: POINTER; hwnd: INTEGER; wmsgfiltermin: INTEGER; wmsgfiltermax: INTEGER; wremovemsg: BIT 32): INTEGER
-- The `PeekMessage' function checks a thread message queue for a message
-- and places the message (if any) in the specified structure.
require
correct_lpmsg: lpmsg /= default_pointer

WaitMessage: INTEGER
-- Yields control to other threads when a thread has no other
-- messages in its message queue. The WaitMessage function suspends
-- the thread and does not return until a new message is placed in
-- the thread's message queue.
-- Result
-- True_ - if the function succeeds
-- False_ - if the function fails. To get extended error
-- information, call GetLastError.

PostMessage (hwnd, umsg, wparam, lparam: INTEGER)
-- The 'PostMessage' procedure places (posts) a message in the message
-- queue associated with the thread that created the specified window
-- and then returns without waiting for the thread to process the message.
-- Messages in a message queue are retrieved by calls to the 'GetMessage'
-- or 'PeekMessage' function.

PostQuitMessage (exitcode: INTEGER)
-- The 'PostQuitMessage' procedure indicates to Windows that a thread
-- has made a request to terminate (quit). It is typically used in
-- response to a WM_DESTROY message.

RegisterWindowMessage (lpsz: POINTER): INTEGER
-- The 'RegisterWindowMessage' function defines a new window message
-- that is guaranteed to be unique throughout the system. The returned
-- message value can be used when calling the 'SendMessage' or
-- 'PostMessage' function.
require
correct_lpsz: lpsz /= default_pointer

SendMessage (hwnd, umsg, wparam, lparam: INTEGER): INTEGER
-- The 'SendMessage' function sends the specified message to a window or
-- windows. The function calls the window procedure for the specified
-- window and does not return until the window procedure has processed
-- the message. The 'PostMessage' procedure, in contrast, posts a message
-- to a thread's message queue and returns immediately.
require
correct_hwnd: hwnd /= null_

TranslateMessage (lpmsg: POINTER): INTEGER
-- The 'TranslateMessage' function translates virtual-key messages
-- into character messages. The character messages are posted to the
-- calling thread's message queue, to be read the next time the thread
-- calls the 'GetMessage' or 'PeekMessage' function.
require
correct_lpmsg: lpmsg /= default_pointer

GetMessageTime: INTEGER

GetMessagePos: INTEGER

wRegisterWindowMessage (lpsz: POINTER): INTEGER

wPostMessage (hwnd, umsg, wparam, lparam: INTEGER): INTEGER
end -- class WAPI_MESSAGE_AND_MESSAGE_QUEUE_FUNCTIONS

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES