1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_XTemplateContainer_idl__
24#define __com_sun_star_configuration_XTemplateContainer_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30//=============================================================================
31
32 module com {  module sun {  module star {  module configuration {
33
34//=============================================================================
35
36/** is implemented by objects that contain instances of a named template to
37	provide information about the template.
38
39	<p> An implementation will also implement
40		<type scope="com::sun::star::lang">XSingleServiceFactory</type>, in which case
41		that interface creates instances of the specified template.
42	</p>
43	<p> If multiple templates are supported, the supported factory interface may be
44		<type scope="com::sun::star::lang">XMultiServiceFactory</type>, in which case
45		the <atom>string</atom> returned from
46		<member>XTemplateContainer::getElementTemplateName()</member> can be used as
47		the service name argument.
48	</p>
49
50	@see XTemplateInstance
51 */
52published interface XTemplateContainer: com::sun::star::uno::XInterface
53{
54	//-------------------------------------------------------------------------
55
56	/** retrieves the name of the template
57
58		<p>	If instances of multiple templates are accepted by the container,
59			this is the name of the basic or primary template.
60		</p>
61		<p>	Instances of the template must be created
62			using an appropriate factory.
63		</p>
64
65		@returns
66				the name of the (default) template for elements.
67	 */
68	string getElementTemplateName();
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77