INTEGRATION: CWS jl61 (1.1.2); FILE ADDED

2007/06/13 08:21:18 ab 1.1.2.1: #i76438# (X)ContainerWindowProvider, XContainerWindowEventHandler

1 files changed, 138 insertions, 0 deletions

diff --git a/offapi/com/sun/star/awt/XContainerWindowProvider.idl b/offapi/com/sun/star/awt/XContainerWindowProvider.idl
new file mode 100644
index 000000000000..87b068c0d67f
--- /dev/null
+++ b/offapi/com/sun/star/awt/XContainerWindowProvider.idl
@@ -0,0 +1,138 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XContainerWindowProvider.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2007-06-20 10:31:53 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library 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 for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_awt_XContainerWindowProvider_idl__
+#define __com_sun_star_awt_XContainerWindowProvider_idl__
+
+#ifndef __com_sun_star_awt_XWindow_idl__
+#include <com/sun/star/awt/XWindow.idl>
+#endif
+#ifndef __com_sun_star_awt_XWindowPeer_idl__
+#include <com/sun/star/awt/XWindowPeer.idl>
+#endif
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module awt {
+
+//=============================================================================
+
+/** provides container windows implementing the
+    <type scope="com::sun::star::awt">XWindow</type> interface.
+ */
+interface XContainerWindowProvider : ::com::sun::star::uno::XInterface {
+
+    //-------------------------------------------------------------------------
+
+    /** creates a window for the given URL
+
+        @param URL
+            is the URL.
+
+        @param WindowType
+            Type of Window to be created,
+            for future use, not supported yet
+
+        @param xParent
+            a valid XWindowPeer reference which is used as a parent.
+            This parameter must not be null.
+
+        @param xHandler
+            is the interface that will be called to handle the Events that
+            are generated by the window (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 <type scope="com::sun::star::awt">XContainerWindowEventHandler</type>
+            interface. This is a generic interface to accept event notifications.
+
+            2. By providing interfaces that directly implement the handler
+            methods to be called. The XContainerWindowProvider implementation then
+            will try to access these events using the
+            <type scope="com::sun::star::beans">Introspection</type>Introspection
+            service. To make this possible the handler implementation also has to
+            support <type scope="com::sun::star::lang">XTypeProvider</type>.
+
+            If XContainerWindowEventHandler is supported XContainerWindowEventHandler.callHandlerMethod()
+            is always called first to handle the event. Only if the event cannot be
+            handled by XContainerWindowEventHandler (callHandlerMethod() then has to return
+            false) or if XContainerWindowEventHandler 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:<HandlerMethodName> URL.
+            First a method
+
+            void HandlerMethodName( [in] com::sun::star::awt::XWindow xWindow, [in] any aEvent )
+
+            will be searched. The signature is similar to XContainerWindowEventHandler.
+            callHandlerMethod except for MethodName itself that isn't needed
+            here. For more information about these parameters, see
+            <type scope="com::sun::star::awt">XContainerWindowEventHandler</type>.
+
+            If this method is found, it will be called, otherwise a method
+
+            void HandlerMethodName( void )
+
+            will be searched and called.
+
+        @returns
+            a window implementing the <type scope="com::sun::star::awt">XWindow</type> interface.
+
+        @throws com::sun::star::lang::IllegalArgumentException
+            if no window for the given URL is found or if the URL is invalid
+            or xParent is null.
+
+        @see <type scope="com::sun::star::awt">XContainerWindowEventHandler</type>
+
+     */
+    com::sun::star::awt::XWindow createContainerWindow
+        ( [in] string URL, [in] string WindowType,
+          [in] com::sun::star::awt::XWindowPeer xParent,
+          [in] com::sun::star::uno::XInterface xHandler )
+            raises ( com::sun::star::lang::IllegalArgumentException );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif