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.
You can construct, destruct, and copy objects of this class.
![]() |
public:
~IFrameFormatEvent()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IFrameFormatEvent(const IFrameFormatEvent& fmtEvent)
Construct an IFrameFormatEvent by copying the specified event.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
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.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The event object is expected to contain the following:
The event result field will ultimately contain the count of the number of frame controls processed.
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.
![]() |
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.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
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.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
ISWP* swpArray() const
Returns a pointer to the ISWP array associated with this event.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
virtual ~IEvent()
IWindowHandle controlHandle() const
virtual IWindow* controlWindow() const
IEvent& decrementOwnerLevels()
virtual IWindow* dispatchingWindow() const
unsigned long eventId() const
IWindowHandle handle() const
IEvent( const IWindowHandle& handle, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent(const IEvent& event)
IEvent( IWindow* window, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent& operator =(const IEvent& event)
IEventParameter1 parameter1() const
IEventParameter2 parameter2() const
bool passToOwner() const
IEventResult result() const
IEvent& setControlHandle(const IWindowHandle& handle)
IEvent& setDispatchingHandle(const IWindowHandle& handle)
IEvent& setDispatchingWindow(IWindow* window)
IEvent& setHandle(const IWindowHandle& handle)
IEvent& setNumberOfLevels(int levels = - 1)
IEvent& setPassToOwner(bool passOn = true)
IEvent& setResult(bool eventResult)
IEvent& setResult(const IEventResult& eventResult)
virtual IWindow* window() const
~IFrameEvent()
IFrameWindow* frame() const
IFrameEvent(const IEvent& baseEvent)
IFrameEvent(const IFrameEvent& frameEvent)
IFrameEvent& operator =(const IFrameEvent& frameEvent)