offapi/com/sun/star/configuration/XTemplateContainer.idl

   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_XTemplateContainer_idl__
  28 #define __com_sun_star_configuration_XTemplateContainer_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 contain instances of a named template to
  41     provide information about the template.
  42
  43     <p> An implementation will also implement
  44         <type scope="com::sun::star::lang">XSingleServiceFactory</type>, in which case
  45         that interface creates instances of the specified template.
  46     </p>
  47     <p> If multiple templates are supported, the supported factory interface may be
  48         <type scope="com::sun::star::lang">XMultiServiceFactory</type>, in which case
  49         the <atom>string</atom> returned from
  50         <member>XTemplateContainer::getElementTemplateName()</member> can be used as
  51         the service name argument.
  52     </p>
  53
  54     @see XTemplateInstance
  55  */
  56 published interface XTemplateContainer: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** retrieves the name of the template
  61
  62         <p> If instances of multiple templates are accepted by the container,
  63             this is the name of the basic or primary template.
  64         </p>
  65         <p> Instances of the template must be created
  66             using an appropriate factory.
  67         </p>
  68
  69         @returns
  70                 the name of the (default) template for elements.
  71      */
  72     string getElementTemplateName();
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif