IWindowHandle

The IWindowHandle class is a wrapper for handles of presentation system windows.

AIX Considerations

Use IWindowHandle in system calls where the X Toolkit type Widget is required.

OS/2 Considerations

Use IWindowHandle in system calls where the OS/2 Programmer's Toolkit type HWND is required.

Windows Considerations

Use IWindowHandle in system calls where the Win32 SDK type HWND is required.


IWindowHandle - Member Functions and Data by Group

Constructors & Destructor

You can construct objects of this class.


[view class]
IWindowHandle
public:
IWindowHandle(Value value = 0)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Diagnostics

Use these members to obtain diagnostic information.


[view class]
asDebugInfo
public:
IString asDebugInfo() const

Returns the handle as a string containing diagnostic information.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
asString
public:
IString asString() const

Returns the handle as a string of form nnnn.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
asUnsigned
public:
unsigned long asUnsigned() const

Returns the handle value as an unsigned long value.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Sending and Posting Events

Use these members to send or post an event to a window handle or handles.


[view class]
postEvent
public:
void postEvent( unsigned long eventId, const IEventParameter1& parm1 = 0ul, const IEventParameter2& parm2 = 0ul ) const

Posts an event constructed from the parameters to the window identified by this handle.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
postEvents
public:
void postEvents( unsigned long eventId, const IEventParameter1& parm1 = 0ul, const IEventParameter2& parm2 = 0ul, BroadcastTo value = descendants ) const

Posts one event to multiple windows.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
sendEvent
public:
IEventResult sendEvent( unsigned long eventId, const IEventParameter1& parm1 = 0ul, const IEventParameter2& parm2 = 0ul ) const

Sends an event constructed from the parameters to the window identified by this handle.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
sendEvents
public:
void sendEvents( unsigned long eventId, const IEventParameter1& parm1 = 0ul, const IEventParameter2& parm2 = 0ul, BroadcastTo value = descendants ) const

Broadcasts one event to multiple windows.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Testing

Use these members to test a window handle.


[view class]
isValid
public:
bool isValid() const

If the window handle is valid, true is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Type Conversions

Type conversion operators convert objects of this class to a different type.


[view class]
operator Value
public:
operator Value() const

Returns the handle as its operating system dependent type. Use this operator when you use the handle object as an argument to an operating system function.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IWindowHandle - Enumerations


[view class]
BroadcastTo
enum BroadcastTo { descendants, 
                   frames, 
                   frameDescendants }

Use these enumerators to specify post and send event-broadcasting attributes:

descendants
Broadcasts the event to all the descendants of this window handle.
frames
Broadcasts the event to frame windows only.
frameDescendants
Broadcasts the event to all the frame window descendants of this window handle.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IWindowHandle - Type Definitions


[view class]
Value
typedef INativeWindowHandle Value

This type definition is a synonym for the type used by the operating system for a window handle object. Use objects of this type for operating system function calls which require a window handle.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IWindowHandle - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data