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