xref: /aoo41x/main/offapi/com/sun/star/frame/XTransientDocumentsDocumentContentFactory.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_frame_XTransientDocumentsDocumentContentFactory_idl__
#define __com_sun_star_frame_XTransientDocumentsDocumentContentFactory_idl__

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

#ifndef __com_sun_star_ucb_XContent_idl__
#include <com/sun/star/ucb/XContent.idl>
#endif

#ifndef __com_sun_star_frame_XModel_idl__
#include <com/sun/star/frame/XModel.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

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

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

//=============================================================================
/** specifies a factory for
    <type scope="com::sun::star::ucb">TransientDocumentsDocumentContent</type>s.

     @version  1.0
     @author   Kai Sommerfeld
     @see      com::sun::star::document::OfficeDocument
     @see      com::sun::star::ucb::TransientDocumentsDocumentContent

     @since OOo 2.0
*/
interface XTransientDocumentsDocumentContentFactory : com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
    /** creates a
        <type scope="com::sun::star::ucb">TransientDocumentsDocumentContent</type>
        based on a given <type scope="com::sun::star::document">OfficeDocument</type>.

        @param Model
        the document model for that a
        <type scope="com::sun::star::ucb">TransientDocumentsDocumentContent</type>
        is requested. The model must be an implementation of service
        <type scope="com::sun::star::document">OfficeDocument</type>.

        @returns
        a document content based on the given document model. The content must
        be an implementation of service
        <type scope="com::sun::star::ucb">TransientDocumentsDocumentContent</type>.

        @throws com::sun::star::lang::IllegalArgumentException
        if the document model cannot be associated with content for any reason.
	*/
    com::sun::star::ucb::XContent createDocumentContent(
            [in] com::sun::star::frame::XModel Model )
        raises ( com::sun::star::lang::IllegalArgumentException );

};

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

}; }; }; };

#endif