offapi/com/sun/star/script/DocumentScriptLibraryContainer.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
  22 module com { module sun { module star { module script {
  23
  24
  25 /** defines a container of StarBasic script libraries, which is to be made
  26     persistent in a sub storage of a document storage.
  27
  28     @since OOo 2.3
  29  */
  30 service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer
  31 {
  32     /** creates an instance of the <code>DocumentScriptLibraryContainer</code>, belonging to a document
  33
  34         <p>The current storage of the document will be set as initial root storage
  35         (see XPersistentLibraryContainer::RootStorage) of the container.</p>
  36
  37         <p>Usually, you will only create a <code>DocumentScriptLibraryContainer</code> within
  38         the implementation of the document to which the container should belong.</p>
  39
  40         @param Document
  41             The document to which the container should belong to. Must not be
  42             `NULL`.
  43
  44         @throws ::com::sun::star::lang::IllegalArgumentException
  45             if <code>Document</code> does not denote a valid
  46             com::sun::star::document::OfficeDocument.
  47     */
  48     create( [in] ::com::sun::star::document::XStorageBasedDocument Document )
  49         raises( ::com::sun::star::lang::IllegalArgumentException );
  50
  51     createWithURL( [in] string URL );
  52 };
  53
  54
  55 }; }; }; };
  56
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */