offapi/com/sun/star/script/XStorageBasedLibraryContainer.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
  30 #ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__
  31 #define __com_sun_star_script_XStorageBasedLibraryContainer_idl__
  32
  33 #include <com/sun/star/embed/XStorage.idl>
  34 #include <com/sun/star/script/XPersistentLibraryContainer.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module script {
  39
  40 //=============================================================================
  41
  42 /** is the interface for an <type>XLibraryContainer</type> which can be made
  43     persistent in an <type scope="com::sun::star::embed">XStorage</type>.
  44
  45     <p>A persistent library container is associated with a root storage. The
  46     container is responsible for a particular sub storage of the root storage,
  47     the container storage.</p>
  48
  49     @since OOo 2.3
  50  */
  51 interface XStorageBasedLibraryContainer
  52 {
  53     interface XPersistentLibraryContainer;
  54
  55     /** denotes the root storage associated with the container.
  56
  57         <p>Effectively, this attribute is a typed version of
  58         <member>XPersistentLibraryContainer::RootLocation</member>, it's guaranteed
  59         that at every time, <code>XPersistentLibraryContainer::RootLocation</code> and
  60         <code>RootStorage</code> have the same value.</p>
  61
  62         <p>You should only <em>set</em> this attribute to a new value if you previously
  63         called storeLibrariesToStorage with the same storage. Setting this attribute
  64         to a storage into which the container has not been stored previously might
  65         result in unexpected behavior.</p>
  66     */
  67     [attribute] ::com::sun::star::embed::XStorage RootStorage
  68     {
  69         set raises ( ::com::sun::star::lang::IllegalArgumentException );
  70     };
  71
  72     /** stores the libraries to a storage other than the current container storage
  73
  74         <p>Note that the library container is not automatically associated with the
  75         new root storage. Instead, you need to manually set the <type>RootStroage</type>
  76         attribute afterwards. This separation allows for Save-To as well Save-As
  77         operations.</p>
  78
  79         @param RootStorage
  80             denotes the root storage into which the libraries should be written, which
  81             must not be <NULL/>.<br/>
  82             Note that the actual libraries are written into a sub storage of this
  83             root storage, as usual.
  84
  85         @throws ::com::sun::star::lang::IllegalArgumentException
  86             if the <code>RootStorage</code> parameter is <NULL/>, or equals
  87             <member>RootStorage</member>.
  88
  89         @throws ::com::sun::star::lang::WrappedTargetException
  90             if an error occurs during storing.
  91     */
  92     void    storeLibrariesToStorage( [in] ::com::sun::star::embed::XStorage RootStorage )
  93         raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException );
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 //=============================================================================
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */