office-gobmx/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl
Rüdiger Timm 4ae90efcec INTEGRATION: CWS ooo19126 (1.5.42); FILE MERGED
2005/09/05 14:07:41 rt 1.5.42.1: #i54170# Change license header: remove SISSL
2005-09-09 15:21:44 +00:00

114 lines
4.2 KiB
Text

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XStarBasicLibraryInfo.idl,v $
*
* $Revision: 1.6 $
*
* last change: $Author: rt $ $Date: 2005-09-09 16:21:44 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef __com_sun_star_script_XStarBasicLibraryInfo_idl__
#define __com_sun_star_script_XStarBasicLibraryInfo_idl__
#ifndef __com_sun_star_container_XNameContainer_idl__
#include <com/sun/star/container/XNameContainer.idl>
#endif
//=============================================================================
module com { module sun { module star { module script {
//=============================================================================
/** Interface representing a library and provides access to its modules
@deprecated
*/
published interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** returns the library's name
*/
string getName();
//-------------------------------------------------------------------------
/** 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 getExternalSourceURL
@see getLinkTargetURL
*/
com::sun::star::container::XNameContainer getModuleContainer();
//-------------------------------------------------------------------------
/** 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 getExternalSourceURL
@see getLinkTargetURL
*/
com::sun::star::container::XNameContainer getDialogContainer();
//-------------------------------------------------------------------------
/** returns
the password, if the library is protected with one,
an empty string otherwise.
*/
string getPassword();
//-------------------------------------------------------------------------
/** 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.
*/
string getExternalSourceURL();
//-------------------------------------------------------------------------
/** returns an
URL describing the location of the library linked to.
<p>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().</p>
*/
string getLinkTargetURL();
};
//=============================================================================
}; }; }; };
#endif