offapi/com/sun/star/script/XPersistentLibraryContainer.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_XPersistentLibraryContainer_idl__
  30 #define __com_sun_star_script_XPersistentLibraryContainer_idl__
  31
  32 #include <com/sun/star/util/XModifiable.idl>
  33 #include <com/sun/star/script/XLibraryContainer2.idl>
  34 #include <com/sun/star/lang/WrappedTargetException.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module script {
  39
  40 //=============================================================================
  41
  42 /** describes a container of script libraries which is persistent.
  43
  44     <p>The type of persistence of the container elements is not defined here,
  45     but in derived interfaces or services using
  46     <code>XPersistentLibraryContainer</code>.</p>
  47
  48     <p>The actual libraries are stored in some object - a sub folder, or a sub storage,
  49     for example - below the root location.</p>
  50
  51     @since OOo 2.3
  52  */
  53 interface XPersistentLibraryContainer
  54 {
  55     interface ::com::sun::star::util::XModifiable;
  56     interface XLibraryContainer2;
  57
  58     /** denotes the root location associated with the container.
  59
  60         <p>The type of this location - it might be a folder in a file system,
  61         a storage, or anything else - is not specified here, but in derived interfaces
  62         or services implementing <code>XPersistentLibraryContainer</code>.</p>
  63
  64         <p>All operations of the library container take place in a location below
  65         the root location, the so-called container location, whose
  66         name is exposed as <member>ContainerLocationName</member>.</p>
  67
  68         @see ContainerLocationName
  69     */
  70     [attribute, readonly] any   RootLocation;
  71
  72     /** denotes the name of the sub location where the container elements are
  73         actually stored.
  74
  75         @see RootLocation
  76     */
  77     [attribute, readonly] string ContainerLocationName;
  78
  79     /** stores the libraries to the current location.
  80
  81         @throws ::com::sun::star::lang::WrappedTargetException
  82             if an error occurs during storing.
  83
  84         @see RootLocation
  85         @see ContainerLocationName
  86     */
  87     void    storeLibraries()
  88         raises ( ::com::sun::star::lang::WrappedTargetException );
  89
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 //=============================================================================
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */