xref: /trunk/main/offapi/com/sun/star/configuration/XTemplateInstance.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_configuration_XTemplateInstance_idl__
28#define __com_sun_star_configuration_XTemplateInstance_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module configuration {
37
38//=============================================================================
39
40/** is implemented by objects that are instances of a named template to provide
41    information about the template.
42
43    <p> Template names are similar to service names, but apply to structure and
44        content, rather than to type.
45    </p>
46    <p> Often a template description can be retrieved from a repository and then be
47        interpreted by a factory object. Templates provide a means to build
48        new kinds of objects dynamically.
49    </p>
50
51    @see XTemplateContainer
52 */
53published interface XTemplateInstance: com::sun::star::uno::XInterface
54{
55    //-------------------------------------------------------------------------
56
57    /** retrieves the name of the template
58
59        @returns
60            the name of the template this object was built from or conforms to.
61     */
62    string getTemplateName();
63
64};
65
66//=============================================================================
67
68}; }; }; };
69
70#endif
71