offapi/com/sun/star/script/XLibraryContainer2.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
  21
  22  module com {  module sun {  module star {  module script {
  23
  24
  25 /**
  26     Extension of XLibraryContainer to provide additional information
  27     about the libraries contained in a library container
  28  */
  29 published interface XLibraryContainer2: com::sun::star::script::XLibraryContainer
  30 {
  31     /**
  32         returns true if the accessed library item is a link,
  33         e.g., created by createLibraryLink, otherwise false.
  34      */
  35     boolean isLibraryLink( [in] string Name )
  36             raises( com::sun::star::container::NoSuchElementException );
  37
  38     /**
  39         returns the location of the library link target.
  40         Should return the same URL that was passed to
  41         createLibraryLink in the StorageURL parameter.
  42
  43         If the accessed library item exists but isn't a
  44         link, an IllegalArgumentException is thrown
  45      */
  46     string getLibraryLinkURL( [in] string Name )
  47             raises( com::sun::star::lang::IllegalArgumentException,
  48                     com::sun::star::container::NoSuchElementException );
  49
  50     /**
  51         returns true if the accessed library item (library or library
  52         link) is read only. A library can be read only because it was
  53         set to read only using the methods provided by this interface
  54         or because of other reasons depending on the implementation
  55         (e.g., file system write protection)
  56      */
  57     boolean isLibraryReadOnly( [in] string Name )
  58             raises( com::sun::star::container::NoSuchElementException );
  59
  60     /**
  61         Sets the accessed library item (library or library link) to
  62         read only according to the flag bReadOnly (true means read only)
  63      */
  64     void setLibraryReadOnly( [in] string Name, [in] boolean bReadOnly )
  65             raises( com::sun::star::container::NoSuchElementException );
  66
  67     /** renames the library item with the specified name. If the accessed
  68         library item is a link only the link is renamed, not the target library.
  69         If a library with the new name exists already a
  70         com::sun::star::container::ElementExistException is thrown.
  71      */
  72     void renameLibrary( [in] string Name, [in] string NewName )
  73             raises( com::sun::star::container::NoSuchElementException,
  74                     com::sun::star::container::ElementExistException );
  75
  76 };
  77
  78
  79
  80 }; }; }; };
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */