office-gobmx/offapi/com/sun/star/configuration/XTemplateContainer.idl
Rüdiger Timm 3176e0cb21 INTEGRATION: CWS changefileheader (1.14.500); FILE MERGED
2008/03/31 15:58:59 rt 1.14.500.1: #i87441# Change license header to LPGL v3.
2008-04-10 19:03:21 +00:00

83 lines
3 KiB
Text

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XTemplateContainer.idl,v $
* $Revision: 1.15 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_configuration_XTemplateContainer_idl__
#define __com_sun_star_configuration_XTemplateContainer_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
//=============================================================================
module com { module sun { module star { module configuration {
//=============================================================================
/** is implemented by objects that contain instances of a named template to
provide information about the template.
<p> An implementation will also implement
<type scope="com::sun::star::lang">XSingleServiceFactory</type>, in which case
that interface creates instances of the specified template.
</p>
<p> If multiple templates are supported, the supported factory interface may be
<type scope="com::sun::star::lang">XMultiServiceFactory</type>, in which case
the <atom>string</atom> returned from
<member>XTemplateContainer::getElementTemplateName()</member> can be used as
the service name argument.
</p>
@see XTemplateInstance
*/
published interface XTemplateContainer: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** retrieves the name of the template
<p> If instances of multiple templates are accepted by the container,
this is the name of the basic or primary template.
</p>
<p> Instances of the template must be created
using an appropriate factory.
</p>
@returns
the name of the (default) template for elements.
*/
string getElementTemplateName();
};
//=============================================================================
}; }; }; };
#endif