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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_frame_XTransientDocumentsDocumentContentFactory_idl__
  20 #define __com_sun_star_frame_XTransientDocumentsDocumentContentFactory_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/XContent.idl>
  24 #include <com/sun/star/frame/XModel.idl>
  25 #include <com/sun/star/lang/IllegalArgumentException.idl>
  26
  27
  28 module com { module sun { module star { module frame {
  29
  30 /** specifies a factory for
  31     com::sun::star::ucb::TransientDocumentsDocumentContents.
  32
  33      @version  1.0
  34      @author   Kai Sommerfeld
  35      @see      com::sun::star::document::OfficeDocument
  36      @see      com::sun::star::ucb::TransientDocumentsDocumentContent
  37
  38      @since OOo 2.0
  39 */
  40 interface XTransientDocumentsDocumentContentFactory : com::sun::star::uno::XInterface
  41 {
  42     /** creates a
  43         com::sun::star::ucb::TransientDocumentsDocumentContent
  44         based on a given com::sun::star::document::OfficeDocument.
  45
  46         @param Model
  47         the document model for that a
  48         com::sun::star::ucb::TransientDocumentsDocumentContent
  49         is requested. The model must be an implementation of service
  50         com::sun::star::document::OfficeDocument.
  51
  52         @returns
  53         a document content based on the given document model. The content must
  54         be an implementation of service
  55         com::sun::star::ucb::TransientDocumentsDocumentContent.
  56
  57         @throws com::sun::star::lang::IllegalArgumentException
  58         if the document model cannot be associated with content for any reason.
  59     */
  60     com::sun::star::ucb::XContent createDocumentContent(
  61             [in] com::sun::star::frame::XModel Model )
  62         raises ( com::sun::star::lang::IllegalArgumentException );
  63
  64 };
  65
  66
  67 }; }; }; };
  68
  69 #endif
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */