offapi/com/sun/star/frame/XTransientDocumentsDocumentContentIdentifierFactory.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  */
  10
  11
  12 module com { module sun { module star { module frame {
  13
  14 /** a factory for identifiers of
  15     com::sun::star::ucb::TransientDocumentsDocumentContents.
  16
  17     @see com::sun::star::document::OfficeDocument
  18     @see com::sun::star::ucb::XContentIdentifier
  19
  20     @since LibreOffice 6.3
  21 */
  22 interface XTransientDocumentsDocumentContentIdentifierFactory
  23     : com::sun::star::uno::XInterface
  24 {
  25     /** creates a com::sun::star::ucb::XContentIdentifier
  26         based on a given com::sun::star::document::OfficeDocument.
  27
  28         @param Model
  29             the document model for which a
  30             com::sun::star::ucb::XContentIdentifier
  31             is requested. The model must be an implementation of service
  32             com::sun::star::document::OfficeDocument.
  33
  34         @returns
  35             a content identifier based on the given document model.
  36
  37         @throws com::sun::star::lang::IllegalArgumentException
  38             if the document model cannot be associated with content for any reason.
  39     */
  40     com::sun::star::ucb::XContentIdentifier
  41     createDocumentContentIdentifier(
  42             [in] com::sun::star::frame::XModel Model )
  43         raises ( com::sun::star::lang::IllegalArgumentException );
  44
  45 };
  46
  47
  48 }; }; }; };
  49
  50 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */