(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.

:: com :: sun :: star :: awt ::

unpublished interface XContainerWindowEventHandler
Usage Restrictions
not published
Description
Handles events fired by windows represented by a XWindow interface.

Methods' Summary
callHandlerMethod Handles an event generated by a window. The implementation must be aware that the EventObject argument contains types which it is not prepared to handle. Similarly this applies for the MethodName argument. In this case the method should simply return false.  
getSupportedMethodNames returns a sequence of supported method names  
Methods' Details
callHandlerMethod
boolean
callHandlerMethod( [in] XWindow  xWindow,
[in] any  EventObject,
[in] string  MethodName )
raises( ::com::sun::star::lang::WrappedTargetException );

Description
Handles an event generated by a window. The implementation must be aware that the EventObject argument contains types which it is not prepared to handle. Similarly this applies for the MethodName argument. In this case the method should simply return false.
Parameter xWindow
the window instance that generated the event. If used in the scope of XContainerWindowProvider this is the same window instance that was returned by the createContainerWindow method when passing the XContainerWindowEventHandler instance receiving the event as handler parameter.
Parameter EventObject
an object describing the event which occurred in the window or anything else that provides additional information for the event. If the event was caused by the window or any of the controls which it contains then the any should contain an object derived from ::com::sun::star::lang::EventObject. Typically this would be one of the several com::sun::star::awt::*Event types.
Parameter MethodName
the name of the function which is to be called.
Returns
true if the event was handled, otherwise false.
Throws
com::sun::star::lang::WrappedTargetException if the implementation of the method, which is determined by the argument MethodName, throws an exception. This exception is then wrapped into a ::com::sun::star::lang::WrappedTargetException.
getSupportedMethodNames
sequence< string >
getSupportedMethodNames();

Description
returns a sequence of supported method names
Returns
all method names that will be accepted in calls to callHandlerMethod.
Top of Page

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.