IEventData

The IEventData class encapsulates the data of an event. IEventData is interchangeable with the following classes, which are actually aliases (that is, typedefs) for IEventData:

Portability Considerations

The interpretation of the IEventData objects in an IEvent are system-dependent. See IEvent for a description of how the fields are interpreted in each environment. For applications you want to be portable, you should use accessor functions provided by derived classes of IEvent to access event data.

AIX Considerations

Although the Open Class Library sometimes internally uses the IEventResult value returned by the application, this value is not returned to the X-Motif window system. X-Motif does not support returning any value. Particularly, it does not support the ability to prevent further processing of the event by the windowing system.


IEventData - Member Functions and Data by Group

Constructors & Destructor

Construct and destruct objects of this class.


[view class]
IEventData
Construct an IEventData object.


Overload 1
public:
IEventData(int value)

Create an IEventData object from an integer. The event data is set to the specified integer. This constructor accepts an uncasted value of 0.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
IEventData(void* value)

Create an IEventData object from a pointer to a void. The event data is set to the specified void pointer.

value
A void pointer to use as the event data.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 3
public:
IEventData(unsigned short lowValue, unsigned short hiValue)

Create an IEventData object from two unsigned short integer values. The event data is set to an unsigned long integer whose two words are the two specified unsigned short integers.

lowValue
The low 16 bits of the event data
lowValue The high 16 bits of the event data

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 4
public:
IEventData( unsigned short lowValue, char lowByte, char hiByte )

Create an IEventData object using the specified unsigned short value and two characters. The event data is set to an unsigned long integer whose two words are the unsigned short integer in the low word and the two characters in the high word.

lowValue
The low 16 bits of the event data
lowByte The low 8 bits for the high 16 bits of the event data
hiByte The high 8 bits for the high 16 bits of the event data

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 5
public:
IEventData(unsigned long value)

Create an IEventData object from an unsigned long integer value. The event data is set to the specified unsigned long integer.

value
A long value to construct from

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 6
public:
IEventData()

Create an IEventData object with the event data set to 0.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Contents

These members query and set the event data contained by objects of this class.


[view class]
char1
public:
char char1() const
Returns the character in the low byte of the event data's low word. This is the same as lowLowByte.

Return
The low character of the event data

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
char2
public:
char char2() const

Returns the character in the high byte of the event data's low word. This is the same as lowHighByte.

Return
The second character of the event data

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
char3
public:
char char3() const
Returns the character in the low byte of the event data's high word. This is the same as highLowByte.

Return
The third character of the event data

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
char4
public:
char char4() const
Returns the character in the high byte of the event data's high word. This is the same as highHighByte.

Return
The fourth character of the event dat

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
highHighByte
public:
char highHighByte() const
Returns the character in the high byte of the event data's high word. This is the same as char4.

Return
The high byte of the event data

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
highLowByte
public:
char highLowByte() const
Returns the character in the low byte of the event data's high word. This is the same as char3.

Return
The low byte of the event data

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
highNumber
public:
unsigned short highNumber() const
Returns the event data's high word. This is the same as number2.

Return
The high 16 bits of the event data.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
lowHighByte
public:
char lowHighByte() const
Returns the character in the high byte of the event data's low word. This is the same as char2.

Return
The low byte of the high short of the event data.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
lowLowByte
public:
char lowLowByte() const
Returns the character in the low byte of the event data's low word. This is the same as char1.

Return
The low byte of the lower 16 bits of the event data.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
lowNumber
public:
unsigned short lowNumber() const
Returns the event data's low word. This is the same as number1.

Return
The low 16 bits of the event data.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
number1
public:
unsigned short number1() const
Returns the event data's low word. This is the same as lowNumber.

Return
The low short of the event data.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
number2
public:
unsigned short number2() const
Returns the event data's high word. This is the same as highNumber.

Return
The high short of the event data

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Conversion

These members convert an IEventData object to a four-byte value. You can either explicitly convert the object by calling a member function or casting, or allow the compiler to implicitly convert the object using an operator.


[view class]
asLong
public:
long asLong() const
Returns the long event data value.

Return
The event data as a long

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
asUnsignedLong
public:
unsigned long asUnsignedLong() const
Returns the unsigned long event data value.

Return
The event data as an unsigned long

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator char *
public:
operator char *() const
Returns the event data as a pointer to a character.

Return
The event data as a a char pointer

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator unsigned long
public:
operator unsigned long() const
Returns the event data as an unsigned long number.

Return
The event data as an unsigned long

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IEventData - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data