offapi/com/sun/star/awt/XContainerWindowProvider.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 module com { module sun { module star { module awt {
  22
  23
  24 /** provides container windows implementing the
  25     com::sun::star::awt::XWindow interface.
  26  */
  27 interface XContainerWindowProvider : ::com::sun::star::uno::XInterface {
  28
  29
  30     /** creates a window for the given URL
  31
  32         @param URL
  33             is the URL.
  34
  35         @param WindowType
  36             Type of Window to be created,
  37             for future use, not supported yet
  38
  39         @param xParent
  40             a valid XWindowPeer reference which is used as a parent.
  41             This parameter must not be null.
  42
  43         @param xHandler
  44             is the interface that will be called to handle the Events that
  45             are generated by the window (and all controls placed on it) and
  46             bound to the handler using a vnd.sun.star.UNO URL specifying a
  47             handler method to be called. Usually this will be done directly
  48             by the user.
  49
  50             xHandler can handle events in two different ways:
  51
  52             1. By supporting the com::sun::star::awt::XContainerWindowEventHandler
  53             interface. This is a generic interface to accept event notifications.
  54
  55             2. By providing interfaces that directly implement the handler
  56             methods to be called. The XContainerWindowProvider implementation then
  57             will try to access these events using the
  58             com::sun::star::beans::IntrospectionIntrospection
  59             service. To make this possible the handler implementation also has to
  60             support com::sun::star::lang::XTypeProvider.
  61
  62             If XContainerWindowEventHandler is supported XContainerWindowEventHandler.callHandlerMethod()
  63             is always called first to handle the event. Only if the event cannot be
  64             handled by XContainerWindowEventHandler (callHandlerMethod() then has to return
  65             false) or if XContainerWindowEventHandler is not supported at all the Introspection
  66             based access will be used.
  67
  68             The Introspection based access tries to call a method named according to the
  69             HandlerMethodName specified by a
  70             <code>vnd.sun.star.UNO:<i>HandlerMethodName</i></code> URL.
  71             First a method
  72
  73             void HandlerMethodName( [in] com::sun::star::awt::XWindow xWindow, [in] any aEvent )
  74
  75             will be searched. The signature is similar to XContainerWindowEventHandler.
  76             callHandlerMethod except for MethodName itself that isn't needed
  77             here. For more information about these parameters, see
  78             com::sun::star::awt::XContainerWindowEventHandler.
  79
  80             If this method is found, it will be called, otherwise a method
  81
  82             void HandlerMethodName( void )
  83
  84             will be searched and called.
  85
  86         @returns
  87             a window implementing the com::sun::star::awt::XWindow interface.
  88
  89         @throws com::sun::star::lang::IllegalArgumentException
  90             if no window for the given URL is found or if the URL is invalid
  91             or xParent is null.
  92
  93         @see com::sun::star::awt::XContainerWindowEventHandler
  94
  95      */
  96     com::sun::star::awt::XWindow createContainerWindow
  97         ( [in] string URL, [in] string WindowType,
  98           [in] com::sun::star::awt::XWindowPeer xParent,
  99           [in] com::sun::star::uno::XInterface xHandler )
 100             raises ( com::sun::star::lang::IllegalArgumentException );
 101 };
 102
 103
 104 }; }; }; };
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */