LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XLibraryContainer2 Interface Referencepublished

Extension of XLibraryContainer to provide additional information about the libraries contained in a library container. More...

import"XLibraryContainer2.idl";

Inheritance diagram for XLibraryContainer2:
XLibraryContainer XNameAccess XElementAccess XInterface XLibraryContainer3 XPersistentLibraryContainer XStorageBasedLibraryContainer DocumentDialogLibraryContainer DocumentScriptLibraryContainer

Public Member Functions

boolean isLibraryLink ([in] string Name) raises ( com::sun::star::container::NoSuchElementException )
 returns true if the accessed library item is a link, e.g., created by createLibraryLink, otherwise false. More...
 
string getLibraryLinkURL ([in] string Name) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException )
 returns the location of the library link target. More...
 
boolean isLibraryReadOnly ([in] string Name) raises ( com::sun::star::container::NoSuchElementException )
 returns true if the accessed library item (library or library link) is read only. More...
 
void setLibraryReadOnly ([in] string Name, [in] boolean bReadOnly) raises ( com::sun::star::container::NoSuchElementException )
 Sets the accessed library item (library or library link) to read only according to the flag bReadOnly (true means read only) More...
 
void renameLibrary ([in] string Name, [in] string NewName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException )
 renames the library item with the specified name. More...
 
- Public Member Functions inherited from XLibraryContainer
com::sun::star::container::XNameContainer createLibrary ([in] string Name) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException )
 Creates a new library. More...
 
com::sun::star::container::XNameAccess createLibraryLink ([in] string Name, [in] string StorageURL, [in] boolean ReadOnly) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException )
 Creates a link to an "external" library that then can be accessed using this library manager. More...
 
void removeLibrary ([in] string Name) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 removes the library item with the specified name. More...
 
boolean isLibraryLoaded ([in] string Name) raises ( com::sun::star::container::NoSuchElementException )
 returns true if the accessed library is already loaded from the storage, otherwise false. More...
 
void loadLibrary ([in] string Name) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 Causes the accessed library to be loaded from its storage if it hasn't already been loaded. More...
 
- Public Member Functions inherited from XNameAccess
any getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
sequence< string > getElementNames ()
 
boolean hasByName ([in] string aName)
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

Extension of XLibraryContainer to provide additional information about the libraries contained in a library container.

Member Function Documentation

returns the location of the library link target.

Should return the same URL that was passed to createLibraryLink in the StorageURL parameter.

If the accessed library item exists but isn't a link, a IllegalArgumentException is thrown

boolean isLibraryLink ( [in] string  Name)
raises (com::sun::star::container::NoSuchElementException
)

returns true if the accessed library item is a link, e.g., created by createLibraryLink, otherwise false.

boolean isLibraryReadOnly ( [in] string  Name)
raises (com::sun::star::container::NoSuchElementException
)

returns true if the accessed library item (library or library link) is read only.

A library can be read only because it was set to read only using the methods provided by this interface or because of other reasons depending on the implementation (e.g., file system write protection)

void renameLibrary ( [in] string  Name,
[in] string  NewName 
)
raises ( com::sun::star::container::NoSuchElementException,
com::sun::star::container::ElementExistException
)

renames the library item with the specified name.

If the accessed library item is a link only the link is renamed, not the target library. If a library with the new name exists already a com::sun::star::container::ElementExistException is thrown.

void setLibraryReadOnly ( [in] string  Name,
[in] boolean  bReadOnly 
)
raises (com::sun::star::container::NoSuchElementException
)

Sets the accessed library item (library or library link) to read only according to the flag bReadOnly (true means read only)


The documentation for this interface was generated from the following file: