Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XDialogEventHandler
Description
Handles events fired by dialogs represented by a XDialog interface.

Methods' Summary
callHandlerMethod Handles an event generated by a dialog. 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] XDialog  xDialog,
[in] any  EventObject,
[in] string  MethodName )
raises( ::com::sun::star::lang::WrappedTargetException );

Description
Handles an event generated by a dialog. 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 xDialog
the dialog instance that generated the event. This is the same dialog instance that was returned by the XDialogProvider2 createDialogWithHandler method when passing the XDialogEventHandler instance receiving the event as handler parameter.
Parameter EventObject
an object describing the event which occurred in the dialog or anything else that provides additional information for the event. If the event was caused by the dialog 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 Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.