xref: /aoo42x/main/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_script_DocumentScriptLibraryContainer_idl__
#define __com_sun_star_script_DocumentScriptLibraryContainer_idl__

#ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__
#include <com/sun/star/script/XStorageBasedLibraryContainer.idl>
#endif
#ifndef __com_sun_star_embed_XStorageBasedDocument_idl__
#include <com/sun/star/document/XStorageBasedDocument.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


//=============================================================================

module com { module sun { module star { module script {

//=============================================================================

/** defines a container of StarBasic script libraries, which is to be made
    persistent in a sub storage of a document storage.

    @since OOo 2.3
 */
service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer
{
    /** creates an instance of the <code>DocumentScriptLibraryContainer</code>, belonging to a document

        <p>The current storage of the document will be set as initial root storage
        (see <member>XPersistentLibraryContainer::RootStorage</member>) of the container.</p>

        <p>Usually, you will only create a <code>DocumentScriptLibraryContainer</code> within
        the implementation of the document to which the container should belong.</p>

        @param Document
            The document to which the container should belong to. Must not be
            <NULL/>.

        @throws ::com::sun::star::lang::IllegalArgumentException
            if <code>Document</code> does not denote a valid
            <type scope="com::sun::star::document">OfficeDocument</type>.
    */
    create( [in] ::com::sun::star::document::XStorageBasedDocument Document )
        raises( ::com::sun::star::lang::IllegalArgumentException );

};

//=============================================================================

}; }; }; };

//=============================================================================

#endif