/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XTemplateContainer.idl,v $
 *
 *  $Revision: 1.14 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 22:27:25 $
 *
 *  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_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
