1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_frame_XSynchronousFrameLoader_idl__ 24cdf0e10cSrcweir#define __com_sun_star_frame_XSynchronousFrameLoader_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_frame_XFrame_idl__ 31cdf0e10cSrcweir#include <com/sun/star/frame/XFrame.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__ 35cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir 40cdf0e10cSrcweir module com { module sun { module star { module frame { 41cdf0e10cSrcweir 42cdf0e10cSrcweir//============================================================================= 43cdf0e10cSrcweir/** loads a resource into a <type>Frame</type>. 44cdf0e10cSrcweir 45cdf0e10cSrcweir <p> 46cdf0e10cSrcweir Unlike the <type>XFrameLoader</type> interface, this loading will be synchronous. 47cdf0e10cSrcweir </p> 48cdf0e10cSrcweir 49cdf0e10cSrcweir @see XFrameLoader 50cdf0e10cSrcweir */ 51cdf0e10cSrcweirpublished interface XSynchronousFrameLoader: com::sun::star::uno::XInterface 52cdf0e10cSrcweir{ 53cdf0e10cSrcweir //------------------------------------------------------------------------- 54cdf0e10cSrcweir /** starts the loading of the specified resource into the specified <type>Frame</type>. 55cdf0e10cSrcweir 56cdf0e10cSrcweir @param Descriptor 57cdf0e10cSrcweir describes the ressource which should be loaded 58cdf0e10cSrcweir It use a <type scope="com::sun::star::document">MediaDescriptor</type> for that. 59cdf0e10cSrcweir 60cdf0e10cSrcweir @param Frame 61cdf0e10cSrcweir the target frame which should contain the new loaded component 62cdf0e10cSrcweir 63cdf0e10cSrcweir @return 64cdf0e10cSrcweir <TRUE/> if loading is successfully 65cdf0e10cSrcweir <br> 66cdf0e10cSrcweir <FALSE/> otherwise 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir boolean load( 69cdf0e10cSrcweir [in] sequence< com::sun::star::beans::PropertyValue > Descriptor, 70cdf0e10cSrcweir [in] XFrame Frame ); 71cdf0e10cSrcweir 72cdf0e10cSrcweir //------------------------------------------------------------------------- 73cdf0e10cSrcweir /** cancels the loading process. 74cdf0e10cSrcweir 75cdf0e10cSrcweir <p> 76cdf0e10cSrcweir No notifications (neither to the frame or the caller) must be notified. 77cdf0e10cSrcweir Because it's a synchronous process this cancel call can be forced by 78cdf0e10cSrcweir another thread the loader thread only. Method 79cdf0e10cSrcweir <member>XSynchronousFrameLoader::load()</member> must return <FALSE/> 80cdf0e10cSrcweir then and caller of this method <member>XSynchronousFrameLoader::cancel()</member> 81cdf0e10cSrcweir already knows the state ... 82cdf0e10cSrcweir </p> 83cdf0e10cSrcweir */ 84cdf0e10cSrcweir void cancel(); 85cdf0e10cSrcweir}; 86cdf0e10cSrcweir 87cdf0e10cSrcweir//============================================================================= 88cdf0e10cSrcweir 89cdf0e10cSrcweir}; }; }; }; 90cdf0e10cSrcweir 91cdf0e10cSrcweir#endif 92