/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_awt_XDialogProvider2_idl__ #define __com_sun_star_awt_XDialogProvider2_idl__ #include #include //============================================================================= module com { module sun { module star { module awt { //============================================================================= /** provides dialogs implementing the XDialog interface. */ interface XDialogProvider2 : ::com::sun::star::awt::XDialogProvider { //------------------------------------------------------------------------- /** creates a dialog for the given URL accepting an Interface used to handle dialog events. @param URL is the URL. @param 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 IntrospectionIntrospection service. To make this possible the handler implementation also has to support 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 XDialogEventHandler */ com::sun::star::awt::XDialog createDialogWithHandler ( [in] string URL, [in] com::sun::star::uno::XInterface xHandler ) raises ( com::sun::star::lang::IllegalArgumentException ); /** 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 interface, 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.

*/ XDialog createDialogWithArguments ( [in] string URL, [in] sequence< ::com::sun::star::beans::NamedValue > Arguments ) raises ( com::sun::star::lang::IllegalArgumentException ); }; //============================================================================= }; }; }; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */