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
  20
  21 module com { module sun { module star { module frame {
  22
  23 /** specifies a factory for
  24     com::sun::star::ucb::TransientDocumentsDocumentContents.
  25
  26      @version  1.0
  27      @see      com::sun::star::document::OfficeDocument
  28      @see      com::sun::star::ucb::TransientDocumentsDocumentContent
  29
  30      @since OOo 2.0
  31 */
  32 interface XTransientDocumentsDocumentContentFactory : com::sun::star::uno::XInterface
  33 {
  34     /** creates a
  35         com::sun::star::ucb::TransientDocumentsDocumentContent
  36         based on a given com::sun::star::document::OfficeDocument.
  37
  38         @param Model
  39         the document model for that a
  40         com::sun::star::ucb::TransientDocumentsDocumentContent
  41         is requested. The model must be an implementation of service
  42         com::sun::star::document::OfficeDocument.
  43
  44         @returns
  45         a document content based on the given document model. The content must
  46         be an implementation of service
  47         com::sun::star::ucb::TransientDocumentsDocumentContent.
  48
  49         @throws com::sun::star::lang::IllegalArgumentException
  50         if the document model cannot be associated with content for any reason.
  51     */
  52     com::sun::star::ucb::XContent createDocumentContent(
  53             [in] com::sun::star::frame::XModel Model )
  54         raises ( com::sun::star::lang::IllegalArgumentException );
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */