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