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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_script_XPersistentLibraryContainer_idl__
  21 #define __com_sun_star_script_XPersistentLibraryContainer_idl__
  22
  23 #include <com/sun/star/util/XModifiable.idl>
  24 #include <com/sun/star/script/XLibraryContainer2.idl>
  25 #include <com/sun/star/lang/WrappedTargetException.idl>
  26
  27
  28 module com { module sun { module star { module script {
  29
  30
  31 /** describes a container of script libraries which is persistent.
  32
  33     <p>The type of persistence of the container elements is not defined here,
  34     but in derived interfaces or services using
  35     <code>XPersistentLibraryContainer</code>.</p>
  36
  37     <p>The actual libraries are stored in some object - a sub folder, or a sub storage,
  38     for example - below the root location.</p>
  39
  40     @since OOo 2.3
  41  */
  42 interface XPersistentLibraryContainer
  43 {
  44     interface ::com::sun::star::util::XModifiable;
  45     interface XLibraryContainer2;
  46
  47     /** denotes the root location associated with the container.
  48
  49         <p>The type of this location - it might be a folder in a file system,
  50         a storage, or anything else - is not specified here, but in derived interfaces
  51         or services implementing <code>XPersistentLibraryContainer</code>.</p>
  52
  53         <p>All operations of the library container take place in a location below
  54         the root location, the so-called container location, whose
  55         name is exposed as #ContainerLocationName.</p>
  56
  57         @see ContainerLocationName
  58     */
  59     [attribute, readonly] any   RootLocation;
  60
  61     /** denotes the name of the sub location where the container elements are
  62         actually stored.
  63
  64         @see RootLocation
  65     */
  66     [attribute, readonly] string ContainerLocationName;
  67
  68     /** stores the libraries to the current location.
  69
  70         @throws ::com::sun::star::lang::WrappedTargetException
  71             if an error occurs during storing.
  72
  73         @see RootLocation
  74         @see ContainerLocationName
  75     */
  76     void    storeLibraries()
  77         raises ( ::com::sun::star::lang::WrappedTargetException );
  78
  79 };
  80
  81
  82 }; }; }; };
  83
  84
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */