Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: script ::

deprecated interface XStarBasicLibraryInfo
Usage Restrictions
deprecated
Description
Interface representing a library and provides access to its modules

Methods' Summary
getName returns the library's name  
getModuleContainer returns the module container giving access to the modules stored in the library. The container has to be returned in any case, no matter if the library is stored embedded, external, or linked.  
getDialogContainer returns the dialog container giving access to the dialogs stored in the library. The container has to be returned in any case, no matter if the library is stored embedded, external, or linked.  
getPassword returns the password, if the library is protected with one, an empty string otherwise.  
getExternalSourceURL returns an URL describing the location where the library is stored if the library is stored seperately (for example not in the main XML file but in a special library format file), an empty string otherwise. This information can be useful to optimize the access to the library, e.g., for loading on demand.  
getLinkTargetURL returns an URL describing the location of the library linked to.  
Methods' Details
getName
string
getName();

Description
returns the library's name
getModuleContainer
::com::sun::star::container::XNameContainer
getModuleContainer();

Description
returns the module container giving access to the modules stored in the library. The container has to be returned in any case, no matter if the library is stored embedded, external, or linked.
See also
getExternalSourceURL, getLinkTargetURL
getDialogContainer
::com::sun::star::container::XNameContainer
getDialogContainer();

Description
returns the dialog container giving access to the dialogs stored in the library. The container has to be returned in any case, no matter if the library is stored embedded, external, or linked.
See also
getExternalSourceURL, getLinkTargetURL
getPassword
string
getPassword();

Description
returns the password, if the library is protected with one, an empty string otherwise.
getExternalSourceURL
string
getExternalSourceURL();

Description
returns an URL describing the location where the library is stored if the library is stored seperately (for example not in the main XML file but in a special library format file), an empty string otherwise. This information can be useful to optimize the access to the library, e.g., for loading on demand.
getLinkTargetURL
string
getLinkTargetURL();

Description
returns an URL describing the location of the library linked to.

HINT: This method can be removed when there is a generic interface for linking. Then the implementation will simply support this "XLinked" interface and it can be checked by queryInterface().

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.