offapi/com/sun/star/awt/XDialogProvider2.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com { module sun { module star { module awt {
  23
  24
  25 /** provides dialogs implementing the
  26     com::sun::star::awt::XDialog interface.
  27  */
  28 interface XDialogProvider2 : ::com::sun::star::awt::XDialogProvider {
  29
  30
  31     /** creates a dialog for the given URL accepting an Interface used
  32         to handle dialog events.
  33
  34         @param URL
  35             is the URL.
  36
  37         @param xHandler
  38             is the interface that will be called to handle the Events that
  39             are generated by the dialog (and all controls placed on it) and
  40             bound to the handler using a vnd.sun.star.UNO URL specifying a
  41             handler method to be called. Usually this will be done directly
  42             by the user.
  43
  44             xHandler can handle events in two different ways:
  45
  46             1. By supporting the com::sun::star::awt::XDialogEventHandler interface.
  47             This is a generic interface to accept event notifications.
  48
  49             2. By providing interfaces that directly implement the handler
  50             methods to be called. The XDialogProvider2 implementation then
  51             will try to access these events using the
  52             com::sun::star::beans::IntrospectionIntrospection
  53             service. To make this possible the handler implementation also has to
  54             support com::sun::star::lang::XTypeProvider.
  55
  56             If XDialogEventHandler is supported XDialogEventHandler.callHandlerMethod()
  57             is always called first to handle the event. Only if the event cannot be
  58             handled by XDialogEventHandler (callHandlerMethod() then has to return
  59             false) or if XDialogEventHandler is not supported at all the Introspection
  60             based access will be used.
  61
  62             The Introspection based access tries to call a method named according to the
  63             HandlerMethodName specified by a
  64             <code>vnd.sun.star.UNO:<i>HandlerMethodName</i></code> URL.
  65             First a method
  66
  67             void HandlerMethodName( [in] com::sun::star::awt::XDialog xDialog, [in] any aEvent )
  68
  69             will be searched. The signature is similar to XDialogEventHandler.
  70             callHandlerMethod except for MethodName itself that isn't needed
  71             here. For more information about these parameters, see
  72             com::sun::star::awt::XDialogEventHandler.
  73
  74             If this method is found, it will be called, otherwise a method
  75
  76             void HandlerMethodName( void )
  77
  78             will be searched and called.
  79
  80         @returns
  81             a dialog implementing the com::sun::star::awt::XDialog interface.
  82
  83         @throws com::sun::star::lang::IllegalArgumentException
  84             if no dialog for the given URL is found or if the URL is invalid
  85             or xHandler is null.
  86
  87         @see com::sun::star::awt::XDialogEventHandler
  88
  89      */
  90     com::sun::star::awt::XDialog createDialogWithHandler
  91         ( [in] string URL, [in] com::sun::star::uno::XInterface xHandler )
  92             raises ( com::sun::star::lang::IllegalArgumentException );
  93
  94     /** creates a dialog for the given URL, accepting additional creation parameters
  95
  96         <p>The arguments accepted so far are
  97         <ul><li><em>ParentWindow</em> - must be a component supporting the XWindowPeer interface,
  98                 or a component supporting the XControl interface, so an <code>XWindowPeer</code> can be
  99                 obtained from it. The given window will be used as parent window for the to-be-created dialog.</li>
 100             <li><em>EventHandler</em> - specifies a component handling events in the dialog. See
 101                 createDialogWithHandler() for a detailed specification of dialog event handling.</li>
 102         </ul>
 103         </p>
 104     */
 105
 106     XDialog createDialogWithArguments
 107         ( [in] string URL,
 108           [in] sequence< ::com::sun::star::beans::NamedValue > Arguments )
 109         raises  (   com::sun::star::lang::IllegalArgumentException );
 110 };
 111
 112
 113 }; }; }; };
 114
 115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */