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

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