IFrameFormatEvent

The IFrameFormatEvent class represents information about a frame format event. The frame window handler creates and dispatches objects of this class to IFrameHandler::format when a frame format event occurs.


IFrameFormatEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct, destruct, and copy objects of this class.


[view class]
~IFrameFormatEvent
public:
~IFrameFormatEvent()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IFrameFormatEvent


Overload 1
public:
IFrameFormatEvent(const IFrameFormatEvent& fmtEvent)

Construct an IFrameFormatEvent by copying the specified event.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
IFrameFormatEvent(const IEvent& baseEvent)

Construct an IFrameFormatEvent using the specified event. IFrameHandler::dispatchHandlerEvent constructs objects of this class from an object of the class IEvent and passes the resulting object to IFrameHandler::format. The event's window handle must be that of a frame window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes

OS/2 Considerations

The event object is expected to contain the following:

  • WM_FORMATFRAME for the event ID.
  • The event's first parameter is a pointer to an array of SWP structures. These dimensions of the array must be equal to the frame control count returned on the preceding WM_QUERYFRAMECTLCOUNT message.
  • The event's second parameter is a pointer to a RECTL structure in which the client control's size and position are returned.

The event result field will ultimately contain the count of the number of frame controls processed.


Formatting Information

Use these functions to query and set the position and size of frame extensions and other child windows of a frame window. You can query the ISWP objects associated with the event. You can query and set the client rectangle associated with this frame event using members from this group.


[view class]
clientRect
public:
IRectangle clientRect() const

Returns the client rectangle associated with this event. The rectangle is always in the orientation of the native windowing system. You can use the class ICoordinateSystem to determine the native orientation.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setClientRect
public:
IFrameFormatEvent& setClientRect( const IRectangle& rectangle )

Sets the client rectangle. You specify the rectangle in the orientation of the native windowing system. You can use the class ICoordinateSystem to determine the native orientation.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
swpArray
public:
ISWP* swpArray() const

Returns a pointer to the ISWP array associated with this event.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IFrameFormatEvent - Inherited Member Functions and Data

Inherited Public Functions

IEvent
IFrameEvent

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data