xref: /trunk/main/offapi/com/sun/star/frame/XTransientDocumentsDocumentContentFactory.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_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