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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XContainerWindowProvider.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_awt_XContainerWindowProvider_idl__
  32 #define __com_sun_star_awt_XContainerWindowProvider_idl__
  33
  34 #ifndef __com_sun_star_awt_XWindow_idl__
  35 #include <com/sun/star/awt/XWindow.idl>
  36 #endif
  37 #ifndef __com_sun_star_awt_XWindowPeer_idl__
  38 #include <com/sun/star/awt/XWindowPeer.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  41 #include <com/sun/star/lang/IllegalArgumentException.idl>
  42 #endif
  43
  44 //=============================================================================
  45
  46 module com { module sun { module star { module awt {
  47
  48 //=============================================================================
  49
  50 /** provides container windows implementing the
  51     <type scope="com::sun::star::awt">XWindow</type> interface.
  52  */
  53 interface XContainerWindowProvider : ::com::sun::star::uno::XInterface {
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** creates a window for the given URL
  58
  59         @param URL
  60             is the URL.
  61
  62         @param WindowType
  63             Type of Window to be created,
  64             for future use, not supported yet
  65
  66         @param xParent
  67             a valid XWindowPeer reference which is used as a parent.
  68             This parameter must not be null.
  69
  70         @param xHandler
  71             is the interface that will be called to handle the Events that
  72             are generated by the window (and all controls placed on it) and
  73             bound to the handler using a vnd.sun.star.UNO URL specifying a
  74             handler method to be called. Usually this will be done directly
  75             by the user.
  76
  77             xHandler can handle events in two different ways:
  78
  79             1. By supporting the <type scope="com::sun::star::awt">XContainerWindowEventHandler</type>
  80             interface. This is a generic interface to accept event notifications.
  81
  82             2. By providing interfaces that directly implement the handler
  83             methods to be called. The XContainerWindowProvider implementation then
  84             will try to access these events using the
  85             <type scope="com::sun::star::beans">Introspection</type>Introspection
  86             service. To make this possible the handler implementation also has to
  87             support <type scope="com::sun::star::lang">XTypeProvider</type>.
  88
  89             If XContainerWindowEventHandler is supported XContainerWindowEventHandler.callHandlerMethod()
  90             is always called first to handle the event. Only if the event cannot be
  91             handled by XContainerWindowEventHandler (callHandlerMethod() then has to return
  92             false) or if XContainerWindowEventHandler is not supported at all the Introspection
  93             based access will be used.
  94
  95             The Introspection based access tries to call a method named according to the
  96             HandlerMethodName specified by a vnd.sun.star.UNO:<HandlerMethodName> URL.
  97             First a method
  98
  99             void HandlerMethodName( [in] com::sun::star::awt::XWindow xWindow, [in] any aEvent )
 100
 101             will be searched. The signature is similar to XContainerWindowEventHandler.
 102             callHandlerMethod except for MethodName itself that isn't needed
 103             here. For more information about these parameters, see
 104             <type scope="com::sun::star::awt">XContainerWindowEventHandler</type>.
 105
 106             If this method is found, it will be called, otherwise a method
 107
 108             void HandlerMethodName( void )
 109
 110             will be searched and called.
 111
 112         @returns
 113             a window implementing the <type scope="com::sun::star::awt">XWindow</type> interface.
 114
 115         @throws com::sun::star::lang::IllegalArgumentException
 116             if no window for the given URL is found or if the URL is invalid
 117             or xParent is null.
 118
 119         @see <type scope="com::sun::star::awt">XContainerWindowEventHandler</type>
 120
 121      */
 122     com::sun::star::awt::XWindow createContainerWindow
 123         ( [in] string URL, [in] string WindowType,
 124           [in] com::sun::star::awt::XWindowPeer xParent,
 125           [in] com::sun::star::uno::XInterface xHandler )
 126             raises ( com::sun::star::lang::IllegalArgumentException );
 127 };
 128
 129 //=============================================================================
 130
 131 }; }; }; };
 132
 133 #endif