offapi/com/sun/star/script/XLibraryContainer.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 #ifndef __com_sun_star_script_XLibraryContainer_idl__
  20 #define __com_sun_star_script_XLibraryContainer_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/container/XNameContainer.idl>
  25
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27
  28 #include <com/sun/star/container/NoSuchElementException.idl>
  29
  30 #include <com/sun/star/container/ElementExistException.idl>
  31
  32 #include <com/sun/star/lang/WrappedTargetException.idl>
  33
  34
  35
  36 module com {  module sun {  module star {  module script {
  37
  38
  39 /**
  40     Provides access to a library system.
  41  */
  42 published interface XLibraryContainer: com::sun::star::container::XNameAccess
  43 {
  44     /**
  45         Creates a new library
  46      */
  47     com::sun::star::container::XNameContainer createLibrary( [in] string Name )
  48         raises( com::sun::star::lang::IllegalArgumentException,
  49                 com::sun::star::container::ElementExistException );
  50
  51     /**
  52         Creates a link to an "external" library that then can be
  53         accessed using this library manager. The format of the
  54         StorageURL is a matter of the implementation. If the read
  55         only flag is set, the linked library cannot be modified.
  56         In this case, the returned interface really is only an
  57         XNameAccess. If ReadOnly is false (and the referenced
  58         storage allows write access) the returned interface also
  59         can be a com::sun::star::container::XNameContainer.
  60      */
  61     com::sun::star::container::XNameAccess createLibraryLink( [in] string Name, [in] string StorageURL, [in] boolean ReadOnly )
  62         raises( com::sun::star::lang::IllegalArgumentException,
  63                 com::sun::star::container::ElementExistException );
  64
  65     /** removes the library item with the specified name. If the accessed
  66         library item is a link only the link is removed, not the target library.
  67      */
  68     void removeLibrary( [in] string Name )
  69             raises( com::sun::star::container::NoSuchElementException,
  70                     com::sun::star::lang::WrappedTargetException );
  71
  72     /**
  73         returns true if the accessed library is already loaded from
  74         the storage, otherwise false.
  75      */
  76     boolean isLibraryLoaded( [in] string Name )
  77             raises( com::sun::star::container::NoSuchElementException );
  78
  79     /**
  80         Causes the accessed library to be loaded from its storage
  81         if it hasn't already been loaded.
  82      */
  83     void loadLibrary( [in] string Name )
  84             raises( com::sun::star::container::NoSuchElementException,
  85                     com::sun::star::lang::WrappedTargetException );
  86
  87 };
  88
  89
  90
  91 }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */