xref: /aoo41x/main/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_XSynchronousFrameLoader_idl__
#define __com_sun_star_frame_XSynchronousFrameLoader_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_frame_XFrame_idl__
#include <com/sun/star/frame/XFrame.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** loads a resource into a <type>Frame</type>.

	<p>
	Unlike the <type>XFrameLoader</type> interface, this loading will be synchronous.
 	</p>

    @see XFrameLoader
 */
published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** starts the loading of the specified resource into the specified <type>Frame</type>.

        @param Descriptor
            describes the ressource which should be loaded
            It use a <type scope="com::sun::star::document">MediaDescriptor</type> for that.

        @param Frame
            the target frame which should contain the new loaded component

        @return
            <TRUE/> if loading is successfully
            <br>
            <FALSE/> otherwise
	 */
    boolean load(
        [in] sequence< com::sun::star::beans::PropertyValue > Descriptor,
        [in] XFrame Frame );

	//-------------------------------------------------------------------------
	/** cancels the loading process.

        <p>
        No notifications (neither to the frame or the caller) must be notified.
        Because it's a synchronous process this cancel call can be forced by
        another thread the loader thread only. Method
        <member>XSynchronousFrameLoader::load()</member> must return <FALSE/>
        then and caller of this method <member>XSynchronousFrameLoader::cancel()</member>
        already knows the state ...
        </p>
	 */
	void cancel();
};

//=============================================================================

}; }; }; };

#endif