LibreOffice: XStarBasicLibraryInfo Interface Reference

LibreOffice LibreOffice 7.6 SDK API Reference

Loading...
Searching...
No Matches
Public Member Functions | List of all members
XStarBasicLibraryInfo Interface Referencepublished

Interface representing a library and provides access to its modules. More...

`import <XStarBasicLibraryInfo.idl;`

Inheritance diagram for XStarBasicLibraryInfo:

## Public Member Functions
string | getName ()
| returns the library's name
com::sun::star::container::XNameContainer | getModuleContainer ()
| returns the module container giving access to the modules stored in the library.
com::sun::star::container::XNameContainer | getDialogContainer ()
| returns the dialog container giving access to the dialogs stored in the library.
string | getPassword ()
| returns the password, if the library is protected with one, an empty string otherwise.
string | getExternalSourceURL ()
| returns an URL describing the location where the library is stored if the library is stored separately (for example not in the main XML file but in a special library format file), an empty string otherwise.
string | getLinkTargetURL ()
| returns an URL describing the location of the library linked to.
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object.
void | acquire ()
| increases the reference counter by one.
void | release ()
| decreases the reference counter by one.

## Detailed Description

Interface representing a library and provides access to its modules.

Deprecated

## Member Function Documentation

## ◆ getDialogContainer()

com::sun::star::container::XNameContainer 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.

See also
  getExternalSourceURL
  getLinkTargetURL

## ◆ getExternalSourceURL()

string getExternalSourceURL | ( |  | ) |

returns an URL describing the location where the library is stored if the library is stored separately (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 | ( |  | ) |

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().

## ◆ getModuleContainer()

com::sun::star::container::XNameContainer 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.

See also
  getExternalSourceURL
  getLinkTargetURL

## ◆ getName()

string getName | ( |  | ) |

returns the library's name

## ◆ getPassword()

string getPassword | ( |  | ) |

returns the password, if the library is protected with one, an empty string otherwise.

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

- com/sun/star/script/XStarBasicLibraryInfo.idl