offapi/com/sun/star/frame/XTransientDocumentsDocumentContentFactory.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTransientDocumentsDocumentContentFactory.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XTransientDocumentsDocumentContentFactory_idl__
  31 #define __com_sun_star_frame_XTransientDocumentsDocumentContentFactory_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContent_idl__
  38 #include <com/sun/star/ucb/XContent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_frame_XModel_idl__
  42 #include <com/sun/star/frame/XModel.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  46 #include <com/sun/star/lang/IllegalArgumentException.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module frame {
  52
  53 //=============================================================================
  54 /** specifies a factory for
  55     <type scope="com::sun::star::ucb">TransientDocumentsDocumentContent</type>s.
  56
  57      @version  1.0
  58      @author   Kai Sommerfeld
  59      @see      com::sun::star::document::OfficeDocument
  60      @see      com::sun::star::ucb::TransientDocumentsDocumentContent
  61
  62      @since OOo 2.0.0
  63 */
  64 interface XTransientDocumentsDocumentContentFactory : com::sun::star::uno::XInterface
  65 {
  66     //-------------------------------------------------------------------------
  67     /** creates a
  68         <type scope="com::sun::star::ucb">TransientDocumentsDocumentContent</type>
  69         based on a given <type scope="com::sun::star::document">OfficeDocument</type>.
  70
  71         @param Model
  72         the document model for that a
  73         <type scope="com::sun::star::ucb">TransientDocumentsDocumentContent</type>
  74         is requested. The model must be an implementation of service
  75         <type scope="com::sun::star::document">OfficeDocument</type>.
  76
  77         @returns
  78         a document content based on the given document model. The content must
  79         be an implementation of service
  80         <type scope="com::sun::star::ucb">TransientDocumentsDocumentContent</type>.
  81
  82         @throws com::sun::star::lang::IllegalArgumentException
  83         if the document model cannot be associated with content for any reason.
  84     */
  85     com::sun::star::ucb::XContent createDocumentContent(
  86             [in] com::sun::star::frame::XModel Model )
  87         raises ( com::sun::star::lang::IllegalArgumentException );
  88
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; };
  94
  95 #endif