Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XDialogProvider2
Base Interfaces
XDialogProvider2XDialogProvider

XDialogProvider
(referenced interface's summary:)
provides dialogs implementing the XDialog interface.
Description
provides dialogs implementing the XDialog interface.

Methods' Summary
createDialogWithHandler creates a dialog for the given URL accepting an Interface used to handle dialog events.  
createDialogWithArguments creates a dialog for the given URL, accepting additional creation parameters  
Methods' Details
createDialogWithHandler
XDialog
createDialogWithHandler( [in] string  URL,
[in] ::com::sun::star::uno::XInterface  xHandler )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
creates a dialog for the given URL accepting an Interface used to handle dialog events.
Parameter URL
is the URL.
Parameter xHandler
is the interface that will be called to handle the Events that are generated by the dialog (and all controls placed on it) and bound to the handler using a vnd.sun.star.UNO URL specifying a handler method to be called. Usually this will be done directly by the user. xHandler can handle events in two different ways: 1. By supporting the XDialogEventHandler interface. This is a generic interface to accept event notifications. 2. By providing interfaces that directly implement the handler methods to be called. The XDialogProvider2 implementation then will try to access these events using the ::com::sun::star::beans::IntrospectionIntrospection service. To make this possible the handler implementation also has to support ::com::sun::star::lang::XTypeProvider. If XDialogEventHandler is supported XDialogEventHandler.callHandlerMethod() is always called first to handle the event. Only if the event cannot be handled by XDialogEventHandler (callHandlerMethod() then has to return false) or if XDialogEventHandler is not supported at all the Introspection based access will be used. The Introspection based access tries to call a method named according to the HandlerMethodName specified by a vnd.sun.star.UNO: URL. First a method void HandlerMethodName( [in] com::sun::star::awt::XDialog xDialog, [in] any aEvent ) will be searched. The signature is similar to XDialogEventHandler. callHandlerMethod except for MethodName itself that isn't needed here. For more information about these parameters, see XDialogEventHandler. If this method is found, it will be called, otherwise a method void HandlerMethodName( void ) will be searched and called.
Returns
a dialog implementing the XDialog interface.
Throws
com::sun::star::lang::IllegalArgumentException if no dialog for the given URL is found or if the URL is invalid or xHandler is null.
See also
XDialogEventHandler
createDialogWithArguments
XDialog
createDialogWithArguments( [in] string  URL,
[in] sequence< ::com::sun::star::beans::NamedValue >  Arguments )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
creates a dialog for the given URL, accepting additional creation parameters

The arguments accepted so far are

  • ParentWindow - must be a component supporting the XWindowPeer interface, or a component supporting the XControl interfac, so an XWindowPeer can be obtained from it. The given window will be used as parent window for the to-be-created dialog.
  • EventHandler - specifies a component handling events in the dialog. See createDialogWithHandler for a detailed specification of dialog event handling.

Top of Page

Apache Software Foundation

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

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.