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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTemplateContainer.idl,v $
  10  * $Revision: 1.15 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_configuration_XTemplateContainer_idl__
  31 #define __com_sun_star_configuration_XTemplateContainer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module configuration {
  40
  41 //=============================================================================
  42
  43 /** is implemented by objects that contain instances of a named template to
  44     provide information about the template.
  45
  46     <p> An implementation will also implement
  47         <type scope="com::sun::star::lang">XSingleServiceFactory</type>, in which case
  48         that interface creates instances of the specified template.
  49     </p>
  50     <p> If multiple templates are supported, the supported factory interface may be
  51         <type scope="com::sun::star::lang">XMultiServiceFactory</type>, in which case
  52         the <atom>string</atom> returned from
  53         <member>XTemplateContainer::getElementTemplateName()</member> can be used as
  54         the service name argument.
  55     </p>
  56
  57     @see XTemplateInstance
  58  */
  59 published interface XTemplateContainer: com::sun::star::uno::XInterface
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /** retrieves the name of the template
  64
  65         <p>     If instances of multiple templates are accepted by the container,
  66             this is the name of the basic or primary template.
  67         </p>
  68         <p>     Instances of the template must be created
  69             using an appropriate factory.
  70         </p>
  71
  72         @returns
  73                 the name of the (default) template for elements.
  74      */
  75     string getElementTemplateName();
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif