xref: /aoo41x/main/offapi/com/sun/star/configuration/XTemplateInstance.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_XTemplateInstance_idl__
#define __com_sun_star_configuration_XTemplateInstance_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 are instances of a named template to provide
	information about the template.

	<p>	Template names are similar to service names, but apply to structure and
		content, rather than to type.
	</p>
	<p>	Often a template description can be retrieved from a repository and then be
		interpreted by a factory object. Templates provide a means to build
		new kinds of objects dynamically.
	</p>

	@see XTemplateContainer
 */
published interface XTemplateInstance: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** retrieves the name of the template

		@returns
			the name of the template this object was built from or conforms to.
	 */
	string getTemplateName();

};

//=============================================================================

}; }; }; };

#endif