diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/awt/XDialogProvider2.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-cb75148ebd0135178ff46f89a30139c44f8d2040.tar.xz libreoffice-cb75148ebd0135178ff46f89a30139c44f8d2040.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/awt/XDialogProvider2.idl')
-rw-r--r-- | offapi/com/sun/star/awt/XDialogProvider2.idl | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/XDialogProvider2.idl b/offapi/com/sun/star/awt/XDialogProvider2.idl new file mode 100644 index 000000000..7365e1196 --- /dev/null +++ b/offapi/com/sun/star/awt/XDialogProvider2.idl @@ -0,0 +1,123 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_awt_XDialogProvider2_idl__ +#define __com_sun_star_awt_XDialogProvider2_idl__ + +#include <com/sun/star/awt/XDialogProvider.idl> +#include <com/sun/star/beans/NamedValue.idl> + + + +module com { module sun { module star { module awt { + + +/** provides dialogs implementing the + com::sun::star::awt::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 com::sun::star::awt::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 + <code>vnd.sun.star.UNO:<i>HandlerMethodName</i></code> 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 + com::sun::star::awt::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 com::sun::star::awt::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 com::sun::star::awt::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 + + <p>The arguments accepted so far are + <ul><li><em>ParentWindow</em> - must be a component supporting the XWindowPeer interface, + or a component supporting the XControl interface, so an <code>XWindowPeer</code> can be + obtained from it. The given window will be used as parent window for the to-be-created dialog.</li> + <li><em>EventHandler</em> - specifies a component handling events in the dialog. See + createDialogWithHandler() for a detailed specification of dialog event handling.</li> + </ul> + </p> + */ + + 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: */ |