offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DocumentScriptLibraryContainer.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_script_DocumentScriptLibraryContainer_idl__
  32 #define __com_sun_star_script_DocumentScriptLibraryContainer_idl__
  33
  34 #ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__
  35 #include <com/sun/star/script/XStorageBasedLibraryContainer.idl>
  36 #endif
  37 #ifndef __com_sun_star_embed_XStorageBasedDocument_idl__
  38 #include <com/sun/star/document/XStorageBasedDocument.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  41 #include <com/sun/star/lang/IllegalArgumentException.idl>
  42 #endif
  43
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module script {
  48
  49 //=============================================================================
  50
  51 /** defines a container of StarBasic script libraries, which is to be made
  52     persistent in a sub storage of a document storage.
  53
  54     @since OOo 2.3
  55  */
  56 service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer
  57 {
  58     /** creates an instance of the <code>DocumentScriptLibraryContainer</code>, belonging to a document
  59
  60         <p>The current storage of the document will be set as initial root storage
  61         (see <member>XPersistentLibraryContainer::RootStorage</member>) of the container.</p>
  62
  63         <p>Usually, you will only create a <code>DocumentScriptLibraryContainer</code> within
  64         the implementation of the document to which the container should belong.</p>
  65
  66         @param Document
  67             The document to which the container should belong to. Must not be
  68             <NULL/>.
  69
  70         @throws ::com::sun::star::lang::IllegalArgumentException
  71             if <code>Document</code> does not denote a valid
  72             <type scope="com::sun::star::document">OfficeDocument</type>.
  73     */
  74     create( [in] ::com::sun::star::document::XStorageBasedDocument Document )
  75         raises( ::com::sun::star::lang::IllegalArgumentException );
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 //=============================================================================
  84
  85 #endif
  86