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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module configuration {
  22
  23
  24 /** is implemented by objects that contain instances of a named template to
  25     provide information about the template.
  26
  27     <p> An implementation will also implement
  28         com::sun::star::lang::XSingleServiceFactory, in which case
  29         that interface creates instances of the specified template.
  30     </p>
  31     <p> If multiple templates are supported, the supported factory interface may be
  32         com::sun::star::lang::XMultiServiceFactory, in which case
  33         the `string` returned from
  34         XTemplateContainer::getElementTemplateName() can be used as
  35         the service name argument.
  36     </p>
  37
  38     @see XTemplateInstance
  39  */
  40 published interface XTemplateContainer: com::sun::star::uno::XInterface
  41 {
  42
  43     /** retrieves the name of the template
  44
  45         <p> If instances of multiple templates are accepted by the container,
  46             this is the name of the basic or primary template.
  47         </p>
  48         <p> Instances of the template must be created
  49             using an appropriate factory.
  50         </p>
  51
  52         @returns
  53                 the name of the (default) template for elements.
  54      */
  55     string getElementTemplateName();
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */